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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:05.436Z")
@Stability(Stable)
public class CfnCloudFrontOriginAccessIdentity
extends CfnResource
implements IInspectable

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnCloudFrontOriginAccessIdentity.Builder	A fluent builder for CfnCloudFrontOriginAccessIdentity.
static interface	CfnCloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfigProperty	Origin access identity configuration.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAttrId()	The ID for the origin access identity, for example, E74FTE3AJFJ256A .
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.
protected Map<String,Object>	getCfnProperties()
Object	getCloudFrontOriginAccessIdentityConfig()	The current configuration information for the identity.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCloudFrontOriginAccessIdentityConfig(IResolvable value)	The current configuration information for the identity.
void	setCloudFrontOriginAccessIdentityConfig(CfnCloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfigProperty value)	The current configuration information for the identity.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

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)

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

getCloudFrontOriginAccessIdentityConfig

@Stability(Stable)
@NotNull
public Object getCloudFrontOriginAccessIdentityConfig()

The current configuration information for the identity.

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.