Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.585Z") @Stability(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.

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

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