class S3OriginAccessControl (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CloudFront.S3OriginAccessControl
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#S3OriginAccessControl
Java	software.amazon.awscdk.services.cloudfront.S3OriginAccessControl
Python	aws_cdk.aws_cloudfront.S3OriginAccessControl
TypeScript (source)	aws-cdk-lib » aws_cloudfront » S3OriginAccessControl

Implements IConstruct, IDependable, IResource, IOriginAccessControl

An Origin Access Control for Amazon S3 origins.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html

Example

const myBucket = new s3.Bucket(this, 'myBucket');
const oac = new cloudfront.S3OriginAccessControl(this, 'MyOAC', {
  signing: cloudfront.Signing.SIGV4_NO_OVERRIDE
});
const s3Origin = origins.S3BucketOrigin.withOriginAccessControl(myBucket, {
    originAccessControl: oac
  }
)
new cloudfront.Distribution(this, 'myDist', {
  defaultBehavior: {
    origin: s3Origin
  },
});

Initializer

new S3OriginAccessControl(scope: Construct, id: string, props?: S3OriginAccessControlProps)

Parameters

• scope Construct
• id string
• props S3OriginAccessControlProps

Construct Props

Name	Type	Description
description?	string	A description of the origin access control.
originAccessControlName?	string	A name to identify the origin access control, with a maximum length of 64 characters.
signing?	Signing	Specifies which requests CloudFront signs and the signing protocol.

---

description?

Type: string (optional, default: no description)

A description of the origin access control.

---

originAccessControlName?

Type: string (optional, default: a generated name)

A name to identify the origin access control, with a maximum length of 64 characters.

---

signing?

Type: Signing (optional, default: SIGV4_ALWAYS)

Specifies which requests CloudFront signs and the signing protocol.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingbehavior

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
originAccessControlId	string	The unique identifier of this Origin Access Control.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

originAccessControlId

Type: string

The unique identifier of this Origin Access Control.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromOriginAccessControlId(scope, id, originAccessControlId)	Imports an S3 origin access control from its id.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromOriginAccessControlId(scope, id, originAccessControlId)

public static fromOriginAccessControlId(scope: Construct, id: string, originAccessControlId: string): IOriginAccessControl

Parameters

• scope Construct
• id string
• originAccessControlId string

Returns

• IOriginAccessControl

Imports an S3 origin access control from its id.