Package software.amazon.awscdk.services.cloudfront

Class CfnOriginAccessControl

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:33:58.632Z")
@Stability(Stable)
public class CfnOriginAccessControl
extends CfnResource
implements IInspectable

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.

This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.

For more information about using a CloudFront origin access control, see Restricting access to an AWS 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.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	CfnOriginAccessControl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnOriginAccessControl(software.amazon.jsii.JsiiObjectRef objRef)
	CfnOriginAccessControl(software.constructs.Construct scope, String id, CfnOriginAccessControlProps props)

Method Summary

Modifier and Type	Method	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(IResolvable value)	The origin access control.
void	setOriginAccessControlConfig(CfnOriginAccessControl.OriginAccessControlConfigProperty value)	The origin access control.

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

CfnOriginAccessControl

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

CfnOriginAccessControl

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

CfnOriginAccessControl

@Stability(Stable)
public CfnOriginAccessControl(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnOriginAccessControlProps 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 unique identifier of the origin access control.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getOriginAccessControlConfig

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

The origin access control.

setOriginAccessControlConfig

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

The origin access control.

setOriginAccessControlConfig

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

The origin access control.