software.amazon.awscdk.services.cloudfront

Class CfnCloudFrontOriginAccessIdentity

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cloudfront.CfnCloudFrontOriginAccessIdentity

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:25.611Z")
public class CfnCloudFrontOriginAccessIdentity
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFront::CloudFrontOriginAccessIdentity`.

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();
 

Nested Class Summary

Nested Classes

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

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCloudFrontOriginAccessIdentity(Construct scope, java.lang.String id, CfnCloudFrontOriginAccessIdentityProps props) Create a new `AWS::CloudFront::CloudFrontOriginAccessIdentity`.
protected	CfnCloudFrontOriginAccessIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCloudFrontOriginAccessIdentity(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCloudFrontOriginAccessIdentity

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

CfnCloudFrontOriginAccessIdentity

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

CfnCloudFrontOriginAccessIdentity

public CfnCloudFrontOriginAccessIdentity(Construct scope,
                                         java.lang.String id,
                                         CfnCloudFrontOriginAccessIdentityProps props)

Create a new `AWS::CloudFront::CloudFrontOriginAccessIdentity`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

The ID for the origin access identity, for example, `E74FTE3AJFJ256A` .

getAttrS3CanonicalUserId

public java.lang.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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCloudFrontOriginAccessIdentityConfig

public java.lang.Object getCloudFrontOriginAccessIdentityConfig()

The current configuration information for the identity.

setCloudFrontOriginAccessIdentityConfig

public void setCloudFrontOriginAccessIdentityConfig(IResolvable value)

The current configuration information for the identity.

setCloudFrontOriginAccessIdentityConfig

public void setCloudFrontOriginAccessIdentityConfig(CfnCloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfigProperty value)

The current configuration information for the identity.