software.amazon.awscdk.services.cloudfront

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.30.0 (build adae23f)",
           date="2021-06-30T10:00:50.296Z")
 @Stability(value=Experimental)
public class OriginAccessIdentity
extends Resource
implements IOriginAccessIdentity

(experimental) 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OriginAccessIdentity.Builder (experimental) A fluent builder for OriginAccessIdentity.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudfront.IOriginAccessIdentity

IOriginAccessIdentity.Jsii$Default, IOriginAccessIdentity.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	OriginAccessIdentity(software.constructs.Construct scope, String id)
	OriginAccessIdentity(software.constructs.Construct scope, String id, OriginAccessIdentityProps props)
protected	OriginAccessIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	OriginAccessIdentity(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected String	arn() (experimental) The ARN to include in S3 bucket policy to allow CloudFront access.
static IOriginAccessIdentity	fromOriginAccessIdentityName(software.constructs.Construct scope, String id, String originAccessIdentityName) (experimental) Creates a OriginAccessIdentity by providing the OriginAccessIdentityName.
String	getCloudFrontOriginAccessIdentityS3CanonicalUserId() (experimental) 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.
IPrincipal	getGrantPrincipal() (experimental) Derived principal value for bucket access.
String	getOriginAccessIdentityName() (experimental) The Origin Access Identity Name (physical id).

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

OriginAccessIdentity

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

OriginAccessIdentity

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

OriginAccessIdentity

@Stability(value=Experimental)
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(value=Experimental)
public OriginAccessIdentity(@NotNull
                                                           software.constructs.Construct scope,
                                                           @NotNull
                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromOriginAccessIdentityName

@Stability(value=Experimental)
 @NotNull
public static IOriginAccessIdentity fromOriginAccessIdentityName(@NotNull
                                                                                                          software.constructs.Construct scope,
                                                                                                          @NotNull
                                                                                                          String id,
                                                                                                          @NotNull
                                                                                                          String originAccessIdentityName)

(experimental) Creates a OriginAccessIdentity by providing the OriginAccessIdentityName.

Parameters:

scope - This parameter is required.

id - This parameter is required.

originAccessIdentityName - This parameter is required.

arn

@Stability(value=Experimental)
 @NotNull
protected String arn()

(experimental) The ARN to include in S3 bucket policy to allow CloudFront access.

getCloudFrontOriginAccessIdentityS3CanonicalUserId

@Stability(value=Experimental)
 @NotNull
public String getCloudFrontOriginAccessIdentityS3CanonicalUserId()

(experimental) 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(value=Experimental)
 @NotNull
public IPrincipal getGrantPrincipal()

(experimental) Derived principal value for bucket access.

Specified by:

getGrantPrincipal in interface IGrantable

getOriginAccessIdentityName

@Stability(value=Experimental)
 @NotNull
public String getOriginAccessIdentityName()

(experimental) The Origin Access Identity Name (physical id).

Specified by:

getOriginAccessIdentityName in interface IOriginAccessIdentity