software.amazon.awscdk.services.cloudfront

Class CfnOriginAccessControl

java.lang.Object

software.amazon.jsii.JsiiObject

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.CfnOriginAccessControl

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.238Z")
 @Stability(value=Stable)
public class CfnOriginAccessControl
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFront::OriginAccessControl`.

Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.

For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket so that viewers (users) can access the content in the bucket only through CloudFront.

For more information about using a CloudFront origin access control, see Restricting access to an Amazon S3 origin 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.*;
 CfnOriginAccessControl cfnOriginAccessControl = CfnOriginAccessControl.Builder.create(this, "MyCfnOriginAccessControl")
         .originAccessControlConfig(OriginAccessControlConfigProperty.builder()
                 .name("name")
                 .originAccessControlOriginType("originAccessControlOriginType")
                 .signingBehavior("signingBehavior")
                 .signingProtocol("signingProtocol")
                 // the properties below are optional
                 .description("description")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnOriginAccessControl.Builder A fluent builder for CfnOriginAccessControl.
static interface	CfnOriginAccessControl.OriginAccessControlConfigProperty Creates a new origin access control in CloudFront.

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

software.amazon.jsii.JsiiObject.InitializationMode

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 String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnOriginAccessControl(Construct scope, String id, CfnOriginAccessControlProps props) Create a new `AWS::CloudFront::OriginAccessControl`.
protected	CfnOriginAccessControl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnOriginAccessControl(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId() The unique identifier of the origin access control.
protected Map<String,Object>	getCfnProperties()
Object	getOriginAccessControlConfig() The origin access control.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setOriginAccessControlConfig(CfnOriginAccessControl.OriginAccessControlConfigProperty value) The origin access control.
void	setOriginAccessControlConfig(IResolvable value) The origin access control.

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 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnOriginAccessControl

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

CfnOriginAccessControl

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

CfnOriginAccessControl

@Stability(value=Stable)
public CfnOriginAccessControl(@NotNull
                                                       Construct scope,
                                                       @NotNull
                                                       String id,
                                                       @NotNull
                                                       CfnOriginAccessControlProps props)

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

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

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()

The unique identifier of the origin access control.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getOriginAccessControlConfig

@Stability(value=Stable)
 @NotNull
public Object getOriginAccessControlConfig()

The origin access control.

setOriginAccessControlConfig

@Stability(value=Stable)
public void setOriginAccessControlConfig(@NotNull
                                                                  IResolvable value)

The origin access control.

setOriginAccessControlConfig

@Stability(value=Stable)
public void setOriginAccessControlConfig(@NotNull
                                                                  CfnOriginAccessControl.OriginAccessControlConfigProperty value)

The origin access control.