Class OriginAccessIdentity

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.cloudfront.OriginAccessIdentity
All Implemented Interfaces:
IResource, IOriginAccessIdentity, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-02-14T19:10:13.758Z") @Stability(Stable) public class OriginAccessIdentity extends Resource implements IOriginAccessIdentity
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.

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.*;
 OriginAccessIdentity originAccessIdentity = OriginAccessIdentity.Builder.create(this, "MyOriginAccessIdentity")
         .comment("comment")
         .build();
 
  • Constructor Details

    • OriginAccessIdentity

      protected OriginAccessIdentity(software.amazon.jsii.JsiiObjectRef objRef)
    • OriginAccessIdentity

      protected OriginAccessIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • OriginAccessIdentity

      @Stability(Stable) public OriginAccessIdentity(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable OriginAccessIdentityProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -
    • OriginAccessIdentity

      @Stability(Stable) public OriginAccessIdentity(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
  • Method Details

    • fromOriginAccessIdentityId

      @Stability(Stable) @NotNull public static IOriginAccessIdentity fromOriginAccessIdentityId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String originAccessIdentityId)
      Creates a OriginAccessIdentity by providing the OriginAccessIdentityId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      originAccessIdentityId - This parameter is required.
    • fromOriginAccessIdentityName

      @Stability(Deprecated) @Deprecated @NotNull public static IOriginAccessIdentity fromOriginAccessIdentityName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String originAccessIdentityName)
      Deprecated.
      use fromOriginAccessIdentityId
      (deprecated) Creates a OriginAccessIdentity by providing the OriginAccessIdentityId.

      It is misnamed and superseded by the correctly named fromOriginAccessIdentityId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      originAccessIdentityName - This parameter is required.
    • arn

      @Stability(Stable) @NotNull protected String arn()
      The ARN to include in S3 bucket policy to allow CloudFront access.
    • getCloudFrontOriginAccessIdentityS3CanonicalUserId

      @Stability(Stable) @NotNull public String getCloudFrontOriginAccessIdentityS3CanonicalUserId()
      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.
    • getGrantPrincipal

      @Stability(Stable) @NotNull public IPrincipal getGrantPrincipal()
      Derived principal value for bucket access.
      Specified by:
      getGrantPrincipal in interface IGrantable
    • getOriginAccessIdentityId

      @Stability(Stable) @NotNull public String getOriginAccessIdentityId()
      The Origin Access Identity Id (physical id) This was called originAccessIdentityName before.
      Specified by:
      getOriginAccessIdentityId in interface IOriginAccessIdentity
    • getOriginAccessIdentityName

      @Stability(Deprecated) @Deprecated @NotNull public String getOriginAccessIdentityName()
      Deprecated.
      use originAccessIdentityId instead
      (deprecated) The Origin Access Identity Id (physical id) It is misnamed and superseded by the correctly named originAccessIdentityId.

      Specified by:
      getOriginAccessIdentityName in interface IOriginAccessIdentity