S3OriginProps
- class aws_cdk.aws_cloudfront_origins.S3OriginProps(*, connection_attempts=None, connection_timeout=None, custom_headers=None, origin_access_control_id=None, origin_id=None, origin_shield_enabled=None, origin_shield_region=None, origin_path=None, origin_access_identity=None)
Bases:
OriginProps
Properties to use to customize an S3 Origin.
- Parameters:
connection_attempts (
Union
[int
,float
,None
]) – The number of times that CloudFront attempts to connect to the origin; valid values are 1, 2, or 3 attempts. Default: 3connection_timeout (
Optional
[Duration
]) – The number of seconds that CloudFront waits when trying to establish a connection to the origin. Valid values are 1-10 seconds, inclusive. Default: Duration.seconds(10)custom_headers (
Optional
[Mapping
[str
,str
]]) – A list of HTTP header names and values that CloudFront adds to requests it sends to the origin. Default: {}origin_access_control_id (
Optional
[str
]) – The unique identifier of an origin access control for this origin. Default: - no origin access controlorigin_id (
Optional
[str
]) – A unique identifier for the origin. This value must be unique within the distribution. Default: - an originid will be generated for youorigin_shield_enabled (
Optional
[bool
]) – 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. Default: - trueorigin_shield_region (
Optional
[str
]) – When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance. Default: - origin shield not enabledorigin_path (
Optional
[str
]) – 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’). Default: ‘/’origin_access_identity (
Optional
[IOriginAccessIdentity
]) – An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket. Default: - An Origin Access Identity will be created.
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_cloudfront as cloudfront from aws_cdk import aws_cloudfront_origins as cloudfront_origins # origin_access_identity: cloudfront.OriginAccessIdentity s3_origin_props = cloudfront_origins.S3OriginProps( connection_attempts=123, connection_timeout=cdk.Duration.minutes(30), custom_headers={ "custom_headers_key": "customHeaders" }, origin_access_control_id="originAccessControlId", origin_access_identity=origin_access_identity, origin_id="originId", origin_path="originPath", origin_shield_enabled=False, origin_shield_region="originShieldRegion" )
Attributes
- connection_attempts
The number of times that CloudFront attempts to connect to the origin;
valid values are 1, 2, or 3 attempts.
- Default:
3
- connection_timeout
The number of seconds that CloudFront waits when trying to establish a connection to the origin.
Valid values are 1-10 seconds, inclusive.
- Default:
Duration.seconds(10)
- custom_headers
A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
- Default:
{}
- origin_access_control_id
The unique identifier of an origin access control for this origin.
- Default:
no origin access control
- origin_access_identity
An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.
- Default:
An Origin Access Identity will be created.
- origin_id
A unique identifier for the origin.
This value must be unique within the distribution.
- Default:
an originid will be generated for you
- origin_path
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’).
- Default:
‘/’
- origin_shield_enabled
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.
- Default:
true
- origin_shield_region
When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
- Default:
origin shield not enabled
- See:
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html