Class: Aws::CloudFront::Types::S3OriginConfig

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass S3OriginConfig data as a hash:

{
  origin_access_identity: "string", # required
}

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ‘CustomOriginConfig` element instead.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#origin_access_identity ⇒ String

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ‘ ID-of-origin-access-identity ` is the value that CloudFront returned in the `ID` element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ‘OriginAccessIdentity` element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ‘OriginAccessIdentity` element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see [Serving Private Content through CloudFront] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html

Returns:

  • (String) 


10977
10978
10979
10980
10981
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 10977

class S3OriginConfig < Struct.new(
  :origin_access_identity)
  SENSITIVE = []
  include Aws::Structure
end