Skip to content

CloudFront  >  Operations  >  create_cloud_front_origin_access_identity

create_cloud_front_origin_access_identity

Operation

create_cloud_front_origin_access_identity async 

create_cloud_front_origin_access_identity(input: CreateCloudFrontOriginAccessIdentityInput, plugins: list[Plugin] | None = None) -> CreateCloudFrontOriginAccessIdentityOutput

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Parameters:

Name Type Description Default
input CreateCloudFrontOriginAccessIdentityInput

An instance of CreateCloudFrontOriginAccessIdentityInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateCloudFrontOriginAccessIdentityOutput

An instance of CreateCloudFrontOriginAccessIdentityOutput.

Input

CreateCloudFrontOriginAccessIdentityInput dataclass

Bases: _SerdeShape

The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.

Attributes

cloud_front_origin_access_identity_config class-attribute instance-attribute 
cloud_front_origin_access_identity_config: CloudFrontOriginAccessIdentityConfig | None = ...

The current configuration information for the identity.

Output

CreateCloudFrontOriginAccessIdentityOutput dataclass

Bases: _SerdeShape

The returned result of the corresponding request.

Attributes

cloud_front_origin_access_identity class-attribute instance-attribute 
cloud_front_origin_access_identity: CloudFrontOriginAccessIdentity | None = ...

The origin access identity's information.

e_tag class-attribute instance-attribute 
e_tag: str | None = ...

The current version of the origin access identity created.

location class-attribute instance-attribute 
location: str | None = ...

The fully qualified URI of the new origin access identity just created.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.