aws-cdk-lib.aws_cloudfront_origins.S3OriginProps

interface S3OriginProps

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.Origins.S3OriginProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfrontorigins#S3OriginProps
Javasoftware.amazon.awscdk.services.cloudfront.origins.S3OriginProps
Pythonaws_cdk.aws_cloudfront_origins.S3OriginProps
TypeScript (source)aws-cdk-lib » aws_cloudfront_origins » S3OriginProps

Properties to use to customize an S3 Origin.

Example

const myBucket = new s3.Bucket(this, 'myBucket');
new cloudfront.Distribution(this, 'myDist', {
  defaultBehavior: { origin: new origins.S3Origin(myBucket, {
    customHeaders: {
      Foo: 'bar',
    },
  })},
});

Properties

NameTypeDescription
connectionAttempts?numberThe number of times that CloudFront attempts to connect to the origin;
connectionTimeout?DurationThe number of seconds that CloudFront waits when trying to establish a connection to the origin.
customHeaders?{ [string]: string }A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
originAccessIdentity?IOriginAccessIdentityAn optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.
originId?stringA unique identifier for the origin.
originPath?stringAn optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
originShieldEnabled?booleanOrigin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.
originShieldRegion?stringWhen you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

connectionAttempts?

Type: number (optional, default: 3)

The number of times that CloudFront attempts to connect to the origin;

valid values are 1, 2, or 3 attempts.


connectionTimeout?

Type: Duration (optional, default: Duration.seconds(10))

The number of seconds that CloudFront waits when trying to establish a connection to the origin.

Valid values are 1-10 seconds, inclusive.


customHeaders?

Type: { [string]: string } (optional, default: {})

A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.


originAccessIdentity?

Type: IOriginAccessIdentity (optional, default: An Origin Access Identity will be created.)

An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.


originId?

Type: string (optional, default: an originid will be generated for you)

A unique identifier for the origin.

This value must be unique within the distribution.


originPath?

Type: string (optional, default: '/')

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

Must begin, but not end, with '/' (e.g., '/production/images').


originShieldEnabled?

Type: boolean (optional, default: true)

Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.


originShieldRegion?

Type: string (optional, default: origin shield not enabled)

When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

See also: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html