Menu
Amazon CloudFront
API Reference (API Version 2016-09-07)

CloudFrontOriginAccessIdentity Complex Type

Description

The CloudFrontOriginAccessIdentity complex type describes the information about a CloudFront 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, go to Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

This complex type is used as a response element in POST Origin Access Identity and in GET Origin Access Identity.

Syntax

<CloudFrontOriginAccessIdentity xmlns="http://cloudfront.amazonaws.com/doc/2016-09-07/">
   <Id>id</Id>
   <S3CanonicalUserId>canonical user id</CanonicalUserId>
   <CloudFrontOriginAccessIdentityConfig>
      <CallerReference>ref</CallerReference>
      <Comment>The comment.</Comment>
   </CloudFrontOriginAccessIdentityConfig>
</CloudFrontOriginAccessIdentity>

Elements

The following tables describes the child elements in the CloudFrontOriginAccessIdentity datatype. They're presented in the order they appear in the origin access identity, and not in alphabetical order.

NameDescriptionRequired

Id

The ID for the origin access identity. For example, E74FTE3AEXAMPLE.

Type: String

Default: None

Yes

S3CanonicalUserId

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

Type: String

Default: None

Yes

CloudFrontOriginAccessIdentityConfig

The current configuration information for the identity.

Type: CloudFrontOriginAccessIdentityConfig Complex Type

Default: None

Yes

Example

<CloudFrontOriginAccessIdentity xmlns="http://cloudfront.amazonaws.com/doc/2016-09-07/">
   <Id>E74FTE3AEXAMPLE</Id>
   <S3CanonicalUserId>
      cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE
   </S3CanonicalUserId>
   <CloudFrontOriginAccessIdentityConfig>   
      <CallerReference>20120229090000</CallerReference>
      <Comment>My comments</Comment>
   </CloudFrontOriginAccessIdentityConfig>
</CloudFrontOriginAccessIdentity>