We recommend new projects start with resources from the AWS provider.
aws-native.cloudfront.Distribution
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
Create Distribution Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Distribution(name: string, args: DistributionArgs, opts?: CustomResourceOptions);
@overload
def Distribution(resource_name: str,
args: DistributionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Distribution(resource_name: str,
opts: Optional[ResourceOptions] = None,
distribution_config: Optional[DistributionConfigArgs] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDistribution(ctx *Context, name string, args DistributionArgs, opts ...ResourceOption) (*Distribution, error)
public Distribution(string name, DistributionArgs args, CustomResourceOptions? opts = null)
public Distribution(String name, DistributionArgs args)
public Distribution(String name, DistributionArgs args, CustomResourceOptions options)
type: aws-native:cloudfront:Distribution
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DistributionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DistributionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DistributionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DistributionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DistributionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Distribution Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Distribution resource accepts the following input properties:
- Distribution
Config Pulumi.Aws Native. Cloud Front. Inputs. Distribution Config - The distribution's configuration.
- List<Pulumi.
Aws Native. Inputs. Tag> - A complex type that contains zero or more
Tag
elements.
- Distribution
Config DistributionConfig Args - The distribution's configuration.
- Tag
Args - A complex type that contains zero or more
Tag
elements.
- distribution
Config DistributionConfig - The distribution's configuration.
- List<Tag>
- A complex type that contains zero or more
Tag
elements.
- distribution
Config DistributionConfig - The distribution's configuration.
- Tag[]
- A complex type that contains zero or more
Tag
elements.
- distribution_
config DistributionConfig Args - The distribution's configuration.
- Sequence[Tag
Args] - A complex type that contains zero or more
Tag
elements.
- distribution
Config Property Map - The distribution's configuration.
- List<Property Map>
- A complex type that contains zero or more
Tag
elements.
Outputs
All input properties are implicitly available as output properties. Additionally, the Distribution resource produces the following output properties:
- Aws
Id string - The distribution's identifier. For example:
E1U5RQF7T870K0
. - Domain
Name string - The domain name of the resource, such as
d111111abcdef8.cloudfront.net
. - Id string
- The provider-assigned unique ID for this managed resource.
- Aws
Id string - The distribution's identifier. For example:
E1U5RQF7T870K0
. - Domain
Name string - The domain name of the resource, such as
d111111abcdef8.cloudfront.net
. - Id string
- The provider-assigned unique ID for this managed resource.
- aws
Id String - The distribution's identifier. For example:
E1U5RQF7T870K0
. - domain
Name String - The domain name of the resource, such as
d111111abcdef8.cloudfront.net
. - id String
- The provider-assigned unique ID for this managed resource.
- aws
Id string - The distribution's identifier. For example:
E1U5RQF7T870K0
. - domain
Name string - The domain name of the resource, such as
d111111abcdef8.cloudfront.net
. - id string
- The provider-assigned unique ID for this managed resource.
- aws_
id str - The distribution's identifier. For example:
E1U5RQF7T870K0
. - domain_
name str - The domain name of the resource, such as
d111111abcdef8.cloudfront.net
. - id str
- The provider-assigned unique ID for this managed resource.
- aws
Id String - The distribution's identifier. For example:
E1U5RQF7T870K0
. - domain
Name String - The domain name of the resource, such as
d111111abcdef8.cloudfront.net
. - id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
DistributionCacheBehavior, DistributionCacheBehaviorArgs
- Path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - Viewer
Protocol stringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- Allowed
Methods List<string> A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- Cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods List<string> A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- Default
Ttl double - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - Forwarded
Values Pulumi.Aws Native. Cloud Front. Inputs. Distribution Forwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations List<Pulumi.Aws Native. Cloud Front. Inputs. Distribution Function Association> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function List<Pulumi.Associations Aws Native. Cloud Front. Inputs. Distribution Lambda Function Association> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
Ttl double - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
Ttl double - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Trusted
Key List<string>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers List<string> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - Viewer
Protocol stringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- Allowed
Methods []string A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- Cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods []string A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- Default
Ttl float64 - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - Forwarded
Values DistributionForwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations []DistributionFunction Association - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function []DistributionAssociations Lambda Function Association - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
Ttl float64 - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
Ttl float64 - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Trusted
Key []stringGroups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers []string - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- path
Pattern String - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - viewer
Protocol StringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- cache
Policy StringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
Ttl Double - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values DistributionForwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<DistributionFunction Association> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<DistributionAssociations Lambda Function Association> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
Ttl Double - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
Ttl Double - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - viewer
Protocol stringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods string[] A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods string[] A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- compress boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
Ttl number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values DistributionForwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations DistributionFunction Association[] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function DistributionAssociations Lambda Function Association[] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
Ttl number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
Ttl number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers stringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - trusted
Key string[]Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers string[] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- path_
pattern str - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - target_
origin_ strid - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - viewer_
protocol_ strpolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed_
methods Sequence[str] A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- cache_
policy_ strid - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached_
methods Sequence[str] A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default_
ttl float - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field_
level_ strencryption_ id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded_
values DistributionForwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function_
associations Sequence[DistributionFunction Association] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda_
function_ Sequence[Distributionassociations Lambda Function Association] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max_
ttl float - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min_
ttl float - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin_
request_ strpolicy_ id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime_
log_ strconfig_ arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response_
headers_ strpolicy_ id - The identifier for a response headers policy.
- smooth_
streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - trusted_
key_ Sequence[str]groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted_
signers Sequence[str] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- path
Pattern String - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - viewer
Protocol StringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- cache
Policy StringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
Ttl Number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values Property Map - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<Property Map> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<Property Map>Associations - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
Ttl Number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
Ttl Number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
DistributionConfig, DistributionConfigArgs
- Default
Cache Pulumi.Behavior Aws Native. Cloud Front. Inputs. Distribution Default Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - Enabled bool
- From this field, you can enable or disable the selected distribution.
- Aliases List<string>
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- Cache
Behaviors List<Pulumi.Aws Native. Cloud Front. Inputs. Distribution Cache Behavior> - A complex type that contains zero or more
CacheBehavior
elements. - Cnames List<string>
An alias for the CloudFront distribution's domain name.
This property is legacy. We recommend that you use Aliases instead.
- Comment string
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- Continuous
Deployment stringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - Custom
Error List<Pulumi.Responses Aws Native. Cloud Front. Inputs. Distribution Custom Error Response> A complex type that controls the following:
- Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
- How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- Custom
Origin Pulumi.Aws Native. Cloud Front. Inputs. Distribution Legacy Custom Origin The user-defined HTTP server that serves as the origin for content that CloudFront distributes.
This property is legacy. We recommend that you use Origin instead.
- Default
Root stringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - Http
Version string - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - Ipv6Enabled bool
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:- You enable IPv6 for the distribution
- You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
- Logging
Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Logging - A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
- Origin
Groups Pulumi.Aws Native. Cloud Front. Inputs. Distribution Origin Groups - A complex type that contains information about origin groups for this distribution.
- Origins
List<Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Origin> - A complex type that contains information about origins for this distribution.
- Price
Class string - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - Restrictions
Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Restrictions - A complex type that identifies ways in which you want to restrict distribution of your content.
- S3Origin
Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Legacy S3Origin The origin as an Amazon S3 bucket.
This property is legacy. We recommend that you use Origin instead.
- Staging bool
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - Viewer
Certificate Pulumi.Aws Native. Cloud Front. Inputs. Distribution Viewer Certificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- Web
Acl stringId - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- Default
Cache DistributionBehavior Default Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - Enabled bool
- From this field, you can enable or disable the selected distribution.
- Aliases []string
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- Cache
Behaviors []DistributionCache Behavior - A complex type that contains zero or more
CacheBehavior
elements. - Cnames []string
An alias for the CloudFront distribution's domain name.
This property is legacy. We recommend that you use Aliases instead.
- Comment string
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- Continuous
Deployment stringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - Custom
Error []DistributionResponses Custom Error Response A complex type that controls the following:
- Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
- How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- Custom
Origin DistributionLegacy Custom Origin The user-defined HTTP server that serves as the origin for content that CloudFront distributes.
This property is legacy. We recommend that you use Origin instead.
- Default
Root stringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - Http
Version string - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - Ipv6Enabled bool
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:- You enable IPv6 for the distribution
- You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
- Logging
Distribution
Logging - A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
- Origin
Groups DistributionOrigin Groups - A complex type that contains information about origin groups for this distribution.
- Origins
[]Distribution
Origin - A complex type that contains information about origins for this distribution.
- Price
Class string - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - Restrictions
Distribution
Restrictions - A complex type that identifies ways in which you want to restrict distribution of your content.
- S3Origin
Distribution
Legacy S3Origin The origin as an Amazon S3 bucket.
This property is legacy. We recommend that you use Origin instead.
- Staging bool
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - Viewer
Certificate DistributionViewer Certificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- Web
Acl stringId - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- default
Cache DistributionBehavior Default Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - enabled Boolean
- From this field, you can enable or disable the selected distribution.
- aliases List<String>
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- cache
Behaviors List<DistributionCache Behavior> - A complex type that contains zero or more
CacheBehavior
elements. - cnames List<String>
An alias for the CloudFront distribution's domain name.
This property is legacy. We recommend that you use Aliases instead.
- comment String
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- continuous
Deployment StringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - custom
Error List<DistributionResponses Custom Error Response> A complex type that controls the following:
- Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
- How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- custom
Origin DistributionLegacy Custom Origin The user-defined HTTP server that serves as the origin for content that CloudFront distributes.
This property is legacy. We recommend that you use Origin instead.
- default
Root StringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - http
Version String - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - ipv6Enabled Boolean
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:- You enable IPv6 for the distribution
- You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
- logging
Distribution
Logging - A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
- origin
Groups DistributionOrigin Groups - A complex type that contains information about origin groups for this distribution.
- origins
List<Distribution
Origin> - A complex type that contains information about origins for this distribution.
- price
Class String - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - restrictions
Distribution
Restrictions - A complex type that identifies ways in which you want to restrict distribution of your content.
- s3Origin
Distribution
Legacy S3Origin The origin as an Amazon S3 bucket.
This property is legacy. We recommend that you use Origin instead.
- staging Boolean
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - viewer
Certificate DistributionViewer Certificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- web
Acl StringId - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- default
Cache DistributionBehavior Default Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - enabled boolean
- From this field, you can enable or disable the selected distribution.
- aliases string[]
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- cache
Behaviors DistributionCache Behavior[] - A complex type that contains zero or more
CacheBehavior
elements. - cnames string[]
An alias for the CloudFront distribution's domain name.
This property is legacy. We recommend that you use Aliases instead.
- comment string
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- continuous
Deployment stringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - custom
Error DistributionResponses Custom Error Response[] A complex type that controls the following:
- Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
- How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- custom
Origin DistributionLegacy Custom Origin The user-defined HTTP server that serves as the origin for content that CloudFront distributes.
This property is legacy. We recommend that you use Origin instead.
- default
Root stringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - http
Version string - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - ipv6Enabled boolean
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:- You enable IPv6 for the distribution
- You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
- logging
Distribution
Logging - A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
- origin
Groups DistributionOrigin Groups - A complex type that contains information about origin groups for this distribution.
- origins
Distribution
Origin[] - A complex type that contains information about origins for this distribution.
- price
Class string - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - restrictions
Distribution
Restrictions - A complex type that identifies ways in which you want to restrict distribution of your content.
- s3Origin
Distribution
Legacy S3Origin The origin as an Amazon S3 bucket.
This property is legacy. We recommend that you use Origin instead.
- staging boolean
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - viewer
Certificate DistributionViewer Certificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- web
Acl stringId - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- default_
cache_ Distributionbehavior Default Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - enabled bool
- From this field, you can enable or disable the selected distribution.
- aliases Sequence[str]
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- cache_
behaviors Sequence[DistributionCache Behavior] - A complex type that contains zero or more
CacheBehavior
elements. - cnames Sequence[str]
An alias for the CloudFront distribution's domain name.
This property is legacy. We recommend that you use Aliases instead.
- comment str
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- continuous_
deployment_ strpolicy_ id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - custom_
error_ Sequence[Distributionresponses Custom Error Response] A complex type that controls the following:
- Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
- How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- custom_
origin DistributionLegacy Custom Origin The user-defined HTTP server that serves as the origin for content that CloudFront distributes.
This property is legacy. We recommend that you use Origin instead.
- default_
root_ strobject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - http_
version str - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - ipv6_
enabled bool If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:- You enable IPv6 for the distribution
- You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
- logging
Distribution
Logging - A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
- origin_
groups DistributionOrigin Groups - A complex type that contains information about origin groups for this distribution.
- origins
Sequence[Distribution
Origin] - A complex type that contains information about origins for this distribution.
- price_
class str - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - restrictions
Distribution
Restrictions - A complex type that identifies ways in which you want to restrict distribution of your content.
- s3_
origin DistributionLegacy S3Origin The origin as an Amazon S3 bucket.
This property is legacy. We recommend that you use Origin instead.
- staging bool
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - viewer_
certificate DistributionViewer Certificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- web_
acl_ strid - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- default
Cache Property MapBehavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - enabled Boolean
- From this field, you can enable or disable the selected distribution.
- aliases List<String>
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- cache
Behaviors List<Property Map> - A complex type that contains zero or more
CacheBehavior
elements. - cnames List<String>
An alias for the CloudFront distribution's domain name.
This property is legacy. We recommend that you use Aliases instead.
- comment String
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- continuous
Deployment StringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - custom
Error List<Property Map>Responses A complex type that controls the following:
- Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
- How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- custom
Origin Property Map The user-defined HTTP server that serves as the origin for content that CloudFront distributes.
This property is legacy. We recommend that you use Origin instead.
- default
Root StringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - http
Version String - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - ipv6Enabled Boolean
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:- You enable IPv6 for the distribution
- You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
- logging Property Map
- A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
- origin
Groups Property Map - A complex type that contains information about origin groups for this distribution.
- origins List<Property Map>
- A complex type that contains information about origins for this distribution.
- price
Class String - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - restrictions Property Map
- A complex type that identifies ways in which you want to restrict distribution of your content.
- s3Origin Property Map
The origin as an Amazon S3 bucket.
This property is legacy. We recommend that you use Origin instead.
- staging Boolean
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - viewer
Certificate Property Map - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- web
Acl StringId - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
DistributionCookies, DistributionCookiesArgs
- Forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - Whitelisted
Names List<string> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify
whitelist
for the value ofForward
. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. If you specifyall
ornone
for the value ofForward
, omitWhitelistedNames
. If you change the value ofForward
fromwhitelist
toall
ornone
and you don't delete theWhitelistedNames
element and its child elements, CloudFront deletes them automatically. For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the General Reference.
- Forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - Whitelisted
Names []string - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify
whitelist
for the value ofForward
. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. If you specifyall
ornone
for the value ofForward
, omitWhitelistedNames
. If you change the value ofForward
fromwhitelist
toall
ornone
and you don't delete theWhitelistedNames
element and its child elements, CloudFront deletes them automatically. For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the General Reference.
- forward String
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names List<String> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify
whitelist
for the value ofForward
. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. If you specifyall
ornone
for the value ofForward
, omitWhitelistedNames
. If you change the value ofForward
fromwhitelist
toall
ornone
and you don't delete theWhitelistedNames
element and its child elements, CloudFront deletes them automatically. For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the General Reference.
- forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names string[] - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify
whitelist
for the value ofForward
. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. If you specifyall
ornone
for the value ofForward
, omitWhitelistedNames
. If you change the value ofForward
fromwhitelist
toall
ornone
and you don't delete theWhitelistedNames
element and its child elements, CloudFront deletes them automatically. For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the General Reference.
- forward str
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted_
names Sequence[str] - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify
whitelist
for the value ofForward
. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. If you specifyall
ornone
for the value ofForward
, omitWhitelistedNames
. If you change the value ofForward
fromwhitelist
toall
ornone
and you don't delete theWhitelistedNames
element and its child elements, CloudFront deletes them automatically. For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the General Reference.
- forward String
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names List<String> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify
whitelist
for the value ofForward
. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. If you specifyall
ornone
for the value ofForward
, omitWhitelistedNames
. If you change the value ofForward
fromwhitelist
toall
ornone
and you don't delete theWhitelistedNames
element and its child elements, CloudFront deletes them automatically. For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the General Reference.
DistributionCustomErrorResponse, DistributionCustomErrorResponseArgs
- Error
Code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- Error
Caching doubleMin Ttl - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - Response
Code int The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. - If you don't care about distinguishing among different client errors or server errors, you can specify
400
or500
as theResponseCode
for all 4xx or 5xx errors. - You might want to return a
200
status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for
ResponseCode
, you must also specify a value forResponsePagePath
.- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
- Response
Page stringPath The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:- The value of
PathPattern
matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named/4xx-errors
. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*
. - The value of
TargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages.
If you specify a value for
ResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.- The value of
- Error
Code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- Error
Caching float64Min Ttl - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - Response
Code int The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. - If you don't care about distinguishing among different client errors or server errors, you can specify
400
or500
as theResponseCode
for all 4xx or 5xx errors. - You might want to return a
200
status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for
ResponseCode
, you must also specify a value forResponsePagePath
.- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
- Response
Page stringPath The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:- The value of
PathPattern
matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named/4xx-errors
. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*
. - The value of
TargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages.
If you specify a value for
ResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.- The value of
- error
Code Integer - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- error
Caching DoubleMin Ttl - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - response
Code Integer The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. - If you don't care about distinguishing among different client errors or server errors, you can specify
400
or500
as theResponseCode
for all 4xx or 5xx errors. - You might want to return a
200
status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for
ResponseCode
, you must also specify a value forResponsePagePath
.- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
- response
Page StringPath The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:- The value of
PathPattern
matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named/4xx-errors
. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*
. - The value of
TargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages.
If you specify a value for
ResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.- The value of
- error
Code number - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- error
Caching numberMin Ttl - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - response
Code number The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. - If you don't care about distinguishing among different client errors or server errors, you can specify
400
or500
as theResponseCode
for all 4xx or 5xx errors. - You might want to return a
200
status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for
ResponseCode
, you must also specify a value forResponsePagePath
.- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
- response
Page stringPath The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:- The value of
PathPattern
matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named/4xx-errors
. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*
. - The value of
TargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages.
If you specify a value for
ResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.- The value of
- error_
code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- error_
caching_ floatmin_ ttl - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - response_
code int The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. - If you don't care about distinguishing among different client errors or server errors, you can specify
400
or500
as theResponseCode
for all 4xx or 5xx errors. - You might want to return a
200
status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for
ResponseCode
, you must also specify a value forResponsePagePath
.- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
- response_
page_ strpath The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:- The value of
PathPattern
matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named/4xx-errors
. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*
. - The value of
TargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages.
If you specify a value for
ResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.- The value of
- error
Code Number - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- error
Caching NumberMin Ttl - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - response
Code Number The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. - If you don't care about distinguishing among different client errors or server errors, you can specify
400
or500
as theResponseCode
for all 4xx or 5xx errors. - You might want to return a
200
status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for
ResponseCode
, you must also specify a value forResponsePagePath
.- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
- response
Page StringPath The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:- The value of
PathPattern
matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named/4xx-errors
. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*
. - The value of
TargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages.
If you specify a value for
ResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.- The value of
DistributionCustomOriginConfig, DistributionCustomOriginConfigArgs
- Origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only
– CloudFront always uses HTTP to connect to the origin.match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only
– CloudFront always uses HTTPS to connect to the origin.
- Http
Port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- Https
Port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- Origin
Keepalive intTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- Origin
Read intTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- Origin
Ssl List<string>Protocols - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- Origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only
– CloudFront always uses HTTP to connect to the origin.match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only
– CloudFront always uses HTTPS to connect to the origin.
- Http
Port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- Https
Port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- Origin
Keepalive intTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- Origin
Read intTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- Origin
Ssl []stringProtocols - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- origin
Protocol StringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only
– CloudFront always uses HTTP to connect to the origin.match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only
– CloudFront always uses HTTPS to connect to the origin.
- http
Port Integer - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port Integer - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- origin
Keepalive IntegerTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- origin
Read IntegerTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- origin
Ssl List<String>Protocols - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only
– CloudFront always uses HTTP to connect to the origin.match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only
– CloudFront always uses HTTPS to connect to the origin.
- http
Port number - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port number - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- origin
Keepalive numberTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- origin
Read numberTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- origin
Ssl string[]Protocols - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- origin_
protocol_ strpolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only
– CloudFront always uses HTTP to connect to the origin.match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only
– CloudFront always uses HTTPS to connect to the origin.
- http_
port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https_
port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- origin_
keepalive_ inttimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- origin_
read_ inttimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- origin_
ssl_ Sequence[str]protocols - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- origin
Protocol StringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only
– CloudFront always uses HTTP to connect to the origin.match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only
– CloudFront always uses HTTPS to connect to the origin.
- http
Port Number - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port Number - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- origin
Keepalive NumberTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- origin
Read NumberTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- origin
Ssl List<String>Protocols - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
DistributionDefaultCacheBehavior, DistributionDefaultCacheBehaviorArgs
- Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - Viewer
Protocol stringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- Allowed
Methods List<string> A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- Cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods List<string> A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - Default
Ttl double - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - Forwarded
Values Pulumi.Aws Native. Cloud Front. Inputs. Distribution Forwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations List<Pulumi.Aws Native. Cloud Front. Inputs. Distribution Function Association> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function List<Pulumi.Associations Aws Native. Cloud Front. Inputs. Distribution Lambda Function Association> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
Ttl double - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
Ttl double - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Trusted
Key List<string>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers List<string> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - Viewer
Protocol stringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- Allowed
Methods []string A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- Cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods []string A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - Default
Ttl float64 - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - Forwarded
Values DistributionForwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations []DistributionFunction Association - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function []DistributionAssociations Lambda Function Association - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
Ttl float64 - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
Ttl float64 - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Trusted
Key []stringGroups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers []string - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - viewer
Protocol StringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- cache
Policy StringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
Ttl Double - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values DistributionForwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<DistributionFunction Association> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<DistributionAssociations Lambda Function Association> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
Ttl Double - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
Ttl Double - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - viewer
Protocol stringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods string[] A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods string[] A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- compress boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
Ttl number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values DistributionForwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations DistributionFunction Association[] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function DistributionAssociations Lambda Function Association[] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
Ttl number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
Ttl number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers stringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - trusted
Key string[]Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers string[] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- target_
origin_ strid - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - viewer_
protocol_ strpolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed_
methods Sequence[str] A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- cache_
policy_ strid - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached_
methods Sequence[str] A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default_
ttl float - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field_
level_ strencryption_ id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded_
values DistributionForwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function_
associations Sequence[DistributionFunction Association] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda_
function_ Sequence[Distributionassociations Lambda Function Association] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max_
ttl float - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min_
ttl float - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin_
request_ strpolicy_ id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime_
log_ strconfig_ arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response_
headers_ strpolicy_ id - The identifier for a response headers policy.
- smooth_
streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - trusted_
key_ Sequence[str]groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted_
signers Sequence[str] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - viewer
Protocol StringPolicy The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options:allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CloudFront forwards only
- cache
Policy StringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- CloudFront caches responses to
- compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
Ttl Number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values Property Map - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<Property Map> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<Property Map>Associations - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
Ttl Number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
Ttl Number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
DistributionForwardedValues, DistributionForwardedValuesArgs
- Query
String bool - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of
QueryString
and on the values that you specify forQueryStringCacheKeys
, if any: If you specify true forQueryString
and you don't specify any values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true forQueryString
and you specify one or more values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false forQueryString
, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide. - Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Cookies - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
- Headers List<string>
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide. - Query
String List<string>Cache Keys - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
- Query
String bool - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of
QueryString
and on the values that you specify forQueryStringCacheKeys
, if any: If you specify true forQueryString
and you don't specify any values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true forQueryString
and you specify one or more values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false forQueryString
, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide. - Distribution
Cookies - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
- Headers []string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide. - Query
String []stringCache Keys - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
- query
String Boolean - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of
QueryString
and on the values that you specify forQueryStringCacheKeys
, if any: If you specify true forQueryString
and you don't specify any values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true forQueryString
and you specify one or more values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false forQueryString
, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide. - Distribution
Cookies - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
- headers List<String>
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide. - query
String List<String>Cache Keys - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
- query
String boolean - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of
QueryString
and on the values that you specify forQueryStringCacheKeys
, if any: If you specify true forQueryString
and you don't specify any values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true forQueryString
and you specify one or more values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false forQueryString
, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide. - Distribution
Cookies - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
- headers string[]
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide. - query
String string[]Cache Keys - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
- query_
string bool - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of
QueryString
and on the values that you specify forQueryStringCacheKeys
, if any: If you specify true forQueryString
and you don't specify any values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true forQueryString
and you specify one or more values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false forQueryString
, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide. - Distribution
Cookies - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
- headers Sequence[str]
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide. - query_
string_ Sequence[str]cache_ keys - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
- query
String Boolean - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of
QueryString
and on the values that you specify forQueryStringCacheKeys
, if any: If you specify true forQueryString
and you don't specify any values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true forQueryString
and you specify one or more values forQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false forQueryString
, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide. - Property Map
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
- headers List<String>
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide. - query
String List<String>Cache Keys - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
DistributionFunctionAssociation, DistributionFunctionAssociationArgs
- Event
Type string - The event type of the function, either
viewer-request
orviewer-response
. You cannot use origin-facing event types (origin-request
andorigin-response
) with a CloudFront function. - Function
Arn string - The Amazon Resource Name (ARN) of the function.
- Event
Type string - The event type of the function, either
viewer-request
orviewer-response
. You cannot use origin-facing event types (origin-request
andorigin-response
) with a CloudFront function. - Function
Arn string - The Amazon Resource Name (ARN) of the function.
- event
Type String - The event type of the function, either
viewer-request
orviewer-response
. You cannot use origin-facing event types (origin-request
andorigin-response
) with a CloudFront function. - function
Arn String - The Amazon Resource Name (ARN) of the function.
- event
Type string - The event type of the function, either
viewer-request
orviewer-response
. You cannot use origin-facing event types (origin-request
andorigin-response
) with a CloudFront function. - function
Arn string - The Amazon Resource Name (ARN) of the function.
- event_
type str - The event type of the function, either
viewer-request
orviewer-response
. You cannot use origin-facing event types (origin-request
andorigin-response
) with a CloudFront function. - function_
arn str - The Amazon Resource Name (ARN) of the function.
- event
Type String - The event type of the function, either
viewer-request
orviewer-response
. You cannot use origin-facing event types (origin-request
andorigin-response
) with a CloudFront function. - function
Arn String - The Amazon Resource Name (ARN) of the function.
DistributionGeoRestriction, DistributionGeoRestrictionArgs
- Restriction
Type string - The method that you want to use to restrict distribution of your content by country:
none
: No geo restriction is enabled, meaning access to content is not restricted by client geo location.blacklist
: TheLocation
elements specify the countries in which you don't want CloudFront to distribute your content.whitelist
: TheLocation
elements specify the countries in which you want CloudFront to distribute your content.
- Locations List<string>
- A complex type that contains a
Location
element for each country in which you want CloudFront either to distribute your content (whitelist
) or not distribute your content (blacklist
). TheLocation
element is a two-letter, uppercase country code for a country that you want to include in yourblacklist
orwhitelist
. Include oneLocation
element for each country. CloudFront andMaxMind
both useISO 3166
country codes. For the current list of countries and the corresponding codes, seeISO 3166-1-alpha-2
code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
- Restriction
Type string - The method that you want to use to restrict distribution of your content by country:
none
: No geo restriction is enabled, meaning access to content is not restricted by client geo location.blacklist
: TheLocation
elements specify the countries in which you don't want CloudFront to distribute your content.whitelist
: TheLocation
elements specify the countries in which you want CloudFront to distribute your content.
- Locations []string
- A complex type that contains a
Location
element for each country in which you want CloudFront either to distribute your content (whitelist
) or not distribute your content (blacklist
). TheLocation
element is a two-letter, uppercase country code for a country that you want to include in yourblacklist
orwhitelist
. Include oneLocation
element for each country. CloudFront andMaxMind
both useISO 3166
country codes. For the current list of countries and the corresponding codes, seeISO 3166-1-alpha-2
code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
- restriction
Type String - The method that you want to use to restrict distribution of your content by country:
none
: No geo restriction is enabled, meaning access to content is not restricted by client geo location.blacklist
: TheLocation
elements specify the countries in which you don't want CloudFront to distribute your content.whitelist
: TheLocation
elements specify the countries in which you want CloudFront to distribute your content.
- locations List<String>
- A complex type that contains a
Location
element for each country in which you want CloudFront either to distribute your content (whitelist
) or not distribute your content (blacklist
). TheLocation
element is a two-letter, uppercase country code for a country that you want to include in yourblacklist
orwhitelist
. Include oneLocation
element for each country. CloudFront andMaxMind
both useISO 3166
country codes. For the current list of countries and the corresponding codes, seeISO 3166-1-alpha-2
code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
- restriction
Type string - The method that you want to use to restrict distribution of your content by country:
none
: No geo restriction is enabled, meaning access to content is not restricted by client geo location.blacklist
: TheLocation
elements specify the countries in which you don't want CloudFront to distribute your content.whitelist
: TheLocation
elements specify the countries in which you want CloudFront to distribute your content.
- locations string[]
- A complex type that contains a
Location
element for each country in which you want CloudFront either to distribute your content (whitelist
) or not distribute your content (blacklist
). TheLocation
element is a two-letter, uppercase country code for a country that you want to include in yourblacklist
orwhitelist
. Include oneLocation
element for each country. CloudFront andMaxMind
both useISO 3166
country codes. For the current list of countries and the corresponding codes, seeISO 3166-1-alpha-2
code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
- restriction_
type str - The method that you want to use to restrict distribution of your content by country:
none
: No geo restriction is enabled, meaning access to content is not restricted by client geo location.blacklist
: TheLocation
elements specify the countries in which you don't want CloudFront to distribute your content.whitelist
: TheLocation
elements specify the countries in which you want CloudFront to distribute your content.
- locations Sequence[str]
- A complex type that contains a
Location
element for each country in which you want CloudFront either to distribute your content (whitelist
) or not distribute your content (blacklist
). TheLocation
element is a two-letter, uppercase country code for a country that you want to include in yourblacklist
orwhitelist
. Include oneLocation
element for each country. CloudFront andMaxMind
both useISO 3166
country codes. For the current list of countries and the corresponding codes, seeISO 3166-1-alpha-2
code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
- restriction
Type String - The method that you want to use to restrict distribution of your content by country:
none
: No geo restriction is enabled, meaning access to content is not restricted by client geo location.blacklist
: TheLocation
elements specify the countries in which you don't want CloudFront to distribute your content.whitelist
: TheLocation
elements specify the countries in which you want CloudFront to distribute your content.
- locations List<String>
- A complex type that contains a
Location
element for each country in which you want CloudFront either to distribute your content (whitelist
) or not distribute your content (blacklist
). TheLocation
element is a two-letter, uppercase country code for a country that you want to include in yourblacklist
orwhitelist
. Include oneLocation
element for each country. CloudFront andMaxMind
both useISO 3166
country codes. For the current list of countries and the corresponding codes, seeISO 3166-1-alpha-2
code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
DistributionLambdaFunctionAssociation, DistributionLambdaFunctionAssociationArgs
- Event
Type string - Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request
: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request
: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response
: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response
: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
- Include
Body bool - A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
- Lambda
Function stringArn - The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
- Event
Type string - Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request
: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request
: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response
: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response
: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
- Include
Body bool - A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
- Lambda
Function stringArn - The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
- event
Type String - Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request
: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request
: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response
: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response
: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
- include
Body Boolean - A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
- lambda
Function StringArn - The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
- event
Type string - Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request
: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request
: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response
: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response
: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
- include
Body boolean - A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
- lambda
Function stringArn - The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
- event_
type str - Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request
: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request
: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response
: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response
: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
- include_
body bool - A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
- lambda_
function_ strarn - The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
- event
Type String - Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request
: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request
: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response
: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response
: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
- include
Body Boolean - A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
- lambda
Function StringArn - The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
DistributionLegacyCustomOrigin, DistributionLegacyCustomOriginArgs
- Dns
Name string - The domain name assigned to your CloudFront distribution.
- Origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
- Origin
Ssl List<string>Protocols The minimum SSL/TLS protocol version that CloudFront uses when communicating with your origin server over HTTPs.
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
- Http
Port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- Https
Port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- Dns
Name string - The domain name assigned to your CloudFront distribution.
- Origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
- Origin
Ssl []stringProtocols The minimum SSL/TLS protocol version that CloudFront uses when communicating with your origin server over HTTPs.
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
- Http
Port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- Https
Port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- dns
Name String - The domain name assigned to your CloudFront distribution.
- origin
Protocol StringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
- origin
Ssl List<String>Protocols The minimum SSL/TLS protocol version that CloudFront uses when communicating with your origin server over HTTPs.
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
- http
Port Integer - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port Integer - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- dns
Name string - The domain name assigned to your CloudFront distribution.
- origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
- origin
Ssl string[]Protocols The minimum SSL/TLS protocol version that CloudFront uses when communicating with your origin server over HTTPs.
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
- http
Port number - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port number - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- dns_
name str - The domain name assigned to your CloudFront distribution.
- origin_
protocol_ strpolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
- origin_
ssl_ Sequence[str]protocols The minimum SSL/TLS protocol version that CloudFront uses when communicating with your origin server over HTTPs.
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
- http_
port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https_
port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- dns
Name String - The domain name assigned to your CloudFront distribution.
- origin
Protocol StringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
- origin
Ssl List<String>Protocols The minimum SSL/TLS protocol version that CloudFront uses when communicating with your origin server over HTTPs.
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
- http
Port Number - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port Number - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
DistributionLegacyS3Origin, DistributionLegacyS3OriginArgs
- Dns
Name string - The domain name assigned to your CloudFront distribution.
- Origin
Access stringIdentity The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 through CloudFront .
This property is legacy. We recommend that you use OriginAccessControl instead.
- Dns
Name string - The domain name assigned to your CloudFront distribution.
- Origin
Access stringIdentity The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 through CloudFront .
This property is legacy. We recommend that you use OriginAccessControl instead.
- dns
Name String - The domain name assigned to your CloudFront distribution.
- origin
Access StringIdentity The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 through CloudFront .
This property is legacy. We recommend that you use OriginAccessControl instead.
- dns
Name string - The domain name assigned to your CloudFront distribution.
- origin
Access stringIdentity The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 through CloudFront .
This property is legacy. We recommend that you use OriginAccessControl instead.
- dns_
name str - The domain name assigned to your CloudFront distribution.
- origin_
access_ stridentity The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 through CloudFront .
This property is legacy. We recommend that you use OriginAccessControl instead.
- dns
Name String - The domain name assigned to your CloudFront distribution.
- origin
Access StringIdentity The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 through CloudFront .
This property is legacy. We recommend that you use OriginAccessControl instead.
DistributionLogging, DistributionLoggingArgs
- Bucket string
- The Amazon S3 bucket to store the access logs in, for example,
myawslogbucket.s3.amazonaws.com
. - bool
- Specifies whether you want CloudFront to include cookies in access logs, specify
true
forIncludeCookies
. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specifyfalse
forIncludeCookies
. - Prefix string
- An optional string that you want CloudFront to prefix to the access log
filenames
for this distribution, for example,myprefix/
. If you want to enable logging, but you don't want to specify a prefix, you still must include an emptyPrefix
element in theLogging
element.
- Bucket string
- The Amazon S3 bucket to store the access logs in, for example,
myawslogbucket.s3.amazonaws.com
. - bool
- Specifies whether you want CloudFront to include cookies in access logs, specify
true
forIncludeCookies
. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specifyfalse
forIncludeCookies
. - Prefix string
- An optional string that you want CloudFront to prefix to the access log
filenames
for this distribution, for example,myprefix/
. If you want to enable logging, but you don't want to specify a prefix, you still must include an emptyPrefix
element in theLogging
element.
- bucket String
- The Amazon S3 bucket to store the access logs in, for example,
myawslogbucket.s3.amazonaws.com
. - Boolean
- Specifies whether you want CloudFront to include cookies in access logs, specify
true
forIncludeCookies
. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specifyfalse
forIncludeCookies
. - prefix String
- An optional string that you want CloudFront to prefix to the access log
filenames
for this distribution, for example,myprefix/
. If you want to enable logging, but you don't want to specify a prefix, you still must include an emptyPrefix
element in theLogging
element.
- bucket string
- The Amazon S3 bucket to store the access logs in, for example,
myawslogbucket.s3.amazonaws.com
. - boolean
- Specifies whether you want CloudFront to include cookies in access logs, specify
true
forIncludeCookies
. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specifyfalse
forIncludeCookies
. - prefix string
- An optional string that you want CloudFront to prefix to the access log
filenames
for this distribution, for example,myprefix/
. If you want to enable logging, but you don't want to specify a prefix, you still must include an emptyPrefix
element in theLogging
element.
- bucket str
- The Amazon S3 bucket to store the access logs in, for example,
myawslogbucket.s3.amazonaws.com
. - bool
- Specifies whether you want CloudFront to include cookies in access logs, specify
true
forIncludeCookies
. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specifyfalse
forIncludeCookies
. - prefix str
- An optional string that you want CloudFront to prefix to the access log
filenames
for this distribution, for example,myprefix/
. If you want to enable logging, but you don't want to specify a prefix, you still must include an emptyPrefix
element in theLogging
element.
- bucket String
- The Amazon S3 bucket to store the access logs in, for example,
myawslogbucket.s3.amazonaws.com
. - Boolean
- Specifies whether you want CloudFront to include cookies in access logs, specify
true
forIncludeCookies
. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specifyfalse
forIncludeCookies
. - prefix String
- An optional string that you want CloudFront to prefix to the access log
filenames
for this distribution, for example,myprefix/
. If you want to enable logging, but you don't want to specify a prefix, you still must include an emptyPrefix
element in theLogging
element.
DistributionOrigin, DistributionOriginArgs
- Domain
Name string - The domain name for the origin. For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
- Id string
- A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginId
in aCacheBehavior
orDefaultCacheBehavior
. - Connection
Attempts int - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout. For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
- Connection
Timeout int - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
- Custom
Origin Pulumi.Config Aws Native. Cloud Front. Inputs. Distribution Custom Origin Config - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the
S3OriginConfig
type instead. - Origin
Access stringControl Id - The unique identifier of an origin access control for this origin. For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
- Origin
Custom List<Pulumi.Headers Aws Native. Cloud Front. Inputs. Distribution Origin Custom Header> - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- Origin
Path string - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see Origin Path in the Amazon CloudFront Developer Guide.
- Origin
Shield Pulumi.Aws Native. Cloud Front. Inputs. Distribution Origin Shield - CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
- S3Origin
Config Pulumi.Aws Native. Cloud Front. Inputs. Distribution S3Origin Config - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the
CustomOriginConfig
type instead.
- Domain
Name string - The domain name for the origin. For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
- Id string
- A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginId
in aCacheBehavior
orDefaultCacheBehavior
. - Connection
Attempts int - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout. For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
- Connection
Timeout int - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
- Custom
Origin DistributionConfig Custom Origin Config - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the
S3OriginConfig
type instead. - Origin
Access stringControl Id - The unique identifier of an origin access control for this origin. For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
- Origin
Custom []DistributionHeaders Origin Custom Header - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- Origin
Path string - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see Origin Path in the Amazon CloudFront Developer Guide.
- Origin
Shield DistributionOrigin Shield - CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
- S3Origin
Config DistributionS3Origin Config - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the
CustomOriginConfig
type instead.
- domain
Name String - The domain name for the origin. For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
- id String
- A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginId
in aCacheBehavior
orDefaultCacheBehavior
. - connection
Attempts Integer - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout. For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
- connection
Timeout Integer - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
- custom
Origin DistributionConfig Custom Origin Config - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the
S3OriginConfig
type instead. - origin
Access StringControl Id - The unique identifier of an origin access control for this origin. For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
- origin
Custom List<DistributionHeaders Origin Custom Header> - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- origin
Path String - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see Origin Path in the Amazon CloudFront Developer Guide.
- origin
Shield DistributionOrigin Shield - CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
- s3Origin
Config DistributionS3Origin Config - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the
CustomOriginConfig
type instead.
- domain
Name string - The domain name for the origin. For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
- id string
- A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginId
in aCacheBehavior
orDefaultCacheBehavior
. - connection
Attempts number - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout. For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
- connection
Timeout number - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
- custom
Origin DistributionConfig Custom Origin Config - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the
S3OriginConfig
type instead. - origin
Access stringControl Id - The unique identifier of an origin access control for this origin. For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
- origin
Custom DistributionHeaders Origin Custom Header[] - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- origin
Path string - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see Origin Path in the Amazon CloudFront Developer Guide.
- origin
Shield DistributionOrigin Shield - CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
- s3Origin
Config DistributionS3Origin Config - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the
CustomOriginConfig
type instead.
- domain_
name str - The domain name for the origin. For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
- id str
- A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginId
in aCacheBehavior
orDefaultCacheBehavior
. - connection_
attempts int - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout. For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
- connection_
timeout int - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
- custom_
origin_ Distributionconfig Custom Origin Config - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the
S3OriginConfig
type instead. - origin_
access_ strcontrol_ id - The unique identifier of an origin access control for this origin. For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
- origin_
custom_ Sequence[Distributionheaders Origin Custom Header] - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- origin_
path str - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see Origin Path in the Amazon CloudFront Developer Guide.
- origin_
shield DistributionOrigin Shield - CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
- s3_
origin_ Distributionconfig S3Origin Config - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the
CustomOriginConfig
type instead.
- domain
Name String - The domain name for the origin. For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
- id String
- A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginId
in aCacheBehavior
orDefaultCacheBehavior
. - connection
Attempts Number - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout. For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
- connection
Timeout Number - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
- custom
Origin Property MapConfig - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the
S3OriginConfig
type instead. - origin
Access StringControl Id - The unique identifier of an origin access control for this origin. For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
- origin
Custom List<Property Map>Headers - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- origin
Path String - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see Origin Path in the Amazon CloudFront Developer Guide.
- origin
Shield Property Map - CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
- s3Origin
Config Property Map - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the
CustomOriginConfig
type instead.
DistributionOriginCustomHeader, DistributionOriginCustomHeaderArgs
- Header
Name string - The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- Header
Value string - The value for the header that you specified in the
HeaderName
field.
- Header
Name string - The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- Header
Value string - The value for the header that you specified in the
HeaderName
field.
- header
Name String - The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- header
Value String - The value for the header that you specified in the
HeaderName
field.
- header
Name string - The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- header
Value string - The value for the header that you specified in the
HeaderName
field.
- header_
name str - The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- header_
value str - The value for the header that you specified in the
HeaderName
field.
- header
Name String - The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- header
Value String - The value for the header that you specified in the
HeaderName
field.
DistributionOriginGroup, DistributionOriginGroupArgs
- Failover
Criteria Pulumi.Aws Native. Cloud Front. Inputs. Distribution Origin Group Failover Criteria - A complex type that contains information about the failover criteria for an origin group.
- Id string
- The origin group's ID.
- Members
Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Origin Group Members - A complex type that contains information about the origins in an origin group.
- Failover
Criteria DistributionOrigin Group Failover Criteria - A complex type that contains information about the failover criteria for an origin group.
- Id string
- The origin group's ID.
- Members
Distribution
Origin Group Members - A complex type that contains information about the origins in an origin group.
- failover
Criteria DistributionOrigin Group Failover Criteria - A complex type that contains information about the failover criteria for an origin group.
- id String
- The origin group's ID.
- members
Distribution
Origin Group Members - A complex type that contains information about the origins in an origin group.
- failover
Criteria DistributionOrigin Group Failover Criteria - A complex type that contains information about the failover criteria for an origin group.
- id string
- The origin group's ID.
- members
Distribution
Origin Group Members - A complex type that contains information about the origins in an origin group.
- failover_
criteria DistributionOrigin Group Failover Criteria - A complex type that contains information about the failover criteria for an origin group.
- id str
- The origin group's ID.
- members
Distribution
Origin Group Members - A complex type that contains information about the origins in an origin group.
- failover
Criteria Property Map - A complex type that contains information about the failover criteria for an origin group.
- id String
- The origin group's ID.
- members Property Map
- A complex type that contains information about the origins in an origin group.
DistributionOriginGroupFailoverCriteria, DistributionOriginGroupFailoverCriteriaArgs
- Status
Codes Pulumi.Aws Native. Cloud Front. Inputs. Distribution Status Codes - The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
- Status
Codes DistributionStatus Codes - The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
- status
Codes DistributionStatus Codes - The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
- status
Codes DistributionStatus Codes - The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
- status_
codes DistributionStatus Codes - The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
- status
Codes Property Map - The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
DistributionOriginGroupMember, DistributionOriginGroupMemberArgs
- Origin
Id string - The ID for an origin in an origin group.
- Origin
Id string - The ID for an origin in an origin group.
- origin
Id String - The ID for an origin in an origin group.
- origin
Id string - The ID for an origin in an origin group.
- origin_
id str - The ID for an origin in an origin group.
- origin
Id String - The ID for an origin in an origin group.
DistributionOriginGroupMembers, DistributionOriginGroupMembersArgs
- Items
List<Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Origin Group Member> - Items (origins) in an origin group.
- Quantity int
- The number of origins in an origin group.
- Items
[]Distribution
Origin Group Member - Items (origins) in an origin group.
- Quantity int
- The number of origins in an origin group.
- items
List<Distribution
Origin Group Member> - Items (origins) in an origin group.
- quantity Integer
- The number of origins in an origin group.
- items
Distribution
Origin Group Member[] - Items (origins) in an origin group.
- quantity number
- The number of origins in an origin group.
- items
Sequence[Distribution
Origin Group Member] - Items (origins) in an origin group.
- quantity int
- The number of origins in an origin group.
- items List<Property Map>
- Items (origins) in an origin group.
- quantity Number
- The number of origins in an origin group.
DistributionOriginGroups, DistributionOriginGroupsArgs
- Quantity int
- The number of origin groups.
- Items
List<Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Origin Group> - The items (origin groups) in a distribution.
- Quantity int
- The number of origin groups.
- Items
[]Distribution
Origin Group - The items (origin groups) in a distribution.
- quantity Integer
- The number of origin groups.
- items
List<Distribution
Origin Group> - The items (origin groups) in a distribution.
- quantity number
- The number of origin groups.
- items
Distribution
Origin Group[] - The items (origin groups) in a distribution.
- quantity int
- The number of origin groups.
- items
Sequence[Distribution
Origin Group] - The items (origin groups) in a distribution.
- quantity Number
- The number of origin groups.
- items List<Property Map>
- The items (origin groups) in a distribution.
DistributionOriginShield, DistributionOriginShieldArgs
- Enabled bool
- A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
- Origin
Shield stringRegion - The AWS-Region for Origin Shield.
Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as
us-east-2
. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the for Origin Shield in the Amazon CloudFront Developer Guide.
- Enabled bool
- A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
- Origin
Shield stringRegion - The AWS-Region for Origin Shield.
Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as
us-east-2
. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the for Origin Shield in the Amazon CloudFront Developer Guide.
- enabled Boolean
- A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
- origin
Shield StringRegion - The AWS-Region for Origin Shield.
Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as
us-east-2
. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the for Origin Shield in the Amazon CloudFront Developer Guide.
- enabled boolean
- A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
- origin
Shield stringRegion - The AWS-Region for Origin Shield.
Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as
us-east-2
. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the for Origin Shield in the Amazon CloudFront Developer Guide.
- enabled bool
- A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
- origin_
shield_ strregion - The AWS-Region for Origin Shield.
Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as
us-east-2
. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the for Origin Shield in the Amazon CloudFront Developer Guide.
- enabled Boolean
- A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
- origin
Shield StringRegion - The AWS-Region for Origin Shield.
Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as
us-east-2
. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the for Origin Shield in the Amazon CloudFront Developer Guide.
DistributionRestrictions, DistributionRestrictionsArgs
- Geo
Restriction Pulumi.Aws Native. Cloud Front. Inputs. Distribution Geo Restriction - A complex type that controls the countries in which your content is distributed. CF determines the location of your users using
MaxMind
GeoIP databases. To disable geo restriction, remove the Restrictions property from your stack template.
- Geo
Restriction DistributionGeo Restriction - A complex type that controls the countries in which your content is distributed. CF determines the location of your users using
MaxMind
GeoIP databases. To disable geo restriction, remove the Restrictions property from your stack template.
- geo
Restriction DistributionGeo Restriction - A complex type that controls the countries in which your content is distributed. CF determines the location of your users using
MaxMind
GeoIP databases. To disable geo restriction, remove the Restrictions property from your stack template.
- geo
Restriction DistributionGeo Restriction - A complex type that controls the countries in which your content is distributed. CF determines the location of your users using
MaxMind
GeoIP databases. To disable geo restriction, remove the Restrictions property from your stack template.
- geo_
restriction DistributionGeo Restriction - A complex type that controls the countries in which your content is distributed. CF determines the location of your users using
MaxMind
GeoIP databases. To disable geo restriction, remove the Restrictions property from your stack template.
- geo
Restriction Property Map - A complex type that controls the countries in which your content is distributed. CF determines the location of your users using
MaxMind
GeoIP databases. To disable geo restriction, remove the Restrictions property from your stack template.
DistributionS3OriginConfig, DistributionS3OriginConfigArgs
- Origin
Access stringIdentity - The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where
ID-of-origin-access-identity
is the value that CloudFront returned in theID
element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an emptyOriginAccessIdentity
element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an emptyOriginAccessIdentity
element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
- Origin
Access stringIdentity - The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where
ID-of-origin-access-identity
is the value that CloudFront returned in theID
element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an emptyOriginAccessIdentity
element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an emptyOriginAccessIdentity
element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
- origin
Access StringIdentity - The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where
ID-of-origin-access-identity
is the value that CloudFront returned in theID
element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an emptyOriginAccessIdentity
element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an emptyOriginAccessIdentity
element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
- origin
Access stringIdentity - The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where
ID-of-origin-access-identity
is the value that CloudFront returned in theID
element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an emptyOriginAccessIdentity
element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an emptyOriginAccessIdentity
element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
- origin_
access_ stridentity - The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where
ID-of-origin-access-identity
is the value that CloudFront returned in theID
element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an emptyOriginAccessIdentity
element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an emptyOriginAccessIdentity
element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
- origin
Access StringIdentity - The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where
ID-of-origin-access-identity
is the value that CloudFront returned in theID
element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an emptyOriginAccessIdentity
element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an emptyOriginAccessIdentity
element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
DistributionStatusCodes, DistributionStatusCodesArgs
DistributionViewerCertificate, DistributionViewerCertificateArgs
- Acm
Certificate stringArn - In CloudFormation, this field name is
AcmCertificateArn
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1
). If you specify an ACM certificate ARN, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - Cloud
Front boolDefault Certificate - If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, set this field totrue
. If the distribution usesAliases
(alternate domain names or CNAMEs), omit this field and specify values for the following fields:AcmCertificateArn
orIamCertificateId
(specify a value for one, not both)MinimumProtocolVersion
SslSupportMethod
- Iam
Certificate stringId - In CloudFormation, this field name is
IamCertificateId
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (IAM), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - Minimum
Protocol stringVersion If the distribution uses
Aliases
(alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:- The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
- The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. On the CloudFront console, this setting is called Security Policy. When you're using SNI only (you set
SSLSupportMethod
tosni-only
), you must specifyTLSv1
or higher. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) If the distribution uses the CloudFront domain name such asd111111abcdef8.cloudfront.net
(you setCloudFrontDefaultCertificate
totrue
), CloudFront automatically sets the security policy toTLSv1
regardless of the value that you set here.- Ssl
Support stringMethod In CloudFormation, this field name is
SslSupportMethod
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.sni-only
– The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.vip
– The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip
- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Center.
If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, don't set a value for this field.
- Acm
Certificate stringArn - In CloudFormation, this field name is
AcmCertificateArn
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1
). If you specify an ACM certificate ARN, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - Cloud
Front boolDefault Certificate - If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, set this field totrue
. If the distribution usesAliases
(alternate domain names or CNAMEs), omit this field and specify values for the following fields:AcmCertificateArn
orIamCertificateId
(specify a value for one, not both)MinimumProtocolVersion
SslSupportMethod
- Iam
Certificate stringId - In CloudFormation, this field name is
IamCertificateId
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (IAM), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - Minimum
Protocol stringVersion If the distribution uses
Aliases
(alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:- The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
- The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. On the CloudFront console, this setting is called Security Policy. When you're using SNI only (you set
SSLSupportMethod
tosni-only
), you must specifyTLSv1
or higher. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) If the distribution uses the CloudFront domain name such asd111111abcdef8.cloudfront.net
(you setCloudFrontDefaultCertificate
totrue
), CloudFront automatically sets the security policy toTLSv1
regardless of the value that you set here.- Ssl
Support stringMethod In CloudFormation, this field name is
SslSupportMethod
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.sni-only
– The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.vip
– The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip
- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Center.
If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, don't set a value for this field.
- acm
Certificate StringArn - In CloudFormation, this field name is
AcmCertificateArn
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1
). If you specify an ACM certificate ARN, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - cloud
Front BooleanDefault Certificate - If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, set this field totrue
. If the distribution usesAliases
(alternate domain names or CNAMEs), omit this field and specify values for the following fields:AcmCertificateArn
orIamCertificateId
(specify a value for one, not both)MinimumProtocolVersion
SslSupportMethod
- iam
Certificate StringId - In CloudFormation, this field name is
IamCertificateId
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (IAM), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - minimum
Protocol StringVersion If the distribution uses
Aliases
(alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:- The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
- The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. On the CloudFront console, this setting is called Security Policy. When you're using SNI only (you set
SSLSupportMethod
tosni-only
), you must specifyTLSv1
or higher. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) If the distribution uses the CloudFront domain name such asd111111abcdef8.cloudfront.net
(you setCloudFrontDefaultCertificate
totrue
), CloudFront automatically sets the security policy toTLSv1
regardless of the value that you set here.- ssl
Support StringMethod In CloudFormation, this field name is
SslSupportMethod
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.sni-only
– The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.vip
– The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip
- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Center.
If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, don't set a value for this field.
- acm
Certificate stringArn - In CloudFormation, this field name is
AcmCertificateArn
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1
). If you specify an ACM certificate ARN, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - cloud
Front booleanDefault Certificate - If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, set this field totrue
. If the distribution usesAliases
(alternate domain names or CNAMEs), omit this field and specify values for the following fields:AcmCertificateArn
orIamCertificateId
(specify a value for one, not both)MinimumProtocolVersion
SslSupportMethod
- iam
Certificate stringId - In CloudFormation, this field name is
IamCertificateId
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (IAM), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - minimum
Protocol stringVersion If the distribution uses
Aliases
(alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:- The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
- The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. On the CloudFront console, this setting is called Security Policy. When you're using SNI only (you set
SSLSupportMethod
tosni-only
), you must specifyTLSv1
or higher. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) If the distribution uses the CloudFront domain name such asd111111abcdef8.cloudfront.net
(you setCloudFrontDefaultCertificate
totrue
), CloudFront automatically sets the security policy toTLSv1
regardless of the value that you set here.- ssl
Support stringMethod In CloudFormation, this field name is
SslSupportMethod
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.sni-only
– The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.vip
– The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip
- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Center.
If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, don't set a value for this field.
- acm_
certificate_ strarn - In CloudFormation, this field name is
AcmCertificateArn
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1
). If you specify an ACM certificate ARN, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - cloud_
front_ booldefault_ certificate - If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, set this field totrue
. If the distribution usesAliases
(alternate domain names or CNAMEs), omit this field and specify values for the following fields:AcmCertificateArn
orIamCertificateId
(specify a value for one, not both)MinimumProtocolVersion
SslSupportMethod
- iam_
certificate_ strid - In CloudFormation, this field name is
IamCertificateId
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (IAM), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - minimum_
protocol_ strversion If the distribution uses
Aliases
(alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:- The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
- The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. On the CloudFront console, this setting is called Security Policy. When you're using SNI only (you set
SSLSupportMethod
tosni-only
), you must specifyTLSv1
or higher. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) If the distribution uses the CloudFront domain name such asd111111abcdef8.cloudfront.net
(you setCloudFrontDefaultCertificate
totrue
), CloudFront automatically sets the security policy toTLSv1
regardless of the value that you set here.- ssl_
support_ strmethod In CloudFormation, this field name is
SslSupportMethod
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.sni-only
– The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.vip
– The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip
- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Center.
If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, don't set a value for this field.
- acm
Certificate StringArn - In CloudFormation, this field name is
AcmCertificateArn
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1
). If you specify an ACM certificate ARN, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - cloud
Front BooleanDefault Certificate - If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, set this field totrue
. If the distribution usesAliases
(alternate domain names or CNAMEs), omit this field and specify values for the following fields:AcmCertificateArn
orIamCertificateId
(specify a value for one, not both)MinimumProtocolVersion
SslSupportMethod
- iam
Certificate StringId - In CloudFormation, this field name is
IamCertificateId
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in (IAM), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values forMinimumProtocolVersion
andSSLSupportMethod
. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) - minimum
Protocol StringVersion If the distribution uses
Aliases
(alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:- The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
- The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. On the CloudFront console, this setting is called Security Policy. When you're using SNI only (you set
SSLSupportMethod
tosni-only
), you must specifyTLSv1
or higher. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) If the distribution uses the CloudFront domain name such asd111111abcdef8.cloudfront.net
(you setCloudFrontDefaultCertificate
totrue
), CloudFront automatically sets the security policy toTLSv1
regardless of the value that you set here.- ssl
Support StringMethod In CloudFormation, this field name is
SslSupportMethod
. Note the different capitalization. If the distribution usesAliases
(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.sni-only
– The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.vip
– The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip
- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Center.
If the distribution uses the CloudFront domain name such as
d111111abcdef8.cloudfront.net
, don't set a value for this field.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.