Package software.amazon.awscdk.services.cloudfront

Class CfnCloudFrontOriginAccessIdentity

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cloudfront.CfnCloudFrontOriginAccessIdentity
All Implemented Interfaces:
IInspectable, ICloudFrontOriginAccessIdentityRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-17T14:40:46.936Z") @Stability(Stable) public class CfnCloudFrontOriginAccessIdentity extends CfnResource implements IInspectable, ICloudFrontOriginAccessIdentityRef
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 CfnCloudFrontOriginAccessIdentity cfnCloudFrontOriginAccessIdentity = CfnCloudFrontOriginAccessIdentity.Builder.create(this, "MyCfnCloudFrontOriginAccessIdentity")
         .cloudFrontOriginAccessIdentityConfig(CloudFrontOriginAccessIdentityConfigProperty.builder()
                 .comment("comment")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCloudFrontOriginAccessIdentity

      protected CfnCloudFrontOriginAccessIdentity(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCloudFrontOriginAccessIdentity

      protected CfnCloudFrontOriginAccessIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCloudFrontOriginAccessIdentity

      @Stability(Stable) public CfnCloudFrontOriginAccessIdentity(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCloudFrontOriginAccessIdentityProps props)
      Create a new AWS::CloudFront::CloudFrontOriginAccessIdentity.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID for the origin access identity, for example, E74FTE3AJFJ256A .

    • getAttrS3CanonicalUserId

      @Stability(Stable) @NotNull public String getAttrS3CanonicalUserId()
      The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

      For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCloudFrontOriginAccessIdentityRef

      @Stability(Stable) @NotNull public CloudFrontOriginAccessIdentityReference getCloudFrontOriginAccessIdentityRef()
      A reference to a CloudFrontOriginAccessIdentity resource.
      Specified by:
      getCloudFrontOriginAccessIdentityRef in interface ICloudFrontOriginAccessIdentityRef

    • getCloudFrontOriginAccessIdentityConfig

      @Stability(Stable) @NotNull public Object getCloudFrontOriginAccessIdentityConfig()
      The current configuration information for the identity.

      Returns union: either IResolvable or CfnCloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfigProperty

    • setCloudFrontOriginAccessIdentityConfig

      @Stability(Stable) public void setCloudFrontOriginAccessIdentityConfig(@NotNull IResolvable value)
      The current configuration information for the identity.

    • setCloudFrontOriginAccessIdentityConfig

      @Stability(Stable) public void setCloudFrontOriginAccessIdentityConfig(@NotNull CfnCloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfigProperty value)
      The current configuration information for the identity.