Interface CfnDistribution.S3OriginConfigProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDistribution.S3OriginConfigProperty extends
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.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 S3OriginConfigProperty s3OriginConfigProperty = S3OriginConfigProperty.builder()
  • Method Details

    • getOriginAccessIdentity

      @Stability(Stable) @Nullable default String getOriginAccessIdentity()
      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 .

    • builder

      @Stability(Stable) static CfnDistribution.S3OriginConfigProperty.Builder builder()
      a CfnDistribution.S3OriginConfigProperty.Builder of CfnDistribution.S3OriginConfigProperty