This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Amazon CloudFront
<a name="AWS_CloudFront"></a>

**Resource types**
+ [AWS::CloudFront::AnycastIpList](aws-resource-cloudfront-anycastiplist.md)
+ [AWS::CloudFront::CachePolicy](aws-resource-cloudfront-cachepolicy.md)
+ [AWS::CloudFront::CloudFrontOriginAccessIdentity](aws-resource-cloudfront-cloudfrontoriginaccessidentity.md)
+ [AWS::CloudFront::ConnectionFunction](aws-resource-cloudfront-connectionfunction.md)
+ [AWS::CloudFront::ConnectionGroup](aws-resource-cloudfront-connectiongroup.md)
+ [AWS::CloudFront::ContinuousDeploymentPolicy](aws-resource-cloudfront-continuousdeploymentpolicy.md)
+ [AWS::CloudFront::Distribution](aws-resource-cloudfront-distribution.md)
+ [AWS::CloudFront::DistributionTenant](aws-resource-cloudfront-distributiontenant.md)
+ [AWS::CloudFront::Function](aws-resource-cloudfront-function.md)
+ [AWS::CloudFront::KeyGroup](aws-resource-cloudfront-keygroup.md)
+ [AWS::CloudFront::KeyValueStore](aws-resource-cloudfront-keyvaluestore.md)
+ [AWS::CloudFront::MonitoringSubscription](aws-resource-cloudfront-monitoringsubscription.md)
+ [AWS::CloudFront::OriginAccessControl](aws-resource-cloudfront-originaccesscontrol.md)
+ [AWS::CloudFront::OriginRequestPolicy](aws-resource-cloudfront-originrequestpolicy.md)
+ [AWS::CloudFront::PublicKey](aws-resource-cloudfront-publickey.md)
+ [AWS::CloudFront::RealtimeLogConfig](aws-resource-cloudfront-realtimelogconfig.md)
+ [AWS::CloudFront::ResponseHeadersPolicy](aws-resource-cloudfront-responseheaderspolicy.md)
+ [AWS::CloudFront::StreamingDistribution](aws-resource-cloudfront-streamingdistribution.md)
+ [AWS::CloudFront::TrustStore](aws-resource-cloudfront-truststore.md)
+ [AWS::CloudFront::VpcOrigin](aws-resource-cloudfront-vpcorigin.md)

# AWS::CloudFront::AnycastIpList
<a name="aws-resource-cloudfront-anycastiplist"></a>

An Anycast static IP list. For more information, see [Request Anycast static IPs to use for allowlisting](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/request-static-ips.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-resource-cloudfront-anycastiplist-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-anycastiplist-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::AnycastIpList",
  "Properties" : {
      "[IpAddressType](#cfn-cloudfront-anycastiplist-ipaddresstype)" : String,
      "[IpamCidrConfigs](#cfn-cloudfront-anycastiplist-ipamcidrconfigs)" : [ IpamCidrConfig, ... ],
      "[IpCount](#cfn-cloudfront-anycastiplist-ipcount)" : Integer,
      "[Name](#cfn-cloudfront-anycastiplist-name)" : String,
      "[Tags](#cfn-cloudfront-anycastiplist-tags)" : Tags
    }
}
```

### YAML
<a name="aws-resource-cloudfront-anycastiplist-syntax.yaml"></a>

```
Type: AWS::CloudFront::AnycastIpList
Properties:
  [IpAddressType](#cfn-cloudfront-anycastiplist-ipaddresstype): String
  [IpamCidrConfigs](#cfn-cloudfront-anycastiplist-ipamcidrconfigs): 
    - IpamCidrConfig
  [IpCount](#cfn-cloudfront-anycastiplist-ipcount): Integer
  [Name](#cfn-cloudfront-anycastiplist-name): String
  [Tags](#cfn-cloudfront-anycastiplist-tags): 
    Tags
```

## Properties
<a name="aws-resource-cloudfront-anycastiplist-properties"></a>

`IpAddressType`  <a name="cfn-cloudfront-anycastiplist-ipaddresstype"></a>
The IP address type for the Anycast static IP list.  
*Required*: No  
*Type*: String  
*Allowed values*: `ipv4 | dualstack`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpamCidrConfigs`  <a name="cfn-cloudfront-anycastiplist-ipamcidrconfigs"></a>
A list of IPAM CIDR configurations that define the IP address ranges, IPAM pools, and associated Anycast IP addresses.  
*Required*: No  
*Type*: Array of [IpamCidrConfig](aws-properties-cloudfront-anycastiplist-ipamcidrconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpCount`  <a name="cfn-cloudfront-anycastiplist-ipcount"></a>
The number of IP addresses in the Anycast static IP list.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-cloudfront-anycastiplist-name"></a>
The name of the Anycast static IP list.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_]{1,64}$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-cloudfront-anycastiplist-tags"></a>
A complex type that contains zero or more `Tag` elements.  
*Required*: No  
*Type*: [Tags](aws-properties-cloudfront-anycastiplist-tags.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-cloudfront-anycastiplist-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-anycastiplist-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Anycast IP list. For example: `aip_7XdPQUqEXAMPLE283z455j`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-anycastiplist-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-anycastiplist-return-values-fn--getatt-fn--getatt"></a>

`ETag`  <a name="ETag-fn::getatt"></a>
A complex type that contains `Tag` key and `Tag` value.

`Id`  <a name="Id-fn::getatt"></a>
The ID of the Anycast static IP list.

`IpamCidrConfigResults`  <a name="IpamCidrConfigResults-fn::getatt"></a>
The results for the IPAM CIDRs that defines a specific IP address range, IPAM pool, and associated Anycast IP address.

# AWS::CloudFront::AnycastIpList AnycastIpList
<a name="aws-properties-cloudfront-anycastiplist-anycastiplist"></a>

An Anycast static IP list. For more information, see [Request Anycast static IPs to use for allowlisting](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/request-static-ips.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-anycastiplist-anycastiplist-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-anycastiplist-anycastiplist-syntax.json"></a>

```
{
  "[AnycastIps](#cfn-cloudfront-anycastiplist-anycastiplist-anycastips)" : [ String, ... ],
  "[Arn](#cfn-cloudfront-anycastiplist-anycastiplist-arn)" : String,
  "[Id](#cfn-cloudfront-anycastiplist-anycastiplist-id)" : String,
  "[IpAddressType](#cfn-cloudfront-anycastiplist-anycastiplist-ipaddresstype)" : String,
  "[IpamCidrConfigResults](#cfn-cloudfront-anycastiplist-anycastiplist-ipamcidrconfigresults)" : [ IpamCidrConfigResult, ... ],
  "[IpCount](#cfn-cloudfront-anycastiplist-anycastiplist-ipcount)" : Integer,
  "[LastModifiedTime](#cfn-cloudfront-anycastiplist-anycastiplist-lastmodifiedtime)" : String,
  "[Name](#cfn-cloudfront-anycastiplist-anycastiplist-name)" : String,
  "[Status](#cfn-cloudfront-anycastiplist-anycastiplist-status)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-anycastiplist-anycastiplist-syntax.yaml"></a>

```
  [AnycastIps](#cfn-cloudfront-anycastiplist-anycastiplist-anycastips): 
    - String
  [Arn](#cfn-cloudfront-anycastiplist-anycastiplist-arn): String
  [Id](#cfn-cloudfront-anycastiplist-anycastiplist-id): String
  [IpAddressType](#cfn-cloudfront-anycastiplist-anycastiplist-ipaddresstype): String
  [IpamCidrConfigResults](#cfn-cloudfront-anycastiplist-anycastiplist-ipamcidrconfigresults): 
    - IpamCidrConfigResult
  [IpCount](#cfn-cloudfront-anycastiplist-anycastiplist-ipcount): Integer
  [LastModifiedTime](#cfn-cloudfront-anycastiplist-anycastiplist-lastmodifiedtime): String
  [Name](#cfn-cloudfront-anycastiplist-anycastiplist-name): String
  [Status](#cfn-cloudfront-anycastiplist-anycastiplist-status): String
```

## Properties
<a name="aws-properties-cloudfront-anycastiplist-anycastiplist-properties"></a>

`AnycastIps`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-anycastips"></a>
The static IP addresses that are allocated to the Anycast static IP list.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Arn`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-arn"></a>
The Amazon Resource Name (ARN) of the Anycast static IP list.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Id`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-id"></a>
The ID of the Anycast static IP list.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpAddressType`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-ipaddresstype"></a>
The IP address type for the Anycast static IP list.  
*Required*: No  
*Type*: String  
*Allowed values*: `ipv4 | dualstack`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpamCidrConfigResults`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-ipamcidrconfigresults"></a>
The results for the IPAM CIDRs that defines a specific IP address range, IPAM pool, and associated Anycast IP address.  
*Required*: No  
*Type*: Array of [IpamCidrConfigResult](aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpCount`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-ipcount"></a>
The number of IP addresses in the Anycast static IP list.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LastModifiedTime`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-lastmodifiedtime"></a>
The last time the Anycast static IP list was modified.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-name"></a>
The name of the Anycast static IP list.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_]{1,64}$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-cloudfront-anycastiplist-anycastiplist-status"></a>
The status of the Anycast static IP list. Valid values: `Deployed`, `Deploying`, or `Failed`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::AnycastIpList IpamCidrConfig
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfig"></a>

Configuration for an IPAM CIDR that defines a specific IP address range, IPAM pool, and associated Anycast IP address.

## Syntax
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfig-syntax.json"></a>

```
{
  "[Cidr](#cfn-cloudfront-anycastiplist-ipamcidrconfig-cidr)" : String,
  "[IpamPoolArn](#cfn-cloudfront-anycastiplist-ipamcidrconfig-ipampoolarn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfig-syntax.yaml"></a>

```
  [Cidr](#cfn-cloudfront-anycastiplist-ipamcidrconfig-cidr): String
  [IpamPoolArn](#cfn-cloudfront-anycastiplist-ipamcidrconfig-ipampoolarn): String
```

## Properties
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfig-properties"></a>

`Cidr`  <a name="cfn-cloudfront-anycastiplist-ipamcidrconfig-cidr"></a>
The CIDR that specifies the IP address range for this IPAM configuration.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpamPoolArn`  <a name="cfn-cloudfront-anycastiplist-ipamcidrconfig-ipampoolarn"></a>
The Amazon Resource Name (ARN) of the IPAM pool that the CIDR block is assigned to.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::AnycastIpList IpamCidrConfigResult
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult"></a>

The result for the IPAM CIDR that defines a specific IP address range, IPAM pool, and associated Anycast IP address.

## Syntax
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult-syntax.json"></a>

```
{
  "[AnycastIp](#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-anycastip)" : String,
  "[Cidr](#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-cidr)" : String,
  "[IpamPoolArn](#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-ipampoolarn)" : String,
  "[Status](#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-status)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult-syntax.yaml"></a>

```
  [AnycastIp](#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-anycastip): String
  [Cidr](#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-cidr): String
  [IpamPoolArn](#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-ipampoolarn): String
  [Status](#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-status): String
```

## Properties
<a name="aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult-properties"></a>

`AnycastIp`  <a name="cfn-cloudfront-anycastiplist-ipamcidrconfigresult-anycastip"></a>
The specified Anycast IP address allocated from the IPAM pool for this CIDR configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Cidr`  <a name="cfn-cloudfront-anycastiplist-ipamcidrconfigresult-cidr"></a>
The CIDR that specifies the IP address range for this IPAM configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpamPoolArn`  <a name="cfn-cloudfront-anycastiplist-ipamcidrconfigresult-ipampoolarn"></a>
The Amazon Resource Name (ARN) of the IPAM pool that the CIDR block is assigned to.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-cloudfront-anycastiplist-ipamcidrconfigresult-status"></a>
The current status of the IPAM CIDR configuration.  
*Required*: No  
*Type*: String  
*Allowed values*: `provisioned | failed-provision | provisioning | deprovisioned | failed-deprovision | deprovisioning | advertised | failed-advertise | advertising | withdrawn | failed-withdraw | withdrawing`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::AnycastIpList Tag
<a name="aws-properties-cloudfront-anycastiplist-tag"></a>

A complex type that contains `Tag` key and `Tag` value.

## Syntax
<a name="aws-properties-cloudfront-anycastiplist-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-anycastiplist-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cloudfront-anycastiplist-tag-key)" : String,
  "[Value](#cfn-cloudfront-anycastiplist-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-anycastiplist-tag-syntax.yaml"></a>

```
  [Key](#cfn-cloudfront-anycastiplist-tag-key): String
  [Value](#cfn-cloudfront-anycastiplist-tag-value): String
```

## Properties
<a name="aws-properties-cloudfront-anycastiplist-tag-properties"></a>

`Key`  <a name="cfn-cloudfront-anycastiplist-tag-key"></a>
A string that contains `Tag` key.  
The string length should be between 1 and 128 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-cloudfront-anycastiplist-tag-value"></a>
A string that contains an optional `Tag` value.  
The string length should be between 0 and 256 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: No  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CloudFront::AnycastIpList Tags
<a name="aws-properties-cloudfront-anycastiplist-tags"></a>

A complex type that contains zero or more `Tag` elements.

## Syntax
<a name="aws-properties-cloudfront-anycastiplist-tags-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-anycastiplist-tags-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-anycastiplist-tags-items)" : [ Tag, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-anycastiplist-tags-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-anycastiplist-tags-items): 
    - Tag
```

## Properties
<a name="aws-properties-cloudfront-anycastiplist-tags-properties"></a>

`Items`  <a name="cfn-cloudfront-anycastiplist-tags-items"></a>
A complex type that contains `Tag` elements.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cloudfront-anycastiplist-tag.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CloudFront::CachePolicy
<a name="aws-resource-cloudfront-cachepolicy"></a>

A cache policy.

When it's attached to a cache behavior, the cache policy determines the following:
+ The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
+ The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use `OriginRequestPolicy`.

## Syntax
<a name="aws-resource-cloudfront-cachepolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-cachepolicy-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::CachePolicy",
  "Properties" : {
      "[CachePolicyConfig](#cfn-cloudfront-cachepolicy-cachepolicyconfig)" : CachePolicyConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-cachepolicy-syntax.yaml"></a>

```
Type: AWS::CloudFront::CachePolicy
Properties:
  [CachePolicyConfig](#cfn-cloudfront-cachepolicy-cachepolicyconfig): 
    CachePolicyConfig
```

## Properties
<a name="aws-resource-cloudfront-cachepolicy-properties"></a>

`CachePolicyConfig`  <a name="cfn-cloudfront-cachepolicy-cachepolicyconfig"></a>
The cache policy configuration.  
*Required*: Yes  
*Type*: [CachePolicyConfig](aws-properties-cloudfront-cachepolicy-cachepolicyconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-cachepolicy-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-cachepolicy-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the cache policy ID. For example: `2766f7b2-75c5-41c6-8f06-bf4303a2f2f5`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-cachepolicy-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-cachepolicy-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The unique identifier for the cache policy. For example: `2766f7b2-75c5-41c6-8f06-bf4303a2f2f5`.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The date and time when the cache policy was last modified.

# AWS::CloudFront::CachePolicy CachePolicyConfig
<a name="aws-properties-cloudfront-cachepolicy-cachepolicyconfig"></a>

A cache policy configuration.

This configuration determines the following:
+ The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
+ The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
**Important**  
If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the `Cache-Control: no-cache`, `no-store`, or `private` directives are present in the origin headers.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use `OriginRequestPolicy`.

## Syntax
<a name="aws-properties-cloudfront-cachepolicy-cachepolicyconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-cachepolicy-cachepolicyconfig-syntax.json"></a>

```
{
  "[Comment](#cfn-cloudfront-cachepolicy-cachepolicyconfig-comment)" : String,
  "[DefaultTTL](#cfn-cloudfront-cachepolicy-cachepolicyconfig-defaultttl)" : Number,
  "[MaxTTL](#cfn-cloudfront-cachepolicy-cachepolicyconfig-maxttl)" : Number,
  "[MinTTL](#cfn-cloudfront-cachepolicy-cachepolicyconfig-minttl)" : Number,
  "[Name](#cfn-cloudfront-cachepolicy-cachepolicyconfig-name)" : String,
  "[ParametersInCacheKeyAndForwardedToOrigin](#cfn-cloudfront-cachepolicy-cachepolicyconfig-parametersincachekeyandforwardedtoorigin)" : ParametersInCacheKeyAndForwardedToOrigin
}
```

### YAML
<a name="aws-properties-cloudfront-cachepolicy-cachepolicyconfig-syntax.yaml"></a>

```
  [Comment](#cfn-cloudfront-cachepolicy-cachepolicyconfig-comment): String
  [DefaultTTL](#cfn-cloudfront-cachepolicy-cachepolicyconfig-defaultttl): Number
  [MaxTTL](#cfn-cloudfront-cachepolicy-cachepolicyconfig-maxttl): Number
  [MinTTL](#cfn-cloudfront-cachepolicy-cachepolicyconfig-minttl): Number
  [Name](#cfn-cloudfront-cachepolicy-cachepolicyconfig-name): String
  [ParametersInCacheKeyAndForwardedToOrigin](#cfn-cloudfront-cachepolicy-cachepolicyconfig-parametersincachekeyandforwardedtoorigin): 
    ParametersInCacheKeyAndForwardedToOrigin
```

## Properties
<a name="aws-properties-cloudfront-cachepolicy-cachepolicyconfig-properties"></a>

`Comment`  <a name="cfn-cloudfront-cachepolicy-cachepolicyconfig-comment"></a>
A comment to describe the cache policy. The comment cannot be longer than 128 characters.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultTTL`  <a name="cfn-cloudfront-cachepolicy-cachepolicyconfig-defaultttl"></a>
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does *not* send `Cache-Control` or `Expires` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.  
The default value for this field is 86400 seconds (one day). If the value of `MinTTL` is more than 86400 seconds, then the default value for this field is the same as the value of `MinTTL`.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxTTL`  <a name="cfn-cloudfront-cachepolicy-cachepolicyconfig-maxttl"></a>
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends `Cache-Control` or `Expires` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.  
The default value for this field is 31536000 seconds (one year). If the value of `MinTTL` or `DefaultTTL` is more than 31536000 seconds, then the default value for this field is the same as the value of `DefaultTTL`.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinTTL`  <a name="cfn-cloudfront-cachepolicy-cachepolicyconfig-minttl"></a>
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-cachepolicy-cachepolicyconfig-name"></a>
A unique name to identify the cache policy.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParametersInCacheKeyAndForwardedToOrigin`  <a name="cfn-cloudfront-cachepolicy-cachepolicyconfig-parametersincachekeyandforwardedtoorigin"></a>
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.  
*Required*: Yes  
*Type*: [ParametersInCacheKeyAndForwardedToOrigin](aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::CachePolicy CookiesConfig
<a name="aws-properties-cloudfront-cachepolicy-cookiesconfig"></a>

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.

## Syntax
<a name="aws-properties-cloudfront-cachepolicy-cookiesconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-cachepolicy-cookiesconfig-syntax.json"></a>

```
{
  "[CookieBehavior](#cfn-cloudfront-cachepolicy-cookiesconfig-cookiebehavior)" : String,
  "[Cookies](#cfn-cloudfront-cachepolicy-cookiesconfig-cookies)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-cachepolicy-cookiesconfig-syntax.yaml"></a>

```
  [CookieBehavior](#cfn-cloudfront-cachepolicy-cookiesconfig-cookiebehavior): String
  [Cookies](#cfn-cloudfront-cachepolicy-cookiesconfig-cookies): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-cachepolicy-cookiesconfig-properties"></a>

`CookieBehavior`  <a name="cfn-cloudfront-cachepolicy-cookiesconfig-cookiebehavior"></a>
Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:  
+ `none` – No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to `none`, any cookies that are listed in an `OriginRequestPolicy`*are* included in origin requests.
+ `whitelist` – Only the cookies in viewer requests that are listed in the `CookieNames` type are included in the cache key and in requests that CloudFront sends to the origin.
+ `allExcept` – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, * **except** * for those that are listed in the `CookieNames` type, which are not included.
+ `all` – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
*Required*: Yes  
*Type*: String  
*Pattern*: `^(none|whitelist|allExcept|all)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Cookies`  <a name="cfn-cloudfront-cachepolicy-cookiesconfig-cookies"></a>
Contains a list of cookie names.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::CachePolicy HeadersConfig
<a name="aws-properties-cloudfront-cachepolicy-headersconfig"></a>

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.

## Syntax
<a name="aws-properties-cloudfront-cachepolicy-headersconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-cachepolicy-headersconfig-syntax.json"></a>

```
{
  "[HeaderBehavior](#cfn-cloudfront-cachepolicy-headersconfig-headerbehavior)" : String,
  "[Headers](#cfn-cloudfront-cachepolicy-headersconfig-headers)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-cachepolicy-headersconfig-syntax.yaml"></a>

```
  [HeaderBehavior](#cfn-cloudfront-cachepolicy-headersconfig-headerbehavior): String
  [Headers](#cfn-cloudfront-cachepolicy-headersconfig-headers): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-cachepolicy-headersconfig-properties"></a>

`HeaderBehavior`  <a name="cfn-cloudfront-cachepolicy-headersconfig-headerbehavior"></a>
Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:  
+ `none` – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to `none`, any headers that are listed in an `OriginRequestPolicy`*are* included in origin requests.
+ `whitelist` – Only the HTTP headers that are listed in the `Headers` type are included in the cache key and in requests that CloudFront sends to the origin.
*Required*: Yes  
*Type*: String  
*Pattern*: `^(none|whitelist)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Headers`  <a name="cfn-cloudfront-cachepolicy-headersconfig-headers"></a>
Contains a list of HTTP header names.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::CachePolicy ParametersInCacheKeyAndForwardedToOrigin
<a name="aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin"></a>

This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use `OriginRequestPolicy`.

## Syntax
<a name="aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-syntax.json"></a>

```
{
  "[CookiesConfig](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-cookiesconfig)" : CookiesConfig,
  "[EnableAcceptEncodingBrotli](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-enableacceptencodingbrotli)" : Boolean,
  "[EnableAcceptEncodingGzip](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-enableacceptencodinggzip)" : Boolean,
  "[HeadersConfig](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-headersconfig)" : HeadersConfig,
  "[QueryStringsConfig](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-querystringsconfig)" : QueryStringsConfig
}
```

### YAML
<a name="aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-syntax.yaml"></a>

```
  [CookiesConfig](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-cookiesconfig): 
    CookiesConfig
  [EnableAcceptEncodingBrotli](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-enableacceptencodingbrotli): Boolean
  [EnableAcceptEncodingGzip](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-enableacceptencodinggzip): Boolean
  [HeadersConfig](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-headersconfig): 
    HeadersConfig
  [QueryStringsConfig](#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-querystringsconfig): 
    QueryStringsConfig
```

## Properties
<a name="aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-properties"></a>

`CookiesConfig`  <a name="cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-cookiesconfig"></a>
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.  
*Required*: Yes  
*Type*: [CookiesConfig](aws-properties-cloudfront-cachepolicy-cookiesconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableAcceptEncodingBrotli`  <a name="cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-enableacceptencodingbrotli"></a>
A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.  
This field is related to the `EnableAcceptEncodingGzip` field. If one or both of these fields is `true`*and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following:  
+ Normalizes the value of the viewer's `Accept-Encoding` header
+ Includes the normalized header in the cache key
+ Includes the normalized header in the request to the origin, if a request is necessary
For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*.  
If you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect.  
If both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableAcceptEncodingGzip`  <a name="cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-enableacceptencodinggzip"></a>
A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.  
This field is related to the `EnableAcceptEncodingBrotli` field. If one or both of these fields is `true`*and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following:  
+ Normalizes the value of the viewer's `Accept-Encoding` header
+ Includes the normalized header in the cache key
+ Includes the normalized header in the request to the origin, if a request is necessary
For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*.  
If you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect.  
If both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HeadersConfig`  <a name="cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-headersconfig"></a>
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.  
*Required*: Yes  
*Type*: [HeadersConfig](aws-properties-cloudfront-cachepolicy-headersconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStringsConfig`  <a name="cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-querystringsconfig"></a>
An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.  
*Required*: Yes  
*Type*: [QueryStringsConfig](aws-properties-cloudfront-cachepolicy-querystringsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::CachePolicy QueryStringsConfig
<a name="aws-properties-cloudfront-cachepolicy-querystringsconfig"></a>

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.

## Syntax
<a name="aws-properties-cloudfront-cachepolicy-querystringsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-cachepolicy-querystringsconfig-syntax.json"></a>

```
{
  "[QueryStringBehavior](#cfn-cloudfront-cachepolicy-querystringsconfig-querystringbehavior)" : String,
  "[QueryStrings](#cfn-cloudfront-cachepolicy-querystringsconfig-querystrings)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-cachepolicy-querystringsconfig-syntax.yaml"></a>

```
  [QueryStringBehavior](#cfn-cloudfront-cachepolicy-querystringsconfig-querystringbehavior): 
    String
  [QueryStrings](#cfn-cloudfront-cachepolicy-querystringsconfig-querystrings): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-cachepolicy-querystringsconfig-properties"></a>

`QueryStringBehavior`  <a name="cfn-cloudfront-cachepolicy-querystringsconfig-querystringbehavior"></a>
Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:  
+ `none` – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to `none`, any query strings that are listed in an `OriginRequestPolicy`*are* included in origin requests.
+ `whitelist` – Only the query strings in viewer requests that are listed in the `QueryStringNames` type are included in the cache key and in requests that CloudFront sends to the origin.
+ `allExcept` – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, * **except** * those that are listed in the `QueryStringNames` type, which are not included.
+ `all` – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
*Required*: Yes  
*Type*: String  
*Pattern*: `^(none|whitelist|allExcept|all)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStrings`  <a name="cfn-cloudfront-cachepolicy-querystringsconfig-querystrings"></a>
Contains a list of query string names.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::CloudFrontOriginAccessIdentity
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity"></a>

The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see [ Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::CloudFrontOriginAccessIdentity",
  "Properties" : {
      "[CloudFrontOriginAccessIdentityConfig](#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig)" : CloudFrontOriginAccessIdentityConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity-syntax.yaml"></a>

```
Type: AWS::CloudFront::CloudFrontOriginAccessIdentity
Properties:
  [CloudFrontOriginAccessIdentityConfig](#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig): 
    CloudFrontOriginAccessIdentityConfig
```

## Properties
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity-properties"></a>

`CloudFrontOriginAccessIdentityConfig`  <a name="cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig"></a>
The current configuration information for the identity.  
*Required*: Yes  
*Type*: [CloudFrontOriginAccessIdentityConfig](aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the origin access identity, such as `E15MNIMTCFKK4C`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The ID for the origin access identity, for example, `E74FTE3AJFJ256A`. 

`S3CanonicalUserId`  <a name="S3CanonicalUserId-fn::getatt"></a>
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: `b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd`.

## Examples
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity--examples"></a>



### Specify the comment for an origin access identity
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity--examples--Specify_the_comment_for_an_origin_access_identity"></a>



#### JSON
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity--examples--Specify_the_comment_for_an_origin_access_identity--json"></a>

```
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Resources": {
        "cloudfrontoriginaccessidentity": {
            "Type": "AWS::CloudFront::CloudFrontOriginAccessIdentity",
            "Properties": {
                "CloudFrontOriginAccessIdentityConfig": {
                    "Comment": "string-value"
                }
            }
        }
    }
}
```

#### YAML
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity--examples--Specify_the_comment_for_an_origin_access_identity--yaml"></a>

```
AWSTemplateFormatVersion: 2010-09-09
Resources:
  cloudfrontoriginaccessidentity:
    Type: AWS::CloudFront::CloudFrontOriginAccessIdentity
    Properties:
      CloudFrontOriginAccessIdentityConfig:
        Comment: string-value
```

## See also
<a name="aws-resource-cloudfront-cloudfrontoriginaccessidentity--seealso"></a>
+ [OriginAccessIdentity](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_S3OriginConfig.html#cloudfront-Type-S3OriginConfig-OriginAccessIdentity) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::CloudFrontOriginAccessIdentity CloudFrontOriginAccessIdentityConfig
<a name="aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig"></a>

Origin access identity configuration. Send a `GET` request to the `/CloudFront API version/CloudFront/identity ID/config` resource.

## Syntax
<a name="aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-syntax.json"></a>

```
{
  "[Comment](#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-comment)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-syntax.yaml"></a>

```
  [Comment](#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-comment): String
```

## Properties
<a name="aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-properties"></a>

`Comment`  <a name="cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-comment"></a>
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig--seealso"></a>
+ [CloudFrontOriginAccessIdentityConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CloudFrontOriginAccessIdentityConfig.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::ConnectionFunction
<a name="aws-resource-cloudfront-connectionfunction"></a>

A connection function.

## Syntax
<a name="aws-resource-cloudfront-connectionfunction-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-connectionfunction-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::ConnectionFunction",
  "Properties" : {
      "[AutoPublish](#cfn-cloudfront-connectionfunction-autopublish)" : Boolean,
      "[ConnectionFunctionCode](#cfn-cloudfront-connectionfunction-connectionfunctioncode)" : String,
      "[ConnectionFunctionConfig](#cfn-cloudfront-connectionfunction-connectionfunctionconfig)" : ConnectionFunctionConfig,
      "[Name](#cfn-cloudfront-connectionfunction-name)" : String,
      "[Tags](#cfn-cloudfront-connectionfunction-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-cloudfront-connectionfunction-syntax.yaml"></a>

```
Type: AWS::CloudFront::ConnectionFunction
Properties:
  [AutoPublish](#cfn-cloudfront-connectionfunction-autopublish): Boolean
  [ConnectionFunctionCode](#cfn-cloudfront-connectionfunction-connectionfunctioncode): String
  [ConnectionFunctionConfig](#cfn-cloudfront-connectionfunction-connectionfunctionconfig): 
    ConnectionFunctionConfig
  [Name](#cfn-cloudfront-connectionfunction-name): String
  [Tags](#cfn-cloudfront-connectionfunction-tags): 
    - Tag
```

## Properties
<a name="aws-resource-cloudfront-connectionfunction-properties"></a>

`AutoPublish`  <a name="cfn-cloudfront-connectionfunction-autopublish"></a>
A flag that determines whether to automatically publish the function to the `LIVE` stage when it’s created. To automatically publish to the `LIVE` stage, set this property to `true`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectionFunctionCode`  <a name="cfn-cloudfront-connectionfunction-connectionfunctioncode"></a>
The code for the connection function.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectionFunctionConfig`  <a name="cfn-cloudfront-connectionfunction-connectionfunctionconfig"></a>
Contains configuration information about a CloudFront function.  
*Required*: Yes  
*Type*: [ConnectionFunctionConfig](aws-properties-cloudfront-connectionfunction-connectionfunctionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-connectionfunction-name"></a>
The connection function name.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z0-9-_]{1,64}`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-cloudfront-connectionfunction-tags"></a>
A complex type that contains zero or more `Tag` elements.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cloudfront-connectionfunction-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-connectionfunction-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-connectionfunction-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-cloudfront-connectionfunction-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-cloudfront-connectionfunction-return-values-fn--getatt-fn--getatt"></a>

`ConnectionFunctionArn`  <a name="ConnectionFunctionArn-fn::getatt"></a>
The connection function Amazon Resource Name (ARN).

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
The connection function created time.

`ETag`  <a name="ETag-fn::getatt"></a>
A complex type that contains `Tag` key and `Tag` value.

`Id`  <a name="Id-fn::getatt"></a>
The connection function ID.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The connection function last modified time.

`Stage`  <a name="Stage-fn::getatt"></a>
The connection function stage.

`Status`  <a name="Status-fn::getatt"></a>
The connection function status.

# AWS::CloudFront::ConnectionFunction ConnectionFunctionConfig
<a name="aws-properties-cloudfront-connectionfunction-connectionfunctionconfig"></a>

Contains configuration information about a CloudFront function.

## Syntax
<a name="aws-properties-cloudfront-connectionfunction-connectionfunctionconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-connectionfunction-connectionfunctionconfig-syntax.json"></a>

```
{
  "[Comment](#cfn-cloudfront-connectionfunction-connectionfunctionconfig-comment)" : String,
  "[KeyValueStoreAssociations](#cfn-cloudfront-connectionfunction-connectionfunctionconfig-keyvaluestoreassociations)" : [ KeyValueStoreAssociation, ... ],
  "[Runtime](#cfn-cloudfront-connectionfunction-connectionfunctionconfig-runtime)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-connectionfunction-connectionfunctionconfig-syntax.yaml"></a>

```
  [Comment](#cfn-cloudfront-connectionfunction-connectionfunctionconfig-comment): String
  [KeyValueStoreAssociations](#cfn-cloudfront-connectionfunction-connectionfunctionconfig-keyvaluestoreassociations): 
    - KeyValueStoreAssociation
  [Runtime](#cfn-cloudfront-connectionfunction-connectionfunctionconfig-runtime): String
```

## Properties
<a name="aws-properties-cloudfront-connectionfunction-connectionfunctionconfig-properties"></a>

`Comment`  <a name="cfn-cloudfront-connectionfunction-connectionfunctionconfig-comment"></a>
A comment to describe the function.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyValueStoreAssociations`  <a name="cfn-cloudfront-connectionfunction-connectionfunctionconfig-keyvaluestoreassociations"></a>
The configuration for the key value store associations.  
*Required*: No  
*Type*: Array of [KeyValueStoreAssociation](aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Runtime`  <a name="cfn-cloudfront-connectionfunction-connectionfunctionconfig-runtime"></a>
The function's runtime environment version.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `cloudfront-js-2.0`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CloudFront::ConnectionFunction KeyValueStoreAssociation
<a name="aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation"></a>

The key value store association.

## Syntax
<a name="aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation-syntax.json"></a>

```
{
  "[KeyValueStoreARN](#cfn-cloudfront-connectionfunction-keyvaluestoreassociation-keyvaluestorearn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation-syntax.yaml"></a>

```
  [KeyValueStoreARN](#cfn-cloudfront-connectionfunction-keyvaluestoreassociation-keyvaluestorearn): String
```

## Properties
<a name="aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation-properties"></a>

`KeyValueStoreARN`  <a name="cfn-cloudfront-connectionfunction-keyvaluestoreassociation-keyvaluestorearn"></a>
The Amazon Resource Name (ARN) of the key value store association.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:aws:cloudfront::[0-9]{12}:key-value-store\/[0-9a-fA-F-]{36}`  
*Minimum*: `0`  
*Maximum*: `85`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ConnectionFunction Tag
<a name="aws-properties-cloudfront-connectionfunction-tag"></a>

A complex type that contains `Tag` key and `Tag` value.

## Syntax
<a name="aws-properties-cloudfront-connectionfunction-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-connectionfunction-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cloudfront-connectionfunction-tag-key)" : String,
  "[Value](#cfn-cloudfront-connectionfunction-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-connectionfunction-tag-syntax.yaml"></a>

```
  [Key](#cfn-cloudfront-connectionfunction-tag-key): String
  [Value](#cfn-cloudfront-connectionfunction-tag-value): String
```

## Properties
<a name="aws-properties-cloudfront-connectionfunction-tag-properties"></a>

`Key`  <a name="cfn-cloudfront-connectionfunction-tag-key"></a>
A string that contains `Tag` key.  
The string length should be between 1 and 128 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-connectionfunction-tag-value"></a>
A string that contains an optional `Tag` value.  
The string length should be between 0 and 256 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ConnectionGroup
<a name="aws-resource-cloudfront-connectiongroup"></a>

The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.

## Syntax
<a name="aws-resource-cloudfront-connectiongroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-connectiongroup-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::ConnectionGroup",
  "Properties" : {
      "[AnycastIpListId](#cfn-cloudfront-connectiongroup-anycastiplistid)" : String,
      "[Enabled](#cfn-cloudfront-connectiongroup-enabled)" : Boolean,
      "[Ipv6Enabled](#cfn-cloudfront-connectiongroup-ipv6enabled)" : Boolean,
      "[Name](#cfn-cloudfront-connectiongroup-name)" : String,
      "[Tags](#cfn-cloudfront-connectiongroup-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-cloudfront-connectiongroup-syntax.yaml"></a>

```
Type: AWS::CloudFront::ConnectionGroup
Properties:
  [AnycastIpListId](#cfn-cloudfront-connectiongroup-anycastiplistid): String
  [Enabled](#cfn-cloudfront-connectiongroup-enabled): Boolean
  [Ipv6Enabled](#cfn-cloudfront-connectiongroup-ipv6enabled): Boolean
  [Name](#cfn-cloudfront-connectiongroup-name): String
  [Tags](#cfn-cloudfront-connectiongroup-tags): 
    - Tag
```

## Properties
<a name="aws-resource-cloudfront-connectiongroup-properties"></a>

`AnycastIpListId`  <a name="cfn-cloudfront-connectiongroup-anycastiplistid"></a>
The ID of the Anycast static IP list.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-cloudfront-connectiongroup-enabled"></a>
Whether the connection group is enabled.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ipv6Enabled`  <a name="cfn-cloudfront-connectiongroup-ipv6enabled"></a>
IPv6 is enabled for the connection group.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-connectiongroup-name"></a>
The name of the connection group.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-cloudfront-connectiongroup-tags"></a>
A complex type that contains zero or more `Tag` elements.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cloudfront-connectiongroup-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-connectiongroup-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-connectiongroup-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-cloudfront-connectiongroup-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-cloudfront-connectiongroup-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the connection group.

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
The date and time when the connection group was created.

`ETag`  <a name="ETag-fn::getatt"></a>
The current version of the connection group.

`Id`  <a name="Id-fn::getatt"></a>
The ID of the connection group.

`IsDefault`  <a name="IsDefault-fn::getatt"></a>
Whether the connection group is the default connection group for the distribution tenants.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The date and time when the connection group was updated.

`RoutingEndpoint`  <a name="RoutingEndpoint-fn::getatt"></a>
The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.

`Status`  <a name="Status-fn::getatt"></a>
The status of the connection group.

# AWS::CloudFront::ConnectionGroup Tag
<a name="aws-properties-cloudfront-connectiongroup-tag"></a>

A complex type that contains `Tag` key and `Tag` value.

## Syntax
<a name="aws-properties-cloudfront-connectiongroup-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-connectiongroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cloudfront-connectiongroup-tag-key)" : String,
  "[Value](#cfn-cloudfront-connectiongroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-connectiongroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-cloudfront-connectiongroup-tag-key): String
  [Value](#cfn-cloudfront-connectiongroup-tag-value): String
```

## Properties
<a name="aws-properties-cloudfront-connectiongroup-tag-properties"></a>

`Key`  <a name="cfn-cloudfront-connectiongroup-tag-key"></a>
A string that contains `Tag` key.  
The string length should be between 1 and 128 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-connectiongroup-tag-value"></a>
A string that contains an optional `Tag` value.  
The string length should be between 0 and 256 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ContinuousDeploymentPolicy
<a name="aws-resource-cloudfront-continuousdeploymentpolicy"></a>

Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution.

After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration.

For more information, see [Using CloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-resource-cloudfront-continuousdeploymentpolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-continuousdeploymentpolicy-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::ContinuousDeploymentPolicy",
  "Properties" : {
      "[ContinuousDeploymentPolicyConfig](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig)" : ContinuousDeploymentPolicyConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-continuousdeploymentpolicy-syntax.yaml"></a>

```
Type: AWS::CloudFront::ContinuousDeploymentPolicy
Properties:
  [ContinuousDeploymentPolicyConfig](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig): 
    ContinuousDeploymentPolicyConfig
```

## Properties
<a name="aws-resource-cloudfront-continuousdeploymentpolicy-properties"></a>

`ContinuousDeploymentPolicyConfig`  <a name="cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig"></a>
Contains the configuration for a continuous deployment policy.  
*Required*: Yes  
*Type*: [ContinuousDeploymentPolicyConfig](aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-continuousdeploymentpolicy-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-continuousdeploymentpolicy-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier for the continuous deployment policy.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-continuousdeploymentpolicy-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-continuousdeploymentpolicy-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The identifier of the cotinuous deployment policy.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The date and time when the continuous deployment policy was last modified.

# AWS::CloudFront::ContinuousDeploymentPolicy ContinuousDeploymentPolicyConfig
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig"></a>

Contains the configuration for a continuous deployment policy.

## Syntax
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-syntax.json"></a>

```
{
  "[Enabled](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-enabled)" : Boolean,
  "[SingleHeaderPolicyConfig](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-singleheaderpolicyconfig)" : SingleHeaderPolicyConfig,
  "[SingleWeightPolicyConfig](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-singleweightpolicyconfig)" : SingleWeightPolicyConfig,
  "[StagingDistributionDnsNames](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-stagingdistributiondnsnames)" : [ String, ... ],
  "[TrafficConfig](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-trafficconfig)" : TrafficConfig,
  "[Type](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-type)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-syntax.yaml"></a>

```
  [Enabled](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-enabled): Boolean
  [SingleHeaderPolicyConfig](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-singleheaderpolicyconfig): 
    SingleHeaderPolicyConfig
  [SingleWeightPolicyConfig](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-singleweightpolicyconfig): 
    SingleWeightPolicyConfig
  [StagingDistributionDnsNames](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-stagingdistributiondnsnames): 
    - String
  [TrafficConfig](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-trafficconfig): 
    TrafficConfig
  [Type](#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-type): String
```

## Properties
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-properties"></a>

`Enabled`  <a name="cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-enabled"></a>
A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is `true`, this policy is enabled and in effect. When this value is `false`, this policy is not enabled and has no effect.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SingleHeaderPolicyConfig`  <a name="cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-singleheaderpolicyconfig"></a>
This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.  
*Required*: No  
*Type*: [SingleHeaderPolicyConfig](aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SingleWeightPolicyConfig`  <a name="cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-singleweightpolicyconfig"></a>
This configuration determines the percentage of HTTP requests that are sent to the staging distribution.  
*Required*: No  
*Type*: [SingleWeightPolicyConfig](aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StagingDistributionDnsNames`  <a name="cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-stagingdistributiondnsnames"></a>
The CloudFront domain name of the staging distribution. For example: `d111111abcdef8.cloudfront.net`.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrafficConfig`  <a name="cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-trafficconfig"></a>
Contains the parameters for routing production traffic from your primary to staging distributions.  
*Required*: No  
*Type*: [TrafficConfig](aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-type"></a>
The type of traffic configuration.  
*Required*: No  
*Type*: String  
*Allowed values*: `SingleWeight | SingleHeader`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ContinuousDeploymentPolicy SessionStickinessConfig
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig"></a>

Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.

## Syntax
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-syntax.json"></a>

```
{
  "[IdleTTL](#cfn-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-idlettl)" : Integer,
  "[MaximumTTL](#cfn-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-maximumttl)" : Integer
}
```

### YAML
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-syntax.yaml"></a>

```
  [IdleTTL](#cfn-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-idlettl): Integer
  [MaximumTTL](#cfn-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-maximumttl): Integer
```

## Properties
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-properties"></a>

`IdleTTL`  <a name="cfn-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-idlettl"></a>
The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `300`  
*Maximum*: `3600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumTTL`  <a name="cfn-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-maximumttl"></a>
The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `300`  
*Maximum*: `3600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ContinuousDeploymentPolicy SingleHeaderConfig
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig"></a>

Determines which HTTP requests are sent to the staging distribution.

## Syntax
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig-syntax.json"></a>

```
{
  "[Header](#cfn-cloudfront-continuousdeploymentpolicy-singleheaderconfig-header)" : String,
  "[Value](#cfn-cloudfront-continuousdeploymentpolicy-singleheaderconfig-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig-syntax.yaml"></a>

```
  [Header](#cfn-cloudfront-continuousdeploymentpolicy-singleheaderconfig-header): String
  [Value](#cfn-cloudfront-continuousdeploymentpolicy-singleheaderconfig-value): String
```

## Properties
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig-properties"></a>

`Header`  <a name="cfn-cloudfront-continuousdeploymentpolicy-singleheaderconfig-header"></a>
The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix `aws-cf-cd-`.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-continuousdeploymentpolicy-singleheaderconfig-value"></a>
The request header value.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1783`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ContinuousDeploymentPolicy SingleHeaderPolicyConfig
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig"></a>

Defines a single header policy for a CloudFront distribution.

**Note**  
This property is legacy. We recommend that you use [TrafficConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html) and specify the [SingleHeaderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleheaderconfig) property instead.

## Syntax
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-syntax.json"></a>

```
{
  "[Header](#cfn-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-header)" : String,
  "[Value](#cfn-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-syntax.yaml"></a>

```
  [Header](#cfn-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-header): String
  [Value](#cfn-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-value): String
```

## Properties
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-properties"></a>

`Header`  <a name="cfn-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-header"></a>
The name of the HTTP header that CloudFront uses to configure for the single header policy.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-value"></a>
Specifies the value to assign to the header for a single header policy.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1783`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ContinuousDeploymentPolicy SingleWeightConfig
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig"></a>

This configuration determines the percentage of HTTP requests that are sent to the staging distribution.

## Syntax
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig-syntax.json"></a>

```
{
  "[SessionStickinessConfig](#cfn-cloudfront-continuousdeploymentpolicy-singleweightconfig-sessionstickinessconfig)" : SessionStickinessConfig,
  "[Weight](#cfn-cloudfront-continuousdeploymentpolicy-singleweightconfig-weight)" : Number
}
```

### YAML
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig-syntax.yaml"></a>

```
  [SessionStickinessConfig](#cfn-cloudfront-continuousdeploymentpolicy-singleweightconfig-sessionstickinessconfig): 
    SessionStickinessConfig
  [Weight](#cfn-cloudfront-continuousdeploymentpolicy-singleweightconfig-weight): Number
```

## Properties
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig-properties"></a>

`SessionStickinessConfig`  <a name="cfn-cloudfront-continuousdeploymentpolicy-singleweightconfig-sessionstickinessconfig"></a>
Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.  
*Required*: No  
*Type*: [SessionStickinessConfig](aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Weight`  <a name="cfn-cloudfront-continuousdeploymentpolicy-singleweightconfig-weight"></a>
The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ContinuousDeploymentPolicy SingleWeightPolicyConfig
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig"></a>

Configure a policy that CloudFront uses to route requests to different origins or use different cache settings, based on the weight assigned to each option.

**Note**  
This property is legacy. We recommend that you use [TrafficConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html) and specify the [SingleWeightConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleweightconfig) property instead.

## Syntax
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-syntax.json"></a>

```
{
  "[SessionStickinessConfig](#cfn-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-sessionstickinessconfig)" : SessionStickinessConfig,
  "[Weight](#cfn-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-weight)" : Number
}
```

### YAML
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-syntax.yaml"></a>

```
  [SessionStickinessConfig](#cfn-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-sessionstickinessconfig): 
    SessionStickinessConfig
  [Weight](#cfn-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-weight): Number
```

## Properties
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-properties"></a>

`SessionStickinessConfig`  <a name="cfn-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-sessionstickinessconfig"></a>
Enable session stickiness for the associated origin or cache settings.  
*Required*: No  
*Type*: [SessionStickinessConfig](aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Weight`  <a name="cfn-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-weight"></a>
The percentage of requests that CloudFront will use to send to an associated origin or cache settings.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ContinuousDeploymentPolicy TrafficConfig
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig"></a>

The traffic configuration of your continuous deployment.

## Syntax
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig-syntax.json"></a>

```
{
  "[SingleHeaderConfig](#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleheaderconfig)" : SingleHeaderConfig,
  "[SingleWeightConfig](#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleweightconfig)" : SingleWeightConfig,
  "[Type](#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-type)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig-syntax.yaml"></a>

```
  [SingleHeaderConfig](#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleheaderconfig): 
    SingleHeaderConfig
  [SingleWeightConfig](#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleweightconfig): 
    SingleWeightConfig
  [Type](#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-type): String
```

## Properties
<a name="aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig-properties"></a>

`SingleHeaderConfig`  <a name="cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleheaderconfig"></a>
Determines which HTTP requests are sent to the staging distribution.  
*Required*: No  
*Type*: [SingleHeaderConfig](aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SingleWeightConfig`  <a name="cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleweightconfig"></a>
Contains the percentage of traffic to send to the staging distribution.  
*Required*: No  
*Type*: [SingleWeightConfig](aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-type"></a>
The type of traffic configuration.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `SingleWeight | SingleHeader`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution
<a name="aws-resource-cloudfront-distribution"></a>

A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

## Syntax
<a name="aws-resource-cloudfront-distribution-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-distribution-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::Distribution",
  "Properties" : {
      "[DistributionConfig](#cfn-cloudfront-distribution-distributionconfig)" : DistributionConfig,
      "[Tags](#cfn-cloudfront-distribution-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-cloudfront-distribution-syntax.yaml"></a>

```
Type: AWS::CloudFront::Distribution
Properties:
  [DistributionConfig](#cfn-cloudfront-distribution-distributionconfig): 
    DistributionConfig
  [Tags](#cfn-cloudfront-distribution-tags): 
    - Tag
```

## Properties
<a name="aws-resource-cloudfront-distribution-properties"></a>

`DistributionConfig`  <a name="cfn-cloudfront-distribution-distributionconfig"></a>
The distribution's configuration.  
*Required*: Yes  
*Type*: [DistributionConfig](aws-properties-cloudfront-distribution-distributionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-cloudfront-distribution-tags"></a>
A complex type that contains zero or more `Tag` elements.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cloudfront-distribution-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-distribution-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-distribution-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the CloudFront distribution ID. For example: `E27LVI50CSW06W`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-distribution-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-distribution-return-values-fn--getatt-fn--getatt"></a>

`DomainName`  <a name="DomainName-fn::getatt"></a>
The domain name of the resource, such as `d111111abcdef8.cloudfront.net`.

`Id`  <a name="Id-fn::getatt"></a>
The distribution's identifier. For example: `E1U5RQF7T870K0`.

## Examples
<a name="aws-resource-cloudfront-distribution--examples"></a>



**Topics**
+ [Create a standard distribution](#aws-resource-cloudfront-distribution--examples--Create_a_standard_distribution)
+ [Create a multi-tenant distribution without a certificate](#aws-resource-cloudfront-distribution--examples--Create_a_multi-tenant_distribution_without_a_certificate)
+ [Create a multi-tenant distribution with a wildcard certificate](#aws-resource-cloudfront-distribution--examples--Create_a_multi-tenant_distribution_with_a_wildcard_certificate)

### Create a standard distribution
<a name="aws-resource-cloudfront-distribution--examples--Create_a_standard_distribution"></a>

The following example specifies a standard distribution and assigns it a single tag.

#### JSON
<a name="aws-resource-cloudfront-distribution--examples--Create_a_standard_distribution--json"></a>

```
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Resources": {
        "cloudfrontdistribution": {
            "Type": "AWS::CloudFront::Distribution",
            "Properties": {
                "DistributionConfig": {
                    "CacheBehaviors": [
                        {
                            "LambdaFunctionAssociations": [
                                {
                                    "EventType": "string-value",
                                    "LambdaFunctionARN": "string-value"
                                }
                            ]
                        }
                    ],
                    "DefaultCacheBehavior": {
                        "LambdaFunctionAssociations": [
                            {
                                "EventType": "string-value",
                                "LambdaFunctionARN": "string-value"
                            }
                        ]
                    },
                    "IPV6Enabled": "boolean-value",
                    "Origins": [
                        {
                            "CustomOriginConfig": {
                                "OriginKeepaliveTimeout": "integer-value",
                                "OriginReadTimeout": "integer-value"
                            }
                        }
                    ]
                },
                "Tags": [
                    {
                        "Key": "string-value",
                        "Value": "string-value"
                    }
                ]
            }
        }
    }
}
```

#### YAML
<a name="aws-resource-cloudfront-distribution--examples--Create_a_standard_distribution--yaml"></a>

```
AWSTemplateFormatVersion: 2010-09-09
Resources:
  cloudfrontdistribution:
    Type: AWS::CloudFront::Distribution
    Properties:
      DistributionConfig:
        CacheBehaviors:
          - LambdaFunctionAssociations:
              - EventType: string-value
                LambdaFunctionARN: string-value
        DefaultCacheBehavior:
          LambdaFunctionAssociations:
            - EventType: string-value
              LambdaFunctionARN: string-value
        IPV6Enabled: boolean-value
        Origins:
          - CustomOriginConfig:
              OriginKeepaliveTimeout: integer-value
              OriginReadTimeout: integer-value
      Tags:
        - Key: string-value
          Value: string-value
```

### Create a multi-tenant distribution without a certificate
<a name="aws-resource-cloudfront-distribution--examples--Create_a_multi-tenant_distribution_without_a_certificate"></a>

The following example specifies a basic multi-tenant distribution without a certificate.

#### JSON
<a name="aws-resource-cloudfront-distribution--examples--Create_a_multi-tenant_distribution_without_a_certificate--json"></a>

```
{
  "Resources": {
    "MyMultiTenantDistribution": {
      "Type": "AWS::CloudFront::Distribution",
      "Properties": {
        "DistributionConfig": {
          "ConnectionMode": "tenant-only",
          "TenantConfig": {
            "ParameterDefinitions": [
              {
                "Name": "tenantName",
                "Definition": {
                  "StringSchema": {
                    "Comment": "Tenant name",
                    "DefaultValue": "root",
                    "Required": false
                  }
                }
              }
            ]
          },
          "DefaultCacheBehavior": {
            "TargetOriginId": "MyBucket.Arn",
            "ViewerProtocolPolicy": "allow-all",
            "AllowedMethods": [
              "GET",
              "HEAD"
            ],
            "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6"
          },
          "Enabled": true,
          "Origins": [
            {
              "DomainName": "MyBucket.RegionalDomainName",
              "Id": "MyBucket.Arn",
              "OriginPath": "/{{tenantName}}",
              "S3OriginConfig": {
                "OriginAccessIdentity": ""
              }
            }
          ]
        }
      }
    },
    "MyBucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "amzn-s3-demo-bucket",
        "BucketEncryption": {
          "ServerSideEncryptionConfiguration": [
            {
              "ServerSideEncryptionByDefault": {
                "SSEAlgorithm": "aws:kms",
                "KMSMasterKeyID": "alias/aws/s3"
              }
            }
          ]
        },
        "PublicAccessBlockConfiguration": {
          "IgnorePublicAcls": true,
          "RestrictPublicBuckets": true
        }
      }
    },
    "MyBucketBucketPolicy": {
      "Type": "AWS::S3::BucketPolicy",
      "Properties": {
        "Bucket": "MyBucket",
        "PolicyDocument": {
          "Id": "RequireEncryptionInTransit",
          "Version": "2012-10-17",		 	 	 
          "Statement": [
            {
              "Principal": "*",
              "Action": "*",
              "Effect": "Deny",
              "Resource": [
                "MyBucket.Arn",
                "${MyBucket.Arn}/*"
              ],
              "Condition": {
                "Bool": {
                  "aws:SecureTransport": "false"
                }
              }
            }
          ]
        }
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-cloudfront-distribution--examples--Create_a_multi-tenant_distribution_without_a_certificate--yaml"></a>

```
Resources:
  MyMultiTenantDistribution:
    Type: AWS::CloudFront::Distribution
    Properties:
      DistributionConfig:
        ConnectionMode: tenant-only
        TenantConfig: 
          ParameterDefinitions:
            - Name: tenantName
              Definition:
                StringSchema:
                  Comment: "Tenant name"
                  DefaultValue: "root"
                  Required: false
        DefaultCacheBehavior:
          TargetOriginId: !GetAtt MyBucket.Arn
          ViewerProtocolPolicy: allow-all
          AllowedMethods:
            - GET
            - HEAD
          CachePolicyId: 658327ea-f89d-4fab-a63d-7e88639e58f6 # CachingOptimized PolicyId
        Enabled: true
        Origins:
          - DomainName: !GetAtt MyBucket.RegionalDomainName
            Id: !GetAtt MyBucket.Arn
            OriginPath: "/{{tenantName}}"
            S3OriginConfig:
              OriginAccessIdentity: ""
  
  MyBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: amzn-s3-demo-bucket
      BucketEncryption:
        ServerSideEncryptionConfiguration:
          - ServerSideEncryptionByDefault:
              SSEAlgorithm: aws:kms
              KMSMasterKeyID: alias/aws/s3
      PublicAccessBlockConfiguration:
        IgnorePublicAcls: true
        RestrictPublicBuckets: true
  MyBucketBucketPolicy:
    Type: AWS::S3::BucketPolicy
    Properties:
      Bucket: !Ref MyBucket
      PolicyDocument:
        Id: RequireEncryptionInTransit
        Version: '2012-10-17		 	 	 '
        Statement:
          - Principal: '*'
            Action: '*'
            Effect: Deny
            Resource:
              - !GetAtt MyBucket.Arn
              - !Sub ${MyBucket.Arn}/*
            Condition:
              Bool:
                aws:SecureTransport: 'false'
```

### Create a multi-tenant distribution with a wildcard certificate
<a name="aws-resource-cloudfront-distribution--examples--Create_a_multi-tenant_distribution_with_a_wildcard_certificate"></a>

The following example specifies a basic multi-tenant distribution with a wildcard certificate.

#### JSON
<a name="aws-resource-cloudfront-distribution--examples--Create_a_multi-tenant_distribution_with_a_wildcard_certificate--json"></a>

```
{
  "Resources": {
    "MyMultiTenantDistribution": {
      "Type": "AWS::CloudFront::Distribution",
      "Properties": {
        "DistributionConfig": {
          "ConnectionMode": "tenant-only",
          "ViewerCertificate": {
            "AcmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/1954f095-11b6-4daf-9952-0c308a00944d",
            "SslSupportMethod": "sni-only"
          },
          "TenantConfig": {
            "ParameterDefinitions": [
              {
                "Name": "tenantName",
                "Definition": {
                  "StringSchema": {
                    "Comment": "Tenant name",
                    "DefaultValue": "root",
                    "Required": false
                  }
                }
              }
            ]
          },
          "DefaultCacheBehavior": {
            "TargetOriginId": "MyBucket.Arn",
            "ViewerProtocolPolicy": "allow-all",
            "AllowedMethods": [
              "GET",
              "HEAD"
            ],
            "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6"
          },
          "Enabled": true,
          "Origins": [
            {
              "DomainName": "MyBucket.RegionalDomainName",
              "Id": "MyBucket.Arn",
              "OriginPath": "/{{tenantName}}",
              "S3OriginConfig": {
                "OriginAccessIdentity": ""
              }
            }
          ]
        }
      }
    },
    "MyBucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "amzn-s3-demo-bucket",
        "BucketEncryption": {
          "ServerSideEncryptionConfiguration": [
            {
              "ServerSideEncryptionByDefault": {
                "SSEAlgorithm": "aws:kms",
                "KMSMasterKeyID": "alias/aws/s3"
              }
            }
          ]
        },
        "PublicAccessBlockConfiguration": {
          "IgnorePublicAcls": true,
          "RestrictPublicBuckets": true
        }
      }
    },
    "MyBucketBucketPolicy": {
      "Type": "AWS::S3::BucketPolicy",
      "Properties": {
        "Bucket": "MyBucket",
        "PolicyDocument": {
          "Id": "RequireEncryptionInTransit",
          "Version": "2012-10-17",		 	 	 
          "Statement": [
            {
              "Principal": "*",
              "Action": "*",
              "Effect": "Deny",
              "Resource": [
                "MyBucket.Arn",
                "${MyBucket.Arn}/*"
              ],
              "Condition": {
                "Bool": {
                  "aws:SecureTransport": "false"
                }
              }
            }
          ]
        }
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-cloudfront-distribution--examples--Create_a_multi-tenant_distribution_with_a_wildcard_certificate--yaml"></a>

```
Resources:
  MyMultiTenantDistribution:
    Type: AWS::CloudFront::Distribution
    Properties:
      DistributionConfig:
        ConnectionMode: tenant-only
        ViewerCertificate:
          AcmCertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/1954f095-11b6-4daf-9952-0c308a00944d
          SslSupportMethod: sni-only
        TenantConfig: 
          ParameterDefinitions:
            - Name: tenantName
              Definition:
                StringSchema:
                  Comment: "Tenant name"
                  DefaultValue: "root"
                  Required: false
        DefaultCacheBehavior:
          TargetOriginId: !GetAtt MyBucket.Arn
          ViewerProtocolPolicy: allow-all
          AllowedMethods:
            - GET
            - HEAD
          CachePolicyId: 658327ea-f89d-4fab-a63d-7e88639e58f6 # CachingOptimized PolicyId
        Enabled: true
        Origins:
          - DomainName: !GetAtt MyBucket.RegionalDomainName
            Id: !GetAtt MyBucket.Arn
            OriginPath: "/{{tenantName}}"
            S3OriginConfig:
              OriginAccessIdentity: ""
  
  MyBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: amzn-s3-demo-bucket
      BucketEncryption:
        ServerSideEncryptionConfiguration:
          - ServerSideEncryptionByDefault:
              SSEAlgorithm: aws:kms
              KMSMasterKeyID: alias/aws/s3
      PublicAccessBlockConfiguration:
        IgnorePublicAcls: true
        RestrictPublicBuckets: true
  MyBucketBucketPolicy:
    Type: AWS::S3::BucketPolicy
    Properties:
      Bucket: !Ref MyBucket
      PolicyDocument:
        Id: RequireEncryptionInTransit
        Version: '2012-10-17		 	 	 '
        Statement:
          - Principal: '*'
            Action: '*'
            Effect: Deny
            Resource:
              - !GetAtt MyBucket.Arn
              - !Sub ${MyBucket.Arn}/*
            Condition:
              Bool:
                aws:SecureTransport: 'false'
```

## See also
<a name="aws-resource-cloudfront-distribution--seealso"></a>
+ [CreateDistribution](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html) in the *Amazon CloudFront API Reference*
+ [Understand how multi-tenant distributions work](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html) in the *Amazon CloudFront Developer Guide*



# AWS::CloudFront::Distribution CacheBehavior
<a name="aws-properties-cloudfront-distribution-cachebehavior"></a>

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see [Quotas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) in the *Amazon CloudFront Developer Guide*.

If you don't want to specify any cache behaviors, include only an empty `CacheBehaviors` element. Don't specify an empty individual `CacheBehavior` element, because this is invalid. For more information, see [CacheBehaviors](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html). 

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty `CacheBehaviors` element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

**Important**  
If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the `Cache-Control: no-cache`, `no-store`, or `private` directives are present in the origin headers.

For more information about cache behaviors, see [Cache Behavior Settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-distribution-cachebehavior-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-cachebehavior-syntax.json"></a>

```
{
  "[AllowedMethods](#cfn-cloudfront-distribution-cachebehavior-allowedmethods)" : [ String, ... ],
  "[CachedMethods](#cfn-cloudfront-distribution-cachebehavior-cachedmethods)" : [ String, ... ],
  "[CachePolicyId](#cfn-cloudfront-distribution-cachebehavior-cachepolicyid)" : String,
  "[Compress](#cfn-cloudfront-distribution-cachebehavior-compress)" : Boolean,
  "[DefaultTTL](#cfn-cloudfront-distribution-cachebehavior-defaultttl)" : Number,
  "[FieldLevelEncryptionId](#cfn-cloudfront-distribution-cachebehavior-fieldlevelencryptionid)" : String,
  "[ForwardedValues](#cfn-cloudfront-distribution-cachebehavior-forwardedvalues)" : ForwardedValues,
  "[FunctionAssociations](#cfn-cloudfront-distribution-cachebehavior-functionassociations)" : [ FunctionAssociation, ... ],
  "[GrpcConfig](#cfn-cloudfront-distribution-cachebehavior-grpcconfig)" : GrpcConfig,
  "[LambdaFunctionAssociations](#cfn-cloudfront-distribution-cachebehavior-lambdafunctionassociations)" : [ LambdaFunctionAssociation, ... ],
  "[MaxTTL](#cfn-cloudfront-distribution-cachebehavior-maxttl)" : Number,
  "[MinTTL](#cfn-cloudfront-distribution-cachebehavior-minttl)" : Number,
  "[OriginRequestPolicyId](#cfn-cloudfront-distribution-cachebehavior-originrequestpolicyid)" : String,
  "[PathPattern](#cfn-cloudfront-distribution-cachebehavior-pathpattern)" : String,
  "[RealtimeLogConfigArn](#cfn-cloudfront-distribution-cachebehavior-realtimelogconfigarn)" : String,
  "[ResponseHeadersPolicyId](#cfn-cloudfront-distribution-cachebehavior-responseheaderspolicyid)" : String,
  "[SmoothStreaming](#cfn-cloudfront-distribution-cachebehavior-smoothstreaming)" : Boolean,
  "[TargetOriginId](#cfn-cloudfront-distribution-cachebehavior-targetoriginid)" : String,
  "[TrustedKeyGroups](#cfn-cloudfront-distribution-cachebehavior-trustedkeygroups)" : [ String, ... ],
  "[TrustedSigners](#cfn-cloudfront-distribution-cachebehavior-trustedsigners)" : [ String, ... ],
  "[ViewerProtocolPolicy](#cfn-cloudfront-distribution-cachebehavior-viewerprotocolpolicy)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-cachebehavior-syntax.yaml"></a>

```
  [AllowedMethods](#cfn-cloudfront-distribution-cachebehavior-allowedmethods): 
    - String
  [CachedMethods](#cfn-cloudfront-distribution-cachebehavior-cachedmethods): 
    - String
  [CachePolicyId](#cfn-cloudfront-distribution-cachebehavior-cachepolicyid): String
  [Compress](#cfn-cloudfront-distribution-cachebehavior-compress): Boolean
  [DefaultTTL](#cfn-cloudfront-distribution-cachebehavior-defaultttl): Number
  [FieldLevelEncryptionId](#cfn-cloudfront-distribution-cachebehavior-fieldlevelencryptionid): String
  [ForwardedValues](#cfn-cloudfront-distribution-cachebehavior-forwardedvalues): 
    ForwardedValues
  [FunctionAssociations](#cfn-cloudfront-distribution-cachebehavior-functionassociations): 
    - FunctionAssociation
  [GrpcConfig](#cfn-cloudfront-distribution-cachebehavior-grpcconfig): 
    GrpcConfig
  [LambdaFunctionAssociations](#cfn-cloudfront-distribution-cachebehavior-lambdafunctionassociations): 
    - LambdaFunctionAssociation
  [MaxTTL](#cfn-cloudfront-distribution-cachebehavior-maxttl): Number
  [MinTTL](#cfn-cloudfront-distribution-cachebehavior-minttl): Number
  [OriginRequestPolicyId](#cfn-cloudfront-distribution-cachebehavior-originrequestpolicyid): String
  [PathPattern](#cfn-cloudfront-distribution-cachebehavior-pathpattern): String
  [RealtimeLogConfigArn](#cfn-cloudfront-distribution-cachebehavior-realtimelogconfigarn): String
  [ResponseHeadersPolicyId](#cfn-cloudfront-distribution-cachebehavior-responseheaderspolicyid): String
  [SmoothStreaming](#cfn-cloudfront-distribution-cachebehavior-smoothstreaming): Boolean
  [TargetOriginId](#cfn-cloudfront-distribution-cachebehavior-targetoriginid): String
  [TrustedKeyGroups](#cfn-cloudfront-distribution-cachebehavior-trustedkeygroups): 
    - String
  [TrustedSigners](#cfn-cloudfront-distribution-cachebehavior-trustedsigners): 
    - String
  [ViewerProtocolPolicy](#cfn-cloudfront-distribution-cachebehavior-viewerprotocolpolicy): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-cachebehavior-properties"></a>

`AllowedMethods`  <a name="cfn-cloudfront-distribution-cachebehavior-allowedmethods"></a>
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` and `HEAD` requests.
+ CloudFront forwards only `GET`, `HEAD`, and `OPTIONS` requests.
+ CloudFront forwards `GET, HEAD, OPTIONS, PUT, PATCH, POST`, and `DELETE` 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.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CachedMethods`  <a name="cfn-cloudfront-distribution-cachebehavior-cachedmethods"></a>
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` and `HEAD` requests.
+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` 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.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CachePolicyId`  <a name="cfn-cloudfront-distribution-cachebehavior-cachepolicyid"></a>
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.  
A `CacheBehavior` must include either a `CachePolicyId` or `ForwardedValues`. We recommend that you use a `CachePolicyId`.  
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Compress`  <a name="cfn-cloudfront-distribution-cachebehavior-compress"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultTTL`  <a name="cfn-cloudfront-distribution-cachebehavior-defaultttl"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) 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 as `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FieldLevelEncryptionId`  <a name="cfn-cloudfront-distribution-cachebehavior-fieldlevelencryptionid"></a>
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.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ForwardedValues`  <a name="cfn-cloudfront-distribution-cachebehavior-forwardedvalues"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.  
A `CacheBehavior` must include either a `CachePolicyId` or `ForwardedValues`. We recommend that you use a `CachePolicyId`.  
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.  
*Required*: Conditional  
*Type*: [ForwardedValues](aws-properties-cloudfront-distribution-forwardedvalues.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FunctionAssociations`  <a name="cfn-cloudfront-distribution-cachebehavior-functionassociations"></a>
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.  
*Required*: No  
*Type*: Array of [FunctionAssociation](aws-properties-cloudfront-distribution-functionassociation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GrpcConfig`  <a name="cfn-cloudfront-distribution-cachebehavior-grpcconfig"></a>
The gRPC configuration for your cache behavior.  
*Required*: No  
*Type*: [GrpcConfig](aws-properties-cloudfront-distribution-grpcconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LambdaFunctionAssociations`  <a name="cfn-cloudfront-distribution-cachebehavior-lambdafunctionassociations"></a>
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.  
*Required*: No  
*Type*: Array of [LambdaFunctionAssociation](aws-properties-cloudfront-distribution-lambdafunctionassociation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxTTL`  <a name="cfn-cloudfront-distribution-cachebehavior-maxttl"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) 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 as `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinTTL`  <a name="cfn-cloudfront-distribution-cachebehavior-minttl"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) 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)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the * Amazon CloudFront Developer Guide*.  
You must specify `0` for `MinTTL` if you configure CloudFront to forward all headers to your origin (under `Headers`, if you specify `1` for `Quantity` and `*` for `Name`).  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginRequestPolicyId`  <a name="cfn-cloudfront-distribution-cachebehavior-originrequestpolicyid"></a>
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PathPattern`  <a name="cfn-cloudfront-distribution-cachebehavior-pathpattern"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the * Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RealtimeLogConfigArn`  <a name="cfn-cloudfront-distribution-cachebehavior-realtimelogconfigarn"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResponseHeadersPolicyId`  <a name="cfn-cloudfront-distribution-cachebehavior-responseheaderspolicyid"></a>
The identifier for a response headers policy.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SmoothStreaming`  <a name="cfn-cloudfront-distribution-cachebehavior-smoothstreaming"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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, specify `false`. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetOriginId`  <a name="cfn-cloudfront-distribution-cachebehavior-targetoriginid"></a>
The value of `ID` for the origin that you want CloudFront to route requests to when they match this cache behavior.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrustedKeyGroups`  <a name="cfn-cloudfront-distribution-cachebehavior-trustedkeygroups"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrustedSigners`  <a name="cfn-cloudfront-distribution-cachebehavior-trustedsigners"></a>
We recommend using `TrustedKeyGroups` instead of `TrustedSigners`.
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ViewerProtocolPolicy`  <a name="cfn-cloudfront-distribution-cachebehavior-viewerprotocolpolicy"></a>
The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`. 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.
*Required*: Yes  
*Type*: String  
*Allowed values*: `allow-all | https-only | redirect-to-https`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-cachebehavior--seealso"></a>
+ [CacheBehavior](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehavior.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution ConnectionFunctionAssociation
<a name="aws-properties-cloudfront-distribution-connectionfunctionassociation"></a>

A connection function association.

## Syntax
<a name="aws-properties-cloudfront-distribution-connectionfunctionassociation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-connectionfunctionassociation-syntax.json"></a>

```
{
  "[Id](#cfn-cloudfront-distribution-connectionfunctionassociation-id)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-connectionfunctionassociation-syntax.yaml"></a>

```
  [Id](#cfn-cloudfront-distribution-connectionfunctionassociation-id): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-connectionfunctionassociation-properties"></a>

`Id`  <a name="cfn-cloudfront-distribution-connectionfunctionassociation-id"></a>
The association's ID.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution Cookies
<a name="aws-properties-cloudfront-distribution-cookies"></a>

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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-distribution-cookies-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-cookies-syntax.json"></a>

```
{
  "[Forward](#cfn-cloudfront-distribution-cookies-forward)" : String,
  "[WhitelistedNames](#cfn-cloudfront-distribution-cookies-whitelistednames)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-cookies-syntax.yaml"></a>

```
  [Forward](#cfn-cloudfront-distribution-cookies-forward): String
  [WhitelistedNames](#cfn-cloudfront-distribution-cookies-whitelistednames): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-distribution-cookies-properties"></a>

`Forward`  <a name="cfn-cloudfront-distribution-cookies-forward"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) 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 the `Forward` element.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | whitelist | all`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WhitelistedNames`  <a name="cfn-cloudfront-distribution-cookies-whitelistednames"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.  
Required if you specify `whitelist` for the value of `Forward`. 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 specify `all` or `none` for the value of `Forward`, omit `WhitelistedNames`. If you change the value of `Forward` from `whitelist` to `all` or `none` and you don't delete the `WhitelistedNames` 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](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *AWS General Reference*.  
*Required*: Conditional  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-cookies--seealso"></a>
+ [CookiePreference](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CookiePreference.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution CustomErrorResponse
<a name="aws-properties-cloudfront-distribution-customerrorresponse"></a>

A complex type that controls:
+ 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-distribution-customerrorresponse-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-customerrorresponse-syntax.json"></a>

```
{
  "[ErrorCachingMinTTL](#cfn-cloudfront-distribution-customerrorresponse-errorcachingminttl)" : Number,
  "[ErrorCode](#cfn-cloudfront-distribution-customerrorresponse-errorcode)" : Integer,
  "[ResponseCode](#cfn-cloudfront-distribution-customerrorresponse-responsecode)" : Integer,
  "[ResponsePagePath](#cfn-cloudfront-distribution-customerrorresponse-responsepagepath)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-customerrorresponse-syntax.yaml"></a>

```
  [ErrorCachingMinTTL](#cfn-cloudfront-distribution-customerrorresponse-errorcachingminttl): Number
  [ErrorCode](#cfn-cloudfront-distribution-customerrorresponse-errorcode): Integer
  [ResponseCode](#cfn-cloudfront-distribution-customerrorresponse-responsecode): Integer
  [ResponsePagePath](#cfn-cloudfront-distribution-customerrorresponse-responsepagepath): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-customerrorresponse-properties"></a>

`ErrorCachingMinTTL`  <a name="cfn-cloudfront-distribution-customerrorresponse-errorcachingminttl"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ErrorCode`  <a name="cfn-cloudfront-distribution-customerrorresponse-errorcode"></a>
The HTTP status code for which you want to specify a custom error page and/or a caching duration.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResponseCode`  <a name="cfn-cloudfront-distribution-customerrorresponse-responsecode"></a>
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` or `500` as the `ResponseCode` 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 for `ResponsePagePath`.  
*Required*: Conditional  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResponsePagePath`  <a name="cfn-cloudfront-distribution-customerrorresponse-responsepagepath"></a>
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 the `ID` element for the origin that contains your custom error pages.
If you specify a value for `ResponsePagePath`, you must also specify a value for `ResponseCode`.  
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.  
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-customerrorresponse--seealso"></a>
+ [CustomErrorResponse](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CustomErrorResponse.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution CustomOriginConfig
<a name="aws-properties-cloudfront-distribution-customoriginconfig"></a>

A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)*is* a custom origin.

## Syntax
<a name="aws-properties-cloudfront-distribution-customoriginconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-customoriginconfig-syntax.json"></a>

```
{
  "[HTTPPort](#cfn-cloudfront-distribution-customoriginconfig-httpport)" : Integer,
  "[HTTPSPort](#cfn-cloudfront-distribution-customoriginconfig-httpsport)" : Integer,
  "[IpAddressType](#cfn-cloudfront-distribution-customoriginconfig-ipaddresstype)" : String,
  "[OriginKeepaliveTimeout](#cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout)" : Integer,
  "[OriginMtlsConfig](#cfn-cloudfront-distribution-customoriginconfig-originmtlsconfig)" : OriginMtlsConfig,
  "[OriginProtocolPolicy](#cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy)" : String,
  "[OriginReadTimeout](#cfn-cloudfront-distribution-customoriginconfig-originreadtimeout)" : Integer,
  "[OriginSSLProtocols](#cfn-cloudfront-distribution-customoriginconfig-originsslprotocols)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-customoriginconfig-syntax.yaml"></a>

```
  [HTTPPort](#cfn-cloudfront-distribution-customoriginconfig-httpport): Integer
  [HTTPSPort](#cfn-cloudfront-distribution-customoriginconfig-httpsport): Integer
  [IpAddressType](#cfn-cloudfront-distribution-customoriginconfig-ipaddresstype): String
  [OriginKeepaliveTimeout](#cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout): Integer
  [OriginMtlsConfig](#cfn-cloudfront-distribution-customoriginconfig-originmtlsconfig): 
    OriginMtlsConfig
  [OriginProtocolPolicy](#cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy): String
  [OriginReadTimeout](#cfn-cloudfront-distribution-customoriginconfig-originreadtimeout): Integer
  [OriginSSLProtocols](#cfn-cloudfront-distribution-customoriginconfig-originsslprotocols): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-distribution-customoriginconfig-properties"></a>

`HTTPPort`  <a name="cfn-cloudfront-distribution-customoriginconfig-httpport"></a>
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HTTPSPort`  <a name="cfn-cloudfront-distribution-customoriginconfig-httpsport"></a>
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpAddressType`  <a name="cfn-cloudfront-distribution-customoriginconfig-ipaddresstype"></a>
Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose `dualstack` to help optimize reliability.  
*Required*: No  
*Type*: String  
*Allowed values*: `ipv4 | ipv6 | dualstack`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginKeepaliveTimeout`  <a name="cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout"></a>
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.  
For more information, see [Keep-alive timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginMtlsConfig`  <a name="cfn-cloudfront-distribution-customoriginconfig-originmtlsconfig"></a>
Configures mutual TLS authentication between CloudFront and your origin server.  
*Required*: No  
*Type*: [OriginMtlsConfig](aws-properties-cloudfront-distribution-originmtlsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginProtocolPolicy`  <a name="cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy"></a>
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.
*Required*: Yes  
*Type*: String  
*Allowed values*: `http-only | match-viewer | https-only`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginReadTimeout`  <a name="cfn-cloudfront-distribution-customoriginconfig-originreadtimeout"></a>
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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.  
For more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginSSLProtocols`  <a name="cfn-cloudfront-distribution-customoriginconfig-originsslprotocols"></a>
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include `SSLv3`, `TLSv1`, `TLSv1.1`, and `TLSv1.2`.  
For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-customoriginconfig--seealso"></a>
+ [CustomOriginConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CustomOriginConfig.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution DefaultCacheBehavior
<a name="aws-properties-cloudfront-distribution-defaultcachebehavior"></a>

A complex type that describes the default cache behavior if you don't specify a `CacheBehavior` element or if request URLs don't match any of the values of `PathPattern` in `CacheBehavior` elements. You must create exactly one default cache behavior.

**Important**  
If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the `Cache-Control: no-cache`, `no-store`, or `private` directives are present in the origin headers.

## Syntax
<a name="aws-properties-cloudfront-distribution-defaultcachebehavior-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-defaultcachebehavior-syntax.json"></a>

```
{
  "[AllowedMethods](#cfn-cloudfront-distribution-defaultcachebehavior-allowedmethods)" : [ String, ... ],
  "[CachedMethods](#cfn-cloudfront-distribution-defaultcachebehavior-cachedmethods)" : [ String, ... ],
  "[CachePolicyId](#cfn-cloudfront-distribution-defaultcachebehavior-cachepolicyid)" : String,
  "[Compress](#cfn-cloudfront-distribution-defaultcachebehavior-compress)" : Boolean,
  "[DefaultTTL](#cfn-cloudfront-distribution-defaultcachebehavior-defaultttl)" : Number,
  "[FieldLevelEncryptionId](#cfn-cloudfront-distribution-defaultcachebehavior-fieldlevelencryptionid)" : String,
  "[ForwardedValues](#cfn-cloudfront-distribution-defaultcachebehavior-forwardedvalues)" : ForwardedValues,
  "[FunctionAssociations](#cfn-cloudfront-distribution-defaultcachebehavior-functionassociations)" : [ FunctionAssociation, ... ],
  "[GrpcConfig](#cfn-cloudfront-distribution-defaultcachebehavior-grpcconfig)" : GrpcConfig,
  "[LambdaFunctionAssociations](#cfn-cloudfront-distribution-defaultcachebehavior-lambdafunctionassociations)" : [ LambdaFunctionAssociation, ... ],
  "[MaxTTL](#cfn-cloudfront-distribution-defaultcachebehavior-maxttl)" : Number,
  "[MinTTL](#cfn-cloudfront-distribution-defaultcachebehavior-minttl)" : Number,
  "[OriginRequestPolicyId](#cfn-cloudfront-distribution-defaultcachebehavior-originrequestpolicyid)" : String,
  "[RealtimeLogConfigArn](#cfn-cloudfront-distribution-defaultcachebehavior-realtimelogconfigarn)" : String,
  "[ResponseHeadersPolicyId](#cfn-cloudfront-distribution-defaultcachebehavior-responseheaderspolicyid)" : String,
  "[SmoothStreaming](#cfn-cloudfront-distribution-defaultcachebehavior-smoothstreaming)" : Boolean,
  "[TargetOriginId](#cfn-cloudfront-distribution-defaultcachebehavior-targetoriginid)" : String,
  "[TrustedKeyGroups](#cfn-cloudfront-distribution-defaultcachebehavior-trustedkeygroups)" : [ String, ... ],
  "[TrustedSigners](#cfn-cloudfront-distribution-defaultcachebehavior-trustedsigners)" : [ String, ... ],
  "[ViewerProtocolPolicy](#cfn-cloudfront-distribution-defaultcachebehavior-viewerprotocolpolicy)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-defaultcachebehavior-syntax.yaml"></a>

```
  [AllowedMethods](#cfn-cloudfront-distribution-defaultcachebehavior-allowedmethods): 
    - String
  [CachedMethods](#cfn-cloudfront-distribution-defaultcachebehavior-cachedmethods): 
    - String
  [CachePolicyId](#cfn-cloudfront-distribution-defaultcachebehavior-cachepolicyid): String
  [Compress](#cfn-cloudfront-distribution-defaultcachebehavior-compress): Boolean
  [DefaultTTL](#cfn-cloudfront-distribution-defaultcachebehavior-defaultttl): Number
  [FieldLevelEncryptionId](#cfn-cloudfront-distribution-defaultcachebehavior-fieldlevelencryptionid): String
  [ForwardedValues](#cfn-cloudfront-distribution-defaultcachebehavior-forwardedvalues): 
    ForwardedValues
  [FunctionAssociations](#cfn-cloudfront-distribution-defaultcachebehavior-functionassociations): 
    - FunctionAssociation
  [GrpcConfig](#cfn-cloudfront-distribution-defaultcachebehavior-grpcconfig): 
    GrpcConfig
  [LambdaFunctionAssociations](#cfn-cloudfront-distribution-defaultcachebehavior-lambdafunctionassociations): 
    - LambdaFunctionAssociation
  [MaxTTL](#cfn-cloudfront-distribution-defaultcachebehavior-maxttl): Number
  [MinTTL](#cfn-cloudfront-distribution-defaultcachebehavior-minttl): Number
  [OriginRequestPolicyId](#cfn-cloudfront-distribution-defaultcachebehavior-originrequestpolicyid): String
  [RealtimeLogConfigArn](#cfn-cloudfront-distribution-defaultcachebehavior-realtimelogconfigarn): String
  [ResponseHeadersPolicyId](#cfn-cloudfront-distribution-defaultcachebehavior-responseheaderspolicyid): String
  [SmoothStreaming](#cfn-cloudfront-distribution-defaultcachebehavior-smoothstreaming): Boolean
  [TargetOriginId](#cfn-cloudfront-distribution-defaultcachebehavior-targetoriginid): String
  [TrustedKeyGroups](#cfn-cloudfront-distribution-defaultcachebehavior-trustedkeygroups): 
    - String
  [TrustedSigners](#cfn-cloudfront-distribution-defaultcachebehavior-trustedsigners): 
    - String
  [ViewerProtocolPolicy](#cfn-cloudfront-distribution-defaultcachebehavior-viewerprotocolpolicy): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-defaultcachebehavior-properties"></a>

`AllowedMethods`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-allowedmethods"></a>
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` and `HEAD` requests.
+ CloudFront forwards only `GET`, `HEAD`, and `OPTIONS` requests.
+ CloudFront forwards `GET, HEAD, OPTIONS, PUT, PATCH, POST`, and `DELETE` 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.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CachedMethods`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-cachedmethods"></a>
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` and `HEAD` requests.
+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` 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.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CachePolicyId`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-cachepolicyid"></a>
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.  
A `DefaultCacheBehavior` must include either a `CachePolicyId` or `ForwardedValues`. We recommend that you use a `CachePolicyId`.  
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Compress`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-compress"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultTTL`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-defaultttl"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) 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 as `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FieldLevelEncryptionId`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-fieldlevelencryptionid"></a>
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.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ForwardedValues`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-forwardedvalues"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.  
A `DefaultCacheBehavior` must include either a `CachePolicyId` or `ForwardedValues`. We recommend that you use a `CachePolicyId`.  
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.  
*Required*: Conditional  
*Type*: [ForwardedValues](aws-properties-cloudfront-distribution-forwardedvalues.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FunctionAssociations`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-functionassociations"></a>
A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to the `LIVE` stage to associate them with a cache behavior.  
*Required*: No  
*Type*: Array of [FunctionAssociation](aws-properties-cloudfront-distribution-functionassociation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GrpcConfig`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-grpcconfig"></a>
The gRPC configuration for your cache behavior.  
*Required*: No  
*Type*: [GrpcConfig](aws-properties-cloudfront-distribution-grpcconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LambdaFunctionAssociations`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-lambdafunctionassociations"></a>
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.  
*Required*: No  
*Type*: Array of [LambdaFunctionAssociation](aws-properties-cloudfront-distribution-lambdafunctionassociation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxTTL`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-maxttl"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) 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 as `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinTTL`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-minttl"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) 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)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.  
You must specify `0` for `MinTTL` if you configure CloudFront to forward all headers to your origin (under `Headers`, if you specify `1` for `Quantity` and `*` for `Name`).  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginRequestPolicyId`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-originrequestpolicyid"></a>
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RealtimeLogConfigArn`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-realtimelogconfigarn"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResponseHeadersPolicyId`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-responseheaderspolicyid"></a>
The identifier for a response headers policy.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SmoothStreaming`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-smoothstreaming"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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, specify `false`. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetOriginId`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-targetoriginid"></a>
The value of `ID` for the origin that you want CloudFront to route requests to when they use the default cache behavior.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrustedKeyGroups`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-trustedkeygroups"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrustedSigners`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-trustedsigners"></a>
We recommend using `TrustedKeyGroups` instead of `TrustedSigners`.
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ViewerProtocolPolicy`  <a name="cfn-cloudfront-distribution-defaultcachebehavior-viewerprotocolpolicy"></a>
The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`. 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.
*Required*: Yes  
*Type*: String  
*Allowed values*: `allow-all | https-only | redirect-to-https`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-defaultcachebehavior--seealso"></a>
+ [DefaultCacheBehavior](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_DefaultCacheBehavior.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution Definition
<a name="aws-properties-cloudfront-distribution-definition"></a>

<a name="aws-properties-cloudfront-distribution-definition-description"></a>The `Definition` property type specifies Property description not available. for an [AWS::CloudFront::Distribution](aws-resource-cloudfront-distribution.md).

## Syntax
<a name="aws-properties-cloudfront-distribution-definition-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-definition-syntax.json"></a>

```
{
  "[StringSchema](#cfn-cloudfront-distribution-definition-stringschema)" : StringSchema
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-definition-syntax.yaml"></a>

```
  [StringSchema](#cfn-cloudfront-distribution-definition-stringschema): 
    StringSchema
```

## Properties
<a name="aws-properties-cloudfront-distribution-definition-properties"></a>

`StringSchema`  <a name="cfn-cloudfront-distribution-definition-stringschema"></a>
Property description not available.  
*Required*: No  
*Type*: [StringSchema](aws-properties-cloudfront-distribution-stringschema.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution DistributionConfig
<a name="aws-properties-cloudfront-distribution-distributionconfig"></a>

A distribution configuration.

## Syntax
<a name="aws-properties-cloudfront-distribution-distributionconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-distributionconfig-syntax.json"></a>

```
{
  "[Aliases](#cfn-cloudfront-distribution-distributionconfig-aliases)" : [ String, ... ],
  "[AnycastIpListId](#cfn-cloudfront-distribution-distributionconfig-anycastiplistid)" : String,
  "[CacheBehaviors](#cfn-cloudfront-distribution-distributionconfig-cachebehaviors)" : [ CacheBehavior, ... ],
  "[CNAMEs](#cfn-cloudfront-distribution-distributionconfig-cnames)" : [ String, ... ],
  "[Comment](#cfn-cloudfront-distribution-distributionconfig-comment)" : String,
  "[ConnectionFunctionAssociation](#cfn-cloudfront-distribution-distributionconfig-connectionfunctionassociation)" : ConnectionFunctionAssociation,
  "[ConnectionMode](#cfn-cloudfront-distribution-distributionconfig-connectionmode)" : String,
  "[ContinuousDeploymentPolicyId](#cfn-cloudfront-distribution-distributionconfig-continuousdeploymentpolicyid)" : String,
  "[CustomErrorResponses](#cfn-cloudfront-distribution-distributionconfig-customerrorresponses)" : [ CustomErrorResponse, ... ],
  "[CustomOrigin](#cfn-cloudfront-distribution-distributionconfig-customorigin)" : LegacyCustomOrigin,
  "[DefaultCacheBehavior](#cfn-cloudfront-distribution-distributionconfig-defaultcachebehavior)" : DefaultCacheBehavior,
  "[DefaultRootObject](#cfn-cloudfront-distribution-distributionconfig-defaultrootobject)" : String,
  "[Enabled](#cfn-cloudfront-distribution-distributionconfig-enabled)" : Boolean,
  "[HttpVersion](#cfn-cloudfront-distribution-distributionconfig-httpversion)" : String,
  "[IPV6Enabled](#cfn-cloudfront-distribution-distributionconfig-ipv6enabled)" : Boolean,
  "[Logging](#cfn-cloudfront-distribution-distributionconfig-logging)" : Logging,
  "[OriginGroups](#cfn-cloudfront-distribution-distributionconfig-origingroups)" : OriginGroups,
  "[Origins](#cfn-cloudfront-distribution-distributionconfig-origins)" : [ Origin, ... ],
  "[PriceClass](#cfn-cloudfront-distribution-distributionconfig-priceclass)" : String,
  "[Restrictions](#cfn-cloudfront-distribution-distributionconfig-restrictions)" : Restrictions,
  "[S3Origin](#cfn-cloudfront-distribution-distributionconfig-s3origin)" : LegacyS3Origin,
  "[Staging](#cfn-cloudfront-distribution-distributionconfig-staging)" : Boolean,
  "[TenantConfig](#cfn-cloudfront-distribution-distributionconfig-tenantconfig)" : TenantConfig,
  "[ViewerCertificate](#cfn-cloudfront-distribution-distributionconfig-viewercertificate)" : ViewerCertificate,
  "[ViewerMtlsConfig](#cfn-cloudfront-distribution-distributionconfig-viewermtlsconfig)" : ViewerMtlsConfig,
  "[WebACLId](#cfn-cloudfront-distribution-distributionconfig-webaclid)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-distributionconfig-syntax.yaml"></a>

```
  [Aliases](#cfn-cloudfront-distribution-distributionconfig-aliases): 
    - String
  [AnycastIpListId](#cfn-cloudfront-distribution-distributionconfig-anycastiplistid): String
  [CacheBehaviors](#cfn-cloudfront-distribution-distributionconfig-cachebehaviors): 
    - CacheBehavior
  [CNAMEs](#cfn-cloudfront-distribution-distributionconfig-cnames): 
    - String
  [Comment](#cfn-cloudfront-distribution-distributionconfig-comment): String
  [ConnectionFunctionAssociation](#cfn-cloudfront-distribution-distributionconfig-connectionfunctionassociation): 
    ConnectionFunctionAssociation
  [ConnectionMode](#cfn-cloudfront-distribution-distributionconfig-connectionmode): String
  [ContinuousDeploymentPolicyId](#cfn-cloudfront-distribution-distributionconfig-continuousdeploymentpolicyid): String
  [CustomErrorResponses](#cfn-cloudfront-distribution-distributionconfig-customerrorresponses): 
    - CustomErrorResponse
  [CustomOrigin](#cfn-cloudfront-distribution-distributionconfig-customorigin): 
    LegacyCustomOrigin
  [DefaultCacheBehavior](#cfn-cloudfront-distribution-distributionconfig-defaultcachebehavior): 
    DefaultCacheBehavior
  [DefaultRootObject](#cfn-cloudfront-distribution-distributionconfig-defaultrootobject): String
  [Enabled](#cfn-cloudfront-distribution-distributionconfig-enabled): Boolean
  [HttpVersion](#cfn-cloudfront-distribution-distributionconfig-httpversion): String
  [IPV6Enabled](#cfn-cloudfront-distribution-distributionconfig-ipv6enabled): Boolean
  [Logging](#cfn-cloudfront-distribution-distributionconfig-logging): 
    Logging
  [OriginGroups](#cfn-cloudfront-distribution-distributionconfig-origingroups): 
    OriginGroups
  [Origins](#cfn-cloudfront-distribution-distributionconfig-origins): 
    - Origin
  [PriceClass](#cfn-cloudfront-distribution-distributionconfig-priceclass): String
  [Restrictions](#cfn-cloudfront-distribution-distributionconfig-restrictions): 
    Restrictions
  [S3Origin](#cfn-cloudfront-distribution-distributionconfig-s3origin): 
    LegacyS3Origin
  [Staging](#cfn-cloudfront-distribution-distributionconfig-staging): Boolean
  [TenantConfig](#cfn-cloudfront-distribution-distributionconfig-tenantconfig): 
    TenantConfig
  [ViewerCertificate](#cfn-cloudfront-distribution-distributionconfig-viewercertificate): 
    ViewerCertificate
  [ViewerMtlsConfig](#cfn-cloudfront-distribution-distributionconfig-viewermtlsconfig): 
    ViewerMtlsConfig
  [WebACLId](#cfn-cloudfront-distribution-distributionconfig-webaclid): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-distributionconfig-properties"></a>

`Aliases`  <a name="cfn-cloudfront-distribution-distributionconfig-aliases"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AnycastIpListId`  <a name="cfn-cloudfront-distribution-distributionconfig-anycastiplistid"></a>
To use this field for a multi-tenant distribution, use a connection group instead. For more information, see [ConnectionGroup](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ConnectionGroup.html).
ID of the Anycast static IP list that is associated with the distribution.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CacheBehaviors`  <a name="cfn-cloudfront-distribution-distributionconfig-cachebehaviors"></a>
A complex type that contains zero or more `CacheBehavior` elements.  
*Required*: No  
*Type*: Array of [CacheBehavior](aws-properties-cloudfront-distribution-cachebehavior.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CNAMEs`  <a name="cfn-cloudfront-distribution-distributionconfig-cnames"></a>
An alias for the CloudFront distribution's domain name.  
This property is legacy. We recommend that you use [Aliases](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases) instead.
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Comment`  <a name="cfn-cloudfront-distribution-distributionconfig-comment"></a>
A comment to describe the distribution. The comment cannot be longer than 128 characters.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectionFunctionAssociation`  <a name="cfn-cloudfront-distribution-distributionconfig-connectionfunctionassociation"></a>
The distribution's connection function association.  
*Required*: No  
*Type*: [ConnectionFunctionAssociation](aws-properties-cloudfront-distribution-connectionfunctionassociation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectionMode`  <a name="cfn-cloudfront-distribution-distributionconfig-connectionmode"></a>
This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).  
*Required*: No  
*Type*: String  
*Allowed values*: `direct | tenant-only`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContinuousDeploymentPolicyId`  <a name="cfn-cloudfront-distribution-distributionconfig-continuousdeploymentpolicyid"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
The identifier of a continuous deployment policy. For more information, see `CreateContinuousDeploymentPolicy`.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomErrorResponses`  <a name="cfn-cloudfront-distribution-distributionconfig-customerrorresponses"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of [CustomErrorResponse](aws-properties-cloudfront-distribution-customerrorresponse.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomOrigin`  <a name="cfn-cloudfront-distribution-distributionconfig-customorigin"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.
*Required*: No  
*Type*: [LegacyCustomOrigin](aws-properties-cloudfront-distribution-legacycustomorigin.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultCacheBehavior`  <a name="cfn-cloudfront-distribution-distributionconfig-defaultcachebehavior"></a>
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 of `PathPattern` in `CacheBehavior` elements. You must create exactly one default cache behavior.  
*Required*: Yes  
*Type*: [DefaultCacheBehavior](aws-properties-cloudfront-distribution-defaultcachebehavior.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultRootObject`  <a name="cfn-cloudfront-distribution-distributionconfig-defaultrootobject"></a>
When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is `https://www.example.com`, you can specify CloudFront to return the `index.html` file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, `https://www.example.com/product-description.html`). A default root object avoids exposing the contents of your distribution.  
You can specify the object name or a path to the object name (for example, `index.html` or `exampleFolderName/index.html`). Your string can't begin with a forward slash (`/`). Only specify the object name or the path to the object.  
If you don't want to specify a default root object when you create a distribution, include an empty `DefaultRootObject` element.  
To delete the default root object from an existing distribution, update the distribution configuration and include an empty `DefaultRootObject` 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 [Specify a default root object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-cloudfront-distribution-distributionconfig-enabled"></a>
From this field, you can enable or disable the selected distribution.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HttpVersion`  <a name="cfn-cloudfront-distribution-distributionconfig-httpversion"></a>
(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new distributions is `http1.1`.  
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).  
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).  
*Required*: No  
*Type*: String  
*Allowed values*: `http1.1 | http2 | http3 | http2and3`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IPV6Enabled`  <a name="cfn-cloudfront-distribution-distributionconfig-ipv6enabled"></a>
To use this field for a multi-tenant distribution, use a connection group instead. For more information, see [ConnectionGroup](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ConnectionGroup.html).
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`. If you specify `false`, CloudFront responds to IPv6 DNS requests with the DNS response code `NOERROR` 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 the `IpAddress` 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*.  
If you're using an Amazon Route 53 AWS Integration 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Amazon Route 53 AWS Integration Developer Guide*.  
If you created a CNAME resource record set, either with Amazon Route 53 AWS Integration 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.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Logging`  <a name="cfn-cloudfront-distribution-distributionconfig-logging"></a>
A complex type that controls whether access logs are written for the distribution.  
For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: [Logging](aws-properties-cloudfront-distribution-logging.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginGroups`  <a name="cfn-cloudfront-distribution-distributionconfig-origingroups"></a>
A complex type that contains information about origin groups for this distribution.  
Specify a value for either the `Origins` or `OriginGroups` property.  
*Required*: Conditional  
*Type*: [OriginGroups](aws-properties-cloudfront-distribution-origingroups.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Origins`  <a name="cfn-cloudfront-distribution-distributionconfig-origins"></a>
A complex type that contains information about origins for this distribution.  
Specify a value for either the `Origins` or `OriginGroups` property.  
*Required*: Conditional  
*Type*: Array of [Origin](aws-properties-cloudfront-distribution-origin.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PriceClass`  <a name="cfn-cloudfront-distribution-distributionconfig-priceclass"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
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 than `PriceClass_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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) 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](https://aws.amazon.com/cloudfront/pricing/).  
*Required*: No  
*Type*: String  
*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All | None`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Restrictions`  <a name="cfn-cloudfront-distribution-distributionconfig-restrictions"></a>
A complex type that identifies ways in which you want to restrict distribution of your content.  
*Required*: No  
*Type*: [Restrictions](aws-properties-cloudfront-distribution-restrictions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Origin`  <a name="cfn-cloudfront-distribution-distributionconfig-s3origin"></a>
The origin as an Amazon S3 bucket.  
This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.
*Required*: No  
*Type*: [LegacyS3Origin](aws-properties-cloudfront-distribution-legacys3origin.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Staging`  <a name="cfn-cloudfront-distribution-distributionconfig-staging"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
A Boolean that indicates whether this is a staging distribution. When this value is `true`, this is a staging distribution. When this value is `false`, this is not a staging distribution.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TenantConfig`  <a name="cfn-cloudfront-distribution-distributionconfig-tenantconfig"></a>
This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
A distribution tenant configuration.  
*Required*: No  
*Type*: [TenantConfig](aws-properties-cloudfront-distribution-tenantconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ViewerCertificate`  <a name="cfn-cloudfront-distribution-distributionconfig-viewercertificate"></a>
A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.  
*Required*: No  
*Type*: [ViewerCertificate](aws-properties-cloudfront-distribution-viewercertificate.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ViewerMtlsConfig`  <a name="cfn-cloudfront-distribution-distributionconfig-viewermtlsconfig"></a>
The distribution's viewer mTLS configuration.  
*Required*: No  
*Type*: [ViewerMtlsConfig](aws-properties-cloudfront-distribution-viewermtlsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WebACLId`  <a name="cfn-cloudfront-distribution-distributionconfig-webaclid"></a>
Multi-tenant distributions only support AWS WAF V2 web ACLs.
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.  
AWS 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 AWS WAF, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-distributionconfig--seealso"></a>
+ [DistributionConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_DistributionConfig.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution ForwardedValues
<a name="aws-properties-cloudfront-distribution-forwardedvalues"></a>

**Note**  
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.

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 values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

## Syntax
<a name="aws-properties-cloudfront-distribution-forwardedvalues-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-forwardedvalues-syntax.json"></a>

```
{
  "[Cookies](#cfn-cloudfront-distribution-forwardedvalues-cookies)" : Cookies,
  "[Headers](#cfn-cloudfront-distribution-forwardedvalues-headers)" : [ String, ... ],
  "[QueryString](#cfn-cloudfront-distribution-forwardedvalues-querystring)" : Boolean,
  "[QueryStringCacheKeys](#cfn-cloudfront-distribution-forwardedvalues-querystringcachekeys)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-forwardedvalues-syntax.yaml"></a>

```
  [Cookies](#cfn-cloudfront-distribution-forwardedvalues-cookies): 
    Cookies
  [Headers](#cfn-cloudfront-distribution-forwardedvalues-headers): 
    - String
  [QueryString](#cfn-cloudfront-distribution-forwardedvalues-querystring): Boolean
  [QueryStringCacheKeys](#cfn-cloudfront-distribution-forwardedvalues-querystringcachekeys): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-distribution-forwardedvalues-properties"></a>

`Cookies`  <a name="cfn-cloudfront-distribution-forwardedvalues-cookies"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: [Cookies](aws-properties-cloudfront-distribution-cookies.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Headers`  <a name="cfn-cloudfront-distribution-forwardedvalues-headers"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryString`  <a name="cfn-cloudfront-distribution-forwardedvalues-querystring"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) 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 for `QueryStringCacheKeys`, if any:  
If you specify true for `QueryString` and you don't specify any values for `QueryStringCacheKeys`, 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 for `QueryString` and you specify one or more values for `QueryStringCacheKeys`, 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 for `QueryString`, 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStringCacheKeys`  <a name="cfn-cloudfront-distribution-forwardedvalues-querystringcachekeys"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) 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.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-forwardedvalues--seealso"></a>
+ [ForwardedValues](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ForwardedValues.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution FunctionAssociation
<a name="aws-properties-cloudfront-distribution-functionassociation"></a>

A CloudFront function that is associated with a cache behavior in a CloudFront distribution.

## Syntax
<a name="aws-properties-cloudfront-distribution-functionassociation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-functionassociation-syntax.json"></a>

```
{
  "[EventType](#cfn-cloudfront-distribution-functionassociation-eventtype)" : String,
  "[FunctionARN](#cfn-cloudfront-distribution-functionassociation-functionarn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-functionassociation-syntax.yaml"></a>

```
  [EventType](#cfn-cloudfront-distribution-functionassociation-eventtype): String
  [FunctionARN](#cfn-cloudfront-distribution-functionassociation-functionarn): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-functionassociation-properties"></a>

`EventType`  <a name="cfn-cloudfront-distribution-functionassociation-eventtype"></a>
The event type of the function, either `viewer-request` or `viewer-response`. You cannot use origin-facing event types (`origin-request` and `origin-response`) with a CloudFront function.  
*Required*: No  
*Type*: String  
*Allowed values*: `viewer-request | viewer-response | origin-request | origin-response`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FunctionARN`  <a name="cfn-cloudfront-distribution-functionassociation-functionarn"></a>
The Amazon Resource Name (ARN) of the function.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:aws:cloudfront::[0-9]{12}:function\/[a-zA-Z0-9-_]{1,64}`  
*Minimum*: `0`  
*Maximum*: `108`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution GeoRestriction
<a name="aws-properties-cloudfront-distribution-georestriction"></a>

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using `MaxMind` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template.

## Syntax
<a name="aws-properties-cloudfront-distribution-georestriction-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-georestriction-syntax.json"></a>

```
{
  "[Locations](#cfn-cloudfront-distribution-georestriction-locations)" : [ String, ... ],
  "[RestrictionType](#cfn-cloudfront-distribution-georestriction-restrictiontype)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-georestriction-syntax.yaml"></a>

```
  [Locations](#cfn-cloudfront-distribution-georestriction-locations): 
    - String
  [RestrictionType](#cfn-cloudfront-distribution-georestriction-restrictiontype): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-georestriction-properties"></a>

`Locations`  <a name="cfn-cloudfront-distribution-georestriction-locations"></a>
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`).  
The `Location` element is a two-letter, uppercase country code for a country that you want to include in your `blacklist` or `whitelist`. Include one `Location` element for each country.  
CloudFront and `MaxMind` both use `ISO 3166` country codes. For the current list of countries and the corresponding codes, see `ISO 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.  
*Required*: Conditional  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RestrictionType`  <a name="cfn-cloudfront-distribution-georestriction-restrictiontype"></a>
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`: The `Location` elements specify the countries in which you don't want CloudFront to distribute your content.
+ `whitelist`: The `Location` elements specify the countries in which you want CloudFront to distribute your content.
*Required*: Yes  
*Type*: String  
*Allowed values*: `blacklist | whitelist | none`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-properties-cloudfront-distribution-georestriction--examples"></a>



### Add georestrictions
<a name="aws-properties-cloudfront-distribution-georestriction--examples--Add_georestrictions"></a>

The following examples show how to add georestrictions.

#### JSON
<a name="aws-properties-cloudfront-distribution-georestriction--examples--Add_georestrictions--json"></a>

```
{
  "Restrictions": {
    "GeoRestriction": {
      "RestrictionType": "whitelist",
      "Locations": [
        "ES",
        "GB"
      ]
    }
  }
}
```

#### YAML
<a name="aws-properties-cloudfront-distribution-georestriction--examples--Add_georestrictions--yaml"></a>

```
        Restrictions:
          GeoRestriction:
            RestrictionType: whitelist
            Locations:
              - ES
              - GB
```

## See also
<a name="aws-properties-cloudfront-distribution-georestriction--seealso"></a>
+ [GeoRestriction](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GeoRestriction.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution GrpcConfig
<a name="aws-properties-cloudfront-distribution-grpcconfig"></a>

Amazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on HTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads, making it suitable for applications that require low latency communications.

To enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported `HTTP` versions and allow `HTTP` methods, including `POST`.

For more information, see [Using gRPC with CloudFront distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-using-grpc.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-distribution-grpcconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-grpcconfig-syntax.json"></a>

```
{
  "[Enabled](#cfn-cloudfront-distribution-grpcconfig-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-grpcconfig-syntax.yaml"></a>

```
  [Enabled](#cfn-cloudfront-distribution-grpcconfig-enabled): Boolean
```

## Properties
<a name="aws-properties-cloudfront-distribution-grpcconfig-properties"></a>

`Enabled`  <a name="cfn-cloudfront-distribution-grpcconfig-enabled"></a>
Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution LambdaFunctionAssociation
<a name="aws-properties-cloudfront-distribution-lambdafunctionassociation"></a>

A complex type that contains a Lambda@Edge function association.

## Syntax
<a name="aws-properties-cloudfront-distribution-lambdafunctionassociation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-lambdafunctionassociation-syntax.json"></a>

```
{
  "[EventType](#cfn-cloudfront-distribution-lambdafunctionassociation-eventtype)" : String,
  "[IncludeBody](#cfn-cloudfront-distribution-lambdafunctionassociation-includebody)" : Boolean,
  "[LambdaFunctionARN](#cfn-cloudfront-distribution-lambdafunctionassociation-lambdafunctionarn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-lambdafunctionassociation-syntax.yaml"></a>

```
  [EventType](#cfn-cloudfront-distribution-lambdafunctionassociation-eventtype): String
  [IncludeBody](#cfn-cloudfront-distribution-lambdafunctionassociation-includebody): Boolean
  [LambdaFunctionARN](#cfn-cloudfront-distribution-lambdafunctionassociation-lambdafunctionarn): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-lambdafunctionassociation-properties"></a>

`EventType`  <a name="cfn-cloudfront-distribution-lambdafunctionassociation-eventtype"></a>
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.
*Required*: No  
*Type*: String  
*Allowed values*: `viewer-request | viewer-response | origin-request | origin-response`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IncludeBody`  <a name="cfn-cloudfront-distribution-lambdafunctionassociation-includebody"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LambdaFunctionARN`  <a name="cfn-cloudfront-distribution-lambdafunctionassociation-lambdafunctionarn"></a>
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or \$1LATEST.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-lambdafunctionassociation--seealso"></a>
+ [LambdaFunctionAssociation](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_LambdaFunctionAssociation.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution LegacyCustomOrigin
<a name="aws-properties-cloudfront-distribution-legacycustomorigin"></a>

A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)*is* a custom origin.

**Note**  
This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.

## Syntax
<a name="aws-properties-cloudfront-distribution-legacycustomorigin-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-legacycustomorigin-syntax.json"></a>

```
{
  "[DNSName](#cfn-cloudfront-distribution-legacycustomorigin-dnsname)" : String,
  "[HTTPPort](#cfn-cloudfront-distribution-legacycustomorigin-httpport)" : Integer,
  "[HTTPSPort](#cfn-cloudfront-distribution-legacycustomorigin-httpsport)" : Integer,
  "[OriginProtocolPolicy](#cfn-cloudfront-distribution-legacycustomorigin-originprotocolpolicy)" : String,
  "[OriginSSLProtocols](#cfn-cloudfront-distribution-legacycustomorigin-originsslprotocols)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-legacycustomorigin-syntax.yaml"></a>

```
  [DNSName](#cfn-cloudfront-distribution-legacycustomorigin-dnsname): String
  [HTTPPort](#cfn-cloudfront-distribution-legacycustomorigin-httpport): Integer
  [HTTPSPort](#cfn-cloudfront-distribution-legacycustomorigin-httpsport): Integer
  [OriginProtocolPolicy](#cfn-cloudfront-distribution-legacycustomorigin-originprotocolpolicy): String
  [OriginSSLProtocols](#cfn-cloudfront-distribution-legacycustomorigin-originsslprotocols): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-distribution-legacycustomorigin-properties"></a>

`DNSName`  <a name="cfn-cloudfront-distribution-legacycustomorigin-dnsname"></a>
The domain name assigned to your CloudFront distribution.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HTTPPort`  <a name="cfn-cloudfront-distribution-legacycustomorigin-httpport"></a>
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HTTPSPort`  <a name="cfn-cloudfront-distribution-legacycustomorigin-httpsport"></a>
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginProtocolPolicy`  <a name="cfn-cloudfront-distribution-legacycustomorigin-originprotocolpolicy"></a>
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginSSLProtocols`  <a name="cfn-cloudfront-distribution-legacycustomorigin-originsslprotocols"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution LegacyS3Origin
<a name="aws-properties-cloudfront-distribution-legacys3origin"></a>

The origin as an Amazon S3 bucket. 

**Note**  
This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.

## Syntax
<a name="aws-properties-cloudfront-distribution-legacys3origin-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-legacys3origin-syntax.json"></a>

```
{
  "[DNSName](#cfn-cloudfront-distribution-legacys3origin-dnsname)" : String,
  "[OriginAccessIdentity](#cfn-cloudfront-distribution-legacys3origin-originaccessidentity)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-legacys3origin-syntax.yaml"></a>

```
  [DNSName](#cfn-cloudfront-distribution-legacys3origin-dnsname): String
  [OriginAccessIdentity](#cfn-cloudfront-distribution-legacys3origin-originaccessidentity): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-legacys3origin-properties"></a>

`DNSName`  <a name="cfn-cloudfront-distribution-legacys3origin-dnsname"></a>
The domain name assigned to your CloudFront distribution.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginAccessIdentity`  <a name="cfn-cloudfront-distribution-legacys3origin-originaccessidentity"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html) instead.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution Logging
<a name="aws-properties-cloudfront-distribution-logging"></a>

A complex type that specifies whether access logs are written for the distribution.

**Note**  
If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a *different* Amazon S3 bucket or use a *separate path* in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see [Standard logging (access logs)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-distribution-logging-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-logging-syntax.json"></a>

```
{
  "[Bucket](#cfn-cloudfront-distribution-logging-bucket)" : String,
  "[IncludeCookies](#cfn-cloudfront-distribution-logging-includecookies)" : Boolean,
  "[Prefix](#cfn-cloudfront-distribution-logging-prefix)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-logging-syntax.yaml"></a>

```
  [Bucket](#cfn-cloudfront-distribution-logging-bucket): String
  [IncludeCookies](#cfn-cloudfront-distribution-logging-includecookies): Boolean
  [Prefix](#cfn-cloudfront-distribution-logging-prefix): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-logging-properties"></a>

`Bucket`  <a name="cfn-cloudfront-distribution-logging-bucket"></a>
The Amazon S3 bucket to store the access logs in, for example, `amzn-s3-demo-bucket.s3.amazonaws.com`.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IncludeCookies`  <a name="cfn-cloudfront-distribution-logging-includecookies"></a>
Specifies whether you want CloudFront to include cookies in access logs, specify `true` for `IncludeCookies`. 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, specify `false` for `IncludeCookies`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Prefix`  <a name="cfn-cloudfront-distribution-logging-prefix"></a>
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 empty `Prefix` element in the `Logging` element.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-logging--seealso"></a>
+ [LoggingConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_LoggingConfig.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution Origin
<a name="aws-properties-cloudfront-distribution-origin"></a>

An origin.

An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:
+ Use `S3OriginConfig` to specify an Amazon S3 bucket that is not configured with static website hosting.
+ Use `VpcOriginConfig` to specify a VPC origin.
+ Use `CustomOriginConfig` to specify all other kinds of origins, including:
  + An Amazon S3 bucket that is configured with static website hosting
  + An Elastic Load Balancing load balancer
  + An AWS Elemental MediaPackage endpoint
  + An AWS Elemental MediaStore container
  + Any other HTTP server, running on an Amazon EC2 instance or any other kind of host

For the current maximum number of origins that you can specify per distribution, see [General Quotas on Web Distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions) in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits).

## Syntax
<a name="aws-properties-cloudfront-distribution-origin-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-origin-syntax.json"></a>

```
{
  "[ConnectionAttempts](#cfn-cloudfront-distribution-origin-connectionattempts)" : Integer,
  "[ConnectionTimeout](#cfn-cloudfront-distribution-origin-connectiontimeout)" : Integer,
  "[CustomOriginConfig](#cfn-cloudfront-distribution-origin-customoriginconfig)" : CustomOriginConfig,
  "[DomainName](#cfn-cloudfront-distribution-origin-domainname)" : String,
  "[Id](#cfn-cloudfront-distribution-origin-id)" : String,
  "[OriginAccessControlId](#cfn-cloudfront-distribution-origin-originaccesscontrolid)" : String,
  "[OriginCustomHeaders](#cfn-cloudfront-distribution-origin-origincustomheaders)" : [ OriginCustomHeader, ... ],
  "[OriginPath](#cfn-cloudfront-distribution-origin-originpath)" : String,
  "[OriginShield](#cfn-cloudfront-distribution-origin-originshield)" : OriginShield,
  "[ResponseCompletionTimeout](#cfn-cloudfront-distribution-origin-responsecompletiontimeout)" : Integer,
  "[S3OriginConfig](#cfn-cloudfront-distribution-origin-s3originconfig)" : S3OriginConfig,
  "[VpcOriginConfig](#cfn-cloudfront-distribution-origin-vpcoriginconfig)" : VpcOriginConfig
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-origin-syntax.yaml"></a>

```
  [ConnectionAttempts](#cfn-cloudfront-distribution-origin-connectionattempts): Integer
  [ConnectionTimeout](#cfn-cloudfront-distribution-origin-connectiontimeout): Integer
  [CustomOriginConfig](#cfn-cloudfront-distribution-origin-customoriginconfig): 
    CustomOriginConfig
  [DomainName](#cfn-cloudfront-distribution-origin-domainname): String
  [Id](#cfn-cloudfront-distribution-origin-id): String
  [OriginAccessControlId](#cfn-cloudfront-distribution-origin-originaccesscontrolid): String
  [OriginCustomHeaders](#cfn-cloudfront-distribution-origin-origincustomheaders): 
    - OriginCustomHeader
  [OriginPath](#cfn-cloudfront-distribution-origin-originpath): String
  [OriginShield](#cfn-cloudfront-distribution-origin-originshield): 
    OriginShield
  [ResponseCompletionTimeout](#cfn-cloudfront-distribution-origin-responsecompletiontimeout): Integer
  [S3OriginConfig](#cfn-cloudfront-distribution-origin-s3originconfig): 
    S3OriginConfig
  [VpcOriginConfig](#cfn-cloudfront-distribution-origin-vpcoriginconfig): 
    VpcOriginConfig
```

## Properties
<a name="aws-properties-cloudfront-distribution-origin-properties"></a>

`ConnectionAttempts`  <a name="cfn-cloudfront-distribution-origin-connectionattempts"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout).  
For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectionTimeout`  <a name="cfn-cloudfront-distribution-origin-connectiontimeout"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomOriginConfig`  <a name="cfn-cloudfront-distribution-origin-customoriginconfig"></a>
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.  
*Required*: Conditional  
*Type*: [CustomOriginConfig](aws-properties-cloudfront-distribution-customoriginconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DomainName`  <a name="cfn-cloudfront-distribution-origin-domainname"></a>
The domain name for the origin.  
For more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Id`  <a name="cfn-cloudfront-distribution-origin-id"></a>
A unique identifier for the origin. This value must be unique within the distribution.  
Use this value to specify the `TargetOriginId` in a `CacheBehavior` or `DefaultCacheBehavior`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginAccessControlId`  <a name="cfn-cloudfront-distribution-origin-originaccesscontrolid"></a>
The unique identifier of an origin access control for this origin.  
For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginCustomHeaders`  <a name="cfn-cloudfront-distribution-origin-origincustomheaders"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of [OriginCustomHeader](aws-properties-cloudfront-distribution-origincustomheader.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginPath`  <a name="cfn-cloudfront-distribution-origin-originpath"></a>
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.  
For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginShield`  <a name="cfn-cloudfront-distribution-origin-originshield"></a>
CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.  
For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: [OriginShield](aws-properties-cloudfront-distribution-originshield.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResponseCompletionTimeout`  <a name="cfn-cloudfront-distribution-origin-responsecompletiontimeout"></a>
The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.  
The value for `ResponseCompletionTimeout` must be equal to or greater than the value for `OriginReadTimeout`. If you don't set a value for `ResponseCompletionTimeout`, CloudFront doesn't enforce a maximum value.  
For more information, see [Response completion timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#response-completion-timeout) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3OriginConfig`  <a name="cfn-cloudfront-distribution-origin-s3originconfig"></a>
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.  
*Required*: Conditional  
*Type*: [S3OriginConfig](aws-properties-cloudfront-distribution-s3originconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcOriginConfig`  <a name="cfn-cloudfront-distribution-origin-vpcoriginconfig"></a>
The VPC origin configuration.  
*Required*: No  
*Type*: [VpcOriginConfig](aws-properties-cloudfront-distribution-vpcoriginconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-origin--seealso"></a>
+ [Origin](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_Origin.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution OriginCustomHeader
<a name="aws-properties-cloudfront-distribution-origincustomheader"></a>

A complex type that contains `HeaderName` and `HeaderValue` elements, if any, for this distribution.

## Syntax
<a name="aws-properties-cloudfront-distribution-origincustomheader-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-origincustomheader-syntax.json"></a>

```
{
  "[HeaderName](#cfn-cloudfront-distribution-origincustomheader-headername)" : String,
  "[HeaderValue](#cfn-cloudfront-distribution-origincustomheader-headervalue)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-origincustomheader-syntax.yaml"></a>

```
  [HeaderName](#cfn-cloudfront-distribution-origincustomheader-headername): String
  [HeaderValue](#cfn-cloudfront-distribution-origincustomheader-headervalue): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-origincustomheader-properties"></a>

`HeaderName`  <a name="cfn-cloudfront-distribution-origincustomheader-headername"></a>
The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the * Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HeaderValue`  <a name="cfn-cloudfront-distribution-origincustomheader-headervalue"></a>
The value for the header that you specified in the `HeaderName` field.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-origincustomheader--seealso"></a>
+ [OriginCustomHeader](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_OriginCustomHeader.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution OriginGroup
<a name="aws-properties-cloudfront-distribution-origingroup"></a>

An origin group includes two origins (a primary origin and a secondary origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen.

Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.

## Syntax
<a name="aws-properties-cloudfront-distribution-origingroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-origingroup-syntax.json"></a>

```
{
  "[FailoverCriteria](#cfn-cloudfront-distribution-origingroup-failovercriteria)" : OriginGroupFailoverCriteria,
  "[Id](#cfn-cloudfront-distribution-origingroup-id)" : String,
  "[Members](#cfn-cloudfront-distribution-origingroup-members)" : OriginGroupMembers,
  "[SelectionCriteria](#cfn-cloudfront-distribution-origingroup-selectioncriteria)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-origingroup-syntax.yaml"></a>

```
  [FailoverCriteria](#cfn-cloudfront-distribution-origingroup-failovercriteria): 
    OriginGroupFailoverCriteria
  [Id](#cfn-cloudfront-distribution-origingroup-id): String
  [Members](#cfn-cloudfront-distribution-origingroup-members): 
    OriginGroupMembers
  [SelectionCriteria](#cfn-cloudfront-distribution-origingroup-selectioncriteria): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-origingroup-properties"></a>

`FailoverCriteria`  <a name="cfn-cloudfront-distribution-origingroup-failovercriteria"></a>
A complex type that contains information about the failover criteria for an origin group.  
*Required*: Yes  
*Type*: [OriginGroupFailoverCriteria](aws-properties-cloudfront-distribution-origingroupfailovercriteria.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Id`  <a name="cfn-cloudfront-distribution-origingroup-id"></a>
The origin group's ID.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Members`  <a name="cfn-cloudfront-distribution-origingroup-members"></a>
A complex type that contains information about the origins in an origin group.  
*Required*: Yes  
*Type*: [OriginGroupMembers](aws-properties-cloudfront-distribution-origingroupmembers.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SelectionCriteria`  <a name="cfn-cloudfront-distribution-origingroup-selectioncriteria"></a>
The selection criteria for the origin group. For more information, see [Create an origin group](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/high_availability_origin_failover.html#concept_origin_groups.creating) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `default | media-quality-based`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution OriginGroupFailoverCriteria
<a name="aws-properties-cloudfront-distribution-origingroupfailovercriteria"></a>

A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.

## Syntax
<a name="aws-properties-cloudfront-distribution-origingroupfailovercriteria-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-origingroupfailovercriteria-syntax.json"></a>

```
{
  "[StatusCodes](#cfn-cloudfront-distribution-origingroupfailovercriteria-statuscodes)" : StatusCodes
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-origingroupfailovercriteria-syntax.yaml"></a>

```
  [StatusCodes](#cfn-cloudfront-distribution-origingroupfailovercriteria-statuscodes): 
    StatusCodes
```

## Properties
<a name="aws-properties-cloudfront-distribution-origingroupfailovercriteria-properties"></a>

`StatusCodes`  <a name="cfn-cloudfront-distribution-origingroupfailovercriteria-statuscodes"></a>
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.  
*Required*: Yes  
*Type*: [StatusCodes](aws-properties-cloudfront-distribution-statuscodes.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution OriginGroupMember
<a name="aws-properties-cloudfront-distribution-origingroupmember"></a>

An origin in an origin group.

## Syntax
<a name="aws-properties-cloudfront-distribution-origingroupmember-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-origingroupmember-syntax.json"></a>

```
{
  "[OriginId](#cfn-cloudfront-distribution-origingroupmember-originid)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-origingroupmember-syntax.yaml"></a>

```
  [OriginId](#cfn-cloudfront-distribution-origingroupmember-originid): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-origingroupmember-properties"></a>

`OriginId`  <a name="cfn-cloudfront-distribution-origingroupmember-originid"></a>
The ID for an origin in an origin group.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution OriginGroupMembers
<a name="aws-properties-cloudfront-distribution-origingroupmembers"></a>

A complex data type for the origins included in an origin group.

## Syntax
<a name="aws-properties-cloudfront-distribution-origingroupmembers-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-origingroupmembers-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-distribution-origingroupmembers-items)" : [ OriginGroupMember, ... ],
  "[Quantity](#cfn-cloudfront-distribution-origingroupmembers-quantity)" : Integer
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-origingroupmembers-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-distribution-origingroupmembers-items): 
    - OriginGroupMember
  [Quantity](#cfn-cloudfront-distribution-origingroupmembers-quantity): Integer
```

## Properties
<a name="aws-properties-cloudfront-distribution-origingroupmembers-properties"></a>

`Items`  <a name="cfn-cloudfront-distribution-origingroupmembers-items"></a>
Items (origins) in an origin group.  
*Required*: Yes  
*Type*: Array of [OriginGroupMember](aws-properties-cloudfront-distribution-origingroupmember.md)  
*Minimum*: `2`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Quantity`  <a name="cfn-cloudfront-distribution-origingroupmembers-quantity"></a>
The number of origins in an origin group.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution OriginGroups
<a name="aws-properties-cloudfront-distribution-origingroups"></a>

A complex data type for the origin groups specified for a distribution.

## Syntax
<a name="aws-properties-cloudfront-distribution-origingroups-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-origingroups-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-distribution-origingroups-items)" : [ OriginGroup, ... ],
  "[Quantity](#cfn-cloudfront-distribution-origingroups-quantity)" : Integer
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-origingroups-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-distribution-origingroups-items): 
    - OriginGroup
  [Quantity](#cfn-cloudfront-distribution-origingroups-quantity): Integer
```

## Properties
<a name="aws-properties-cloudfront-distribution-origingroups-properties"></a>

`Items`  <a name="cfn-cloudfront-distribution-origingroups-items"></a>
The items (origin groups) in a distribution.  
*Required*: No  
*Type*: Array of [OriginGroup](aws-properties-cloudfront-distribution-origingroup.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Quantity`  <a name="cfn-cloudfront-distribution-origingroups-quantity"></a>
The number of origin groups.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution OriginMtlsConfig
<a name="aws-properties-cloudfront-distribution-originmtlsconfig"></a>

Configures mutual TLS authentication between CloudFront and your origin server.

## Syntax
<a name="aws-properties-cloudfront-distribution-originmtlsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-originmtlsconfig-syntax.json"></a>

```
{
  "[ClientCertificateArn](#cfn-cloudfront-distribution-originmtlsconfig-clientcertificatearn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-originmtlsconfig-syntax.yaml"></a>

```
  [ClientCertificateArn](#cfn-cloudfront-distribution-originmtlsconfig-clientcertificatearn): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-originmtlsconfig-properties"></a>

`ClientCertificateArn`  <a name="cfn-cloudfront-distribution-originmtlsconfig-clientcertificatearn"></a>
The Amazon Resource Name (ARN) of the client certificate stored in AWS Certificate Manager (ACM) that CloudFront uses to authenticate with your origin using Mutual TLS.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution OriginShield
<a name="aws-properties-cloudfront-distribution-originshield"></a>

CloudFront Origin Shield.

Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-distribution-originshield-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-originshield-syntax.json"></a>

```
{
  "[Enabled](#cfn-cloudfront-distribution-originshield-enabled)" : Boolean,
  "[OriginShieldRegion](#cfn-cloudfront-distribution-originshield-originshieldregion)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-originshield-syntax.yaml"></a>

```
  [Enabled](#cfn-cloudfront-distribution-originshield-enabled): Boolean
  [OriginShieldRegion](#cfn-cloudfront-distribution-originshield-originshieldregion): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-originshield-properties"></a>

`Enabled`  <a name="cfn-cloudfront-distribution-originshield-enabled"></a>
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.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginShieldRegion`  <a name="cfn-cloudfront-distribution-originshield-originshieldregion"></a>
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 AWS Region for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-z]{2}-[a-z]+-\d`  
*Minimum*: `1`  
*Maximum*: `32`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution ParameterDefinition
<a name="aws-properties-cloudfront-distribution-parameterdefinition"></a>

A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

## Syntax
<a name="aws-properties-cloudfront-distribution-parameterdefinition-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-parameterdefinition-syntax.json"></a>

```
{
  "[Definition](#cfn-cloudfront-distribution-parameterdefinition-definition)" : Definition,
  "[Name](#cfn-cloudfront-distribution-parameterdefinition-name)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-parameterdefinition-syntax.yaml"></a>

```
  [Definition](#cfn-cloudfront-distribution-parameterdefinition-definition): 
    Definition
  [Name](#cfn-cloudfront-distribution-parameterdefinition-name): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-parameterdefinition-properties"></a>

`Definition`  <a name="cfn-cloudfront-distribution-parameterdefinition-definition"></a>
The value that you assigned to the parameter.  
*Required*: Yes  
*Type*: [Definition](aws-properties-cloudfront-distribution-definition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-distribution-parameterdefinition-name"></a>
The name of the parameter.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z0-9-_]+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution Restrictions
<a name="aws-properties-cloudfront-distribution-restrictions"></a>

A complex type that identifies ways in which you want to restrict distribution of your content.

## Syntax
<a name="aws-properties-cloudfront-distribution-restrictions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-restrictions-syntax.json"></a>

```
{
  "[GeoRestriction](#cfn-cloudfront-distribution-restrictions-georestriction)" : GeoRestriction
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-restrictions-syntax.yaml"></a>

```
  [GeoRestriction](#cfn-cloudfront-distribution-restrictions-georestriction): 
    GeoRestriction
```

## Properties
<a name="aws-properties-cloudfront-distribution-restrictions-properties"></a>

`GeoRestriction`  <a name="cfn-cloudfront-distribution-restrictions-georestriction"></a>
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using `MaxMind` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template.  
*Required*: Yes  
*Type*: [GeoRestriction](aws-properties-cloudfront-distribution-georestriction.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-restrictions--seealso"></a>
+ [Restrictions](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_Restrictions.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution S3OriginConfig
<a name="aws-properties-cloudfront-distribution-s3originconfig"></a>

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the `CustomOriginConfig` element instead.

## Syntax
<a name="aws-properties-cloudfront-distribution-s3originconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-s3originconfig-syntax.json"></a>

```
{
  "[OriginAccessIdentity](#cfn-cloudfront-distribution-s3originconfig-originaccessidentity)" : String,
  "[OriginReadTimeout](#cfn-cloudfront-distribution-s3originconfig-originreadtimeout)" : Integer
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-s3originconfig-syntax.yaml"></a>

```
  [OriginAccessIdentity](#cfn-cloudfront-distribution-s3originconfig-originaccessidentity): String
  [OriginReadTimeout](#cfn-cloudfront-distribution-s3originconfig-originreadtimeout): Integer
```

## Properties
<a name="aws-properties-cloudfront-distribution-s3originconfig-properties"></a>

`OriginAccessIdentity`  <a name="cfn-cloudfront-distribution-s3originconfig-originaccessidentity"></a>
If you're using origin access control (OAC) instead of origin access identity, specify an empty `OriginAccessIdentity` element. For more information, see [Restricting access to an AWS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.
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`   
The ` ID-of-origin-access-identity ` is the value that CloudFront returned in the `ID` 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 empty `OriginAccessIdentity` element.  
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` 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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginReadTimeout`  <a name="cfn-cloudfront-distribution-s3originconfig-originreadtimeout"></a>
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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.  
For more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-s3originconfig--seealso"></a>
+ [S3OriginConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_S3OriginConfig.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution StatusCodes
<a name="aws-properties-cloudfront-distribution-statuscodes"></a>

A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.

## Syntax
<a name="aws-properties-cloudfront-distribution-statuscodes-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-statuscodes-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-distribution-statuscodes-items)" : [ Integer, ... ],
  "[Quantity](#cfn-cloudfront-distribution-statuscodes-quantity)" : Integer
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-statuscodes-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-distribution-statuscodes-items): 
    - Integer
  [Quantity](#cfn-cloudfront-distribution-statuscodes-quantity): Integer
```

## Properties
<a name="aws-properties-cloudfront-distribution-statuscodes-properties"></a>

`Items`  <a name="cfn-cloudfront-distribution-statuscodes-items"></a>
The items (status codes) for an origin group.  
*Required*: Yes  
*Type*: Array of Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Quantity`  <a name="cfn-cloudfront-distribution-statuscodes-quantity"></a>
The number of status codes.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution StringSchema
<a name="aws-properties-cloudfront-distribution-stringschema"></a>

<a name="aws-properties-cloudfront-distribution-stringschema-description"></a>The `StringSchema` property type specifies Property description not available. for an [AWS::CloudFront::Distribution](aws-resource-cloudfront-distribution.md).

## Syntax
<a name="aws-properties-cloudfront-distribution-stringschema-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-stringschema-syntax.json"></a>

```
{
  "[Comment](#cfn-cloudfront-distribution-stringschema-comment)" : String,
  "[DefaultValue](#cfn-cloudfront-distribution-stringschema-defaultvalue)" : String,
  "[Required](#cfn-cloudfront-distribution-stringschema-required)" : Boolean
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-stringschema-syntax.yaml"></a>

```
  [Comment](#cfn-cloudfront-distribution-stringschema-comment): String
  [DefaultValue](#cfn-cloudfront-distribution-stringschema-defaultvalue): String
  [Required](#cfn-cloudfront-distribution-stringschema-required): Boolean
```

## Properties
<a name="aws-properties-cloudfront-distribution-stringschema-properties"></a>

`Comment`  <a name="cfn-cloudfront-distribution-stringschema-comment"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultValue`  <a name="cfn-cloudfront-distribution-stringschema-defaultvalue"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Required`  <a name="cfn-cloudfront-distribution-stringschema-required"></a>
Property description not available.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution Tag
<a name="aws-properties-cloudfront-distribution-tag"></a>

A complex type that contains `Tag` key and `Tag` value.

## Syntax
<a name="aws-properties-cloudfront-distribution-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cloudfront-distribution-tag-key)" : String,
  "[Value](#cfn-cloudfront-distribution-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-tag-syntax.yaml"></a>

```
  [Key](#cfn-cloudfront-distribution-tag-key): String
  [Value](#cfn-cloudfront-distribution-tag-value): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-tag-properties"></a>

`Key`  <a name="cfn-cloudfront-distribution-tag-key"></a>
A string that contains `Tag` key.  
The string length should be between 1 and 128 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-distribution-tag-value"></a>
A string that contains an optional `Tag` value.  
The string length should be between 0 and 256 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution TenantConfig
<a name="aws-properties-cloudfront-distribution-tenantconfig"></a>

**Note**  
This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.

The configuration for a distribution tenant.

## Syntax
<a name="aws-properties-cloudfront-distribution-tenantconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-tenantconfig-syntax.json"></a>

```
{
  "[ParameterDefinitions](#cfn-cloudfront-distribution-tenantconfig-parameterdefinitions)" : [ ParameterDefinition, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-tenantconfig-syntax.yaml"></a>

```
  [ParameterDefinitions](#cfn-cloudfront-distribution-tenantconfig-parameterdefinitions): 
    - ParameterDefinition
```

## Properties
<a name="aws-properties-cloudfront-distribution-tenantconfig-properties"></a>

`ParameterDefinitions`  <a name="cfn-cloudfront-distribution-tenantconfig-parameterdefinitions"></a>
The parameters that you specify for a distribution tenant.  
*Required*: No  
*Type*: Array of [ParameterDefinition](aws-properties-cloudfront-distribution-parameterdefinition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution TrustStoreConfig
<a name="aws-properties-cloudfront-distribution-truststoreconfig"></a>

A trust store configuration.

## Syntax
<a name="aws-properties-cloudfront-distribution-truststoreconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-truststoreconfig-syntax.json"></a>

```
{
  "[AdvertiseTrustStoreCaNames](#cfn-cloudfront-distribution-truststoreconfig-advertisetruststorecanames)" : Boolean,
  "[IgnoreCertificateExpiry](#cfn-cloudfront-distribution-truststoreconfig-ignorecertificateexpiry)" : Boolean,
  "[TrustStoreId](#cfn-cloudfront-distribution-truststoreconfig-truststoreid)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-truststoreconfig-syntax.yaml"></a>

```
  [AdvertiseTrustStoreCaNames](#cfn-cloudfront-distribution-truststoreconfig-advertisetruststorecanames): Boolean
  [IgnoreCertificateExpiry](#cfn-cloudfront-distribution-truststoreconfig-ignorecertificateexpiry): Boolean
  [TrustStoreId](#cfn-cloudfront-distribution-truststoreconfig-truststoreid): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-truststoreconfig-properties"></a>

`AdvertiseTrustStoreCaNames`  <a name="cfn-cloudfront-distribution-truststoreconfig-advertisetruststorecanames"></a>
The configuration to use to advertise trust store CA names.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IgnoreCertificateExpiry`  <a name="cfn-cloudfront-distribution-truststoreconfig-ignorecertificateexpiry"></a>
The configuration to use to ignore certificate expiration.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrustStoreId`  <a name="cfn-cloudfront-distribution-truststoreconfig-truststoreid"></a>
The trust store ID.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution ViewerCertificate
<a name="aws-properties-cloudfront-distribution-viewercertificate"></a>

A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

If the distribution doesn't use `Aliases` (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`—set `CloudFrontDefaultCertificate` to `true` and leave all other fields empty.

If the distribution uses `Aliases` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:
+ Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI.
  + To accept HTTPS connections from only viewers that support SNI, set `SSLSupportMethod` to `sni-only`. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is `SslSupportMethod`. Note the different capitalization.)
  + To accept HTTPS connections from all viewers, including those that don't support SNI, set `SSLSupportMethod` to `vip`. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is `SslSupportMethod`. Note the different capitalization.)
+ The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for `MinimumProtocolVersion`. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*.
+ The location of the SSL/TLS certificate, [AWS Certificate Manager (ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [AWS Identity and Access Management (IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both):
  + `ACMCertificateArn` (In CloudFormation, this field name is `AcmCertificateArn`. Note the different capitalization.)
  + `IAMCertificateId` (In CloudFormation, this field name is `IamCertificateId`. Note the different capitalization.)

All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use `ViewerProtocolPolicy` in the `CacheBehavior` or `DefaultCacheBehavior`. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use `CustomOriginConfig`.

For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [ Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-distribution-viewercertificate-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-viewercertificate-syntax.json"></a>

```
{
  "[AcmCertificateArn](#cfn-cloudfront-distribution-viewercertificate-acmcertificatearn)" : String,
  "[CloudFrontDefaultCertificate](#cfn-cloudfront-distribution-viewercertificate-cloudfrontdefaultcertificate)" : Boolean,
  "[IamCertificateId](#cfn-cloudfront-distribution-viewercertificate-iamcertificateid)" : String,
  "[MinimumProtocolVersion](#cfn-cloudfront-distribution-viewercertificate-minimumprotocolversion)" : String,
  "[SslSupportMethod](#cfn-cloudfront-distribution-viewercertificate-sslsupportmethod)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-viewercertificate-syntax.yaml"></a>

```
  [AcmCertificateArn](#cfn-cloudfront-distribution-viewercertificate-acmcertificatearn): String
  [CloudFrontDefaultCertificate](#cfn-cloudfront-distribution-viewercertificate-cloudfrontdefaultcertificate): Boolean
  [IamCertificateId](#cfn-cloudfront-distribution-viewercertificate-iamcertificateid): String
  [MinimumProtocolVersion](#cfn-cloudfront-distribution-viewercertificate-minimumprotocolversion): String
  [SslSupportMethod](#cfn-cloudfront-distribution-viewercertificate-sslsupportmethod): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-viewercertificate-properties"></a>

`AcmCertificateArn`  <a name="cfn-cloudfront-distribution-viewercertificate-acmcertificatearn"></a>
In CloudFormation, this field name is `AcmCertificateArn`. Note the different capitalization.
If the distribution uses `Aliases` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [AWS Certificate Manager (ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), 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 for `MinimumProtocolVersion` and `SSLSupportMethod`. (In CloudFormation, the field name is `SslSupportMethod`. Note the different capitalization.)  
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudFrontDefaultCertificate`  <a name="cfn-cloudfront-distribution-viewercertificate-cloudfrontdefaultcertificate"></a>
If the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, set this field to `true`.  
If the distribution uses `Aliases` (alternate domain names or CNAMEs), omit this field and specify values for the following fields:  
+ `AcmCertificateArn` or `IamCertificateId` (specify a value for one, not both) 
+  `MinimumProtocolVersion` 
+  `SslSupportMethod` 
*Required*: Conditional  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamCertificateId`  <a name="cfn-cloudfront-distribution-viewercertificate-iamcertificateid"></a>
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.
In CloudFormation, this field name is `IamCertificateId`. Note the different capitalization.
If the distribution uses `Aliases` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [AWS Identity and Access Management (IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate.  
If you specify an IAM certificate ID, you must also specify values for `MinimumProtocolVersion` and `SSLSupportMethod`. (In CloudFormation, the field name is `SslSupportMethod`. Note the different capitalization.)  
*Required*: Conditional  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `32`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinimumProtocolVersion`  <a name="cfn-cloudfront-distribution-viewercertificate-minimumprotocolversion"></a>
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](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) 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` to `sni-only`), you must specify `TLSv1` or higher. (In CloudFormation, the field name is `SslSupportMethod`. Note the different capitalization.)  
If the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net` (you set `CloudFrontDefaultCertificate` to `true`), CloudFront automatically sets the security policy to `TLSv1` regardless of the value that you set here.  
*Required*: Conditional  
*Type*: String  
*Allowed values*: `SSLv3 | TLSv1 | TLSv1_2016 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021 | TLSv1.3_2025 | TLSv1.2_2025`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslSupportMethod`  <a name="cfn-cloudfront-distribution-viewercertificate-sslsupportmethod"></a>
In CloudFormation, this field name is `SslSupportMethod`. Note the different capitalization.
If the distribution uses `Aliases` (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)](https://en.wikipedia.org/wiki/Server_Name_Indication). 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 [Support Center](https://console.aws.amazon.com/support/home).
If the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, don't set a value for this field.  
*Required*: Conditional  
*Type*: String  
*Allowed values*: `sni-only | vip | static-ip`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-distribution-viewercertificate--seealso"></a>
+ [ViewerCertificate](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::Distribution ViewerMtlsConfig
<a name="aws-properties-cloudfront-distribution-viewermtlsconfig"></a>

A viewer mTLS configuration.

## Syntax
<a name="aws-properties-cloudfront-distribution-viewermtlsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-viewermtlsconfig-syntax.json"></a>

```
{
  "[Mode](#cfn-cloudfront-distribution-viewermtlsconfig-mode)" : String,
  "[TrustStoreConfig](#cfn-cloudfront-distribution-viewermtlsconfig-truststoreconfig)" : TrustStoreConfig
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-viewermtlsconfig-syntax.yaml"></a>

```
  [Mode](#cfn-cloudfront-distribution-viewermtlsconfig-mode): String
  [TrustStoreConfig](#cfn-cloudfront-distribution-viewermtlsconfig-truststoreconfig): 
    TrustStoreConfig
```

## Properties
<a name="aws-properties-cloudfront-distribution-viewermtlsconfig-properties"></a>

`Mode`  <a name="cfn-cloudfront-distribution-viewermtlsconfig-mode"></a>
The viewer mTLS mode.  
*Required*: No  
*Type*: String  
*Allowed values*: `required | optional`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrustStoreConfig`  <a name="cfn-cloudfront-distribution-viewermtlsconfig-truststoreconfig"></a>
The trust store configuration associated with the viewer mTLS configuration.  
*Required*: No  
*Type*: [TrustStoreConfig](aws-properties-cloudfront-distribution-truststoreconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Distribution VpcOriginConfig
<a name="aws-properties-cloudfront-distribution-vpcoriginconfig"></a>

An Amazon CloudFront VPC origin configuration.

## Syntax
<a name="aws-properties-cloudfront-distribution-vpcoriginconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distribution-vpcoriginconfig-syntax.json"></a>

```
{
  "[OriginKeepaliveTimeout](#cfn-cloudfront-distribution-vpcoriginconfig-originkeepalivetimeout)" : Integer,
  "[OriginReadTimeout](#cfn-cloudfront-distribution-vpcoriginconfig-originreadtimeout)" : Integer,
  "[OwnerAccountId](#cfn-cloudfront-distribution-vpcoriginconfig-owneraccountid)" : String,
  "[VpcOriginId](#cfn-cloudfront-distribution-vpcoriginconfig-vpcoriginid)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distribution-vpcoriginconfig-syntax.yaml"></a>

```
  [OriginKeepaliveTimeout](#cfn-cloudfront-distribution-vpcoriginconfig-originkeepalivetimeout): Integer
  [OriginReadTimeout](#cfn-cloudfront-distribution-vpcoriginconfig-originreadtimeout): Integer
  [OwnerAccountId](#cfn-cloudfront-distribution-vpcoriginconfig-owneraccountid): String
  [VpcOriginId](#cfn-cloudfront-distribution-vpcoriginconfig-vpcoriginid): String
```

## Properties
<a name="aws-properties-cloudfront-distribution-vpcoriginconfig-properties"></a>

`OriginKeepaliveTimeout`  <a name="cfn-cloudfront-distribution-vpcoriginconfig-originkeepalivetimeout"></a>
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.  
For more information, see [Keep-alive timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginReadTimeout`  <a name="cfn-cloudfront-distribution-vpcoriginconfig-originreadtimeout"></a>
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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.  
For more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OwnerAccountId`  <a name="cfn-cloudfront-distribution-vpcoriginconfig-owneraccountid"></a>
The account ID of the AWS account that owns the VPC origin.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcOriginId`  <a name="cfn-cloudfront-distribution-vpcoriginconfig-vpcoriginid"></a>
The VPC origin ID.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::DistributionTenant
<a name="aws-resource-cloudfront-distributiontenant"></a>

The distribution tenant.

## Syntax
<a name="aws-resource-cloudfront-distributiontenant-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-distributiontenant-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::DistributionTenant",
  "Properties" : {
      "[ConnectionGroupId](#cfn-cloudfront-distributiontenant-connectiongroupid)" : String,
      "[Customizations](#cfn-cloudfront-distributiontenant-customizations)" : Customizations,
      "[DistributionId](#cfn-cloudfront-distributiontenant-distributionid)" : String,
      "[Domains](#cfn-cloudfront-distributiontenant-domains)" : [ String, ... ],
      "[Enabled](#cfn-cloudfront-distributiontenant-enabled)" : Boolean,
      "[ManagedCertificateRequest](#cfn-cloudfront-distributiontenant-managedcertificaterequest)" : ManagedCertificateRequest,
      "[Name](#cfn-cloudfront-distributiontenant-name)" : String,
      "[Parameters](#cfn-cloudfront-distributiontenant-parameters)" : [ Parameter, ... ],
      "[Tags](#cfn-cloudfront-distributiontenant-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-cloudfront-distributiontenant-syntax.yaml"></a>

```
Type: AWS::CloudFront::DistributionTenant
Properties:
  [ConnectionGroupId](#cfn-cloudfront-distributiontenant-connectiongroupid): String
  [Customizations](#cfn-cloudfront-distributiontenant-customizations): 
    Customizations
  [DistributionId](#cfn-cloudfront-distributiontenant-distributionid): String
  [Domains](#cfn-cloudfront-distributiontenant-domains): 
    - String
  [Enabled](#cfn-cloudfront-distributiontenant-enabled): Boolean
  [ManagedCertificateRequest](#cfn-cloudfront-distributiontenant-managedcertificaterequest): 
    ManagedCertificateRequest
  [Name](#cfn-cloudfront-distributiontenant-name): String
  [Parameters](#cfn-cloudfront-distributiontenant-parameters): 
    - Parameter
  [Tags](#cfn-cloudfront-distributiontenant-tags): 
    - Tag
```

## Properties
<a name="aws-resource-cloudfront-distributiontenant-properties"></a>

`ConnectionGroupId`  <a name="cfn-cloudfront-distributiontenant-connectiongroupid"></a>
The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Customizations`  <a name="cfn-cloudfront-distributiontenant-customizations"></a>
Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and AWS WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.  
*Required*: No  
*Type*: [Customizations](aws-properties-cloudfront-distributiontenant-customizations.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DistributionId`  <a name="cfn-cloudfront-distributiontenant-distributionid"></a>
The ID of the multi-tenant distribution.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Domains`  <a name="cfn-cloudfront-distributiontenant-domains"></a>
The domains associated with the distribution tenant.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-cloudfront-distributiontenant-enabled"></a>
Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ManagedCertificateRequest`  <a name="cfn-cloudfront-distributiontenant-managedcertificaterequest"></a>
An object that represents the request for the Amazon CloudFront managed ACM certificate.  
*Required*: No  
*Type*: [ManagedCertificateRequest](aws-properties-cloudfront-distributiontenant-managedcertificaterequest.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-distributiontenant-name"></a>
The name of the distribution tenant.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Parameters`  <a name="cfn-cloudfront-distributiontenant-parameters"></a>
A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.  
*Required*: No  
*Type*: Array of [Parameter](aws-properties-cloudfront-distributiontenant-parameter.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-cloudfront-distributiontenant-tags"></a>
A complex type that contains zero or more `Tag` elements.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cloudfront-distributiontenant-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-distributiontenant-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-distributiontenant-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-cloudfront-distributiontenant-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-cloudfront-distributiontenant-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the distribution tenant.

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
The date and time when the distribution tenant was created.

`DomainResults`  <a name="DomainResults-fn::getatt"></a>
Property description not available.

`ETag`  <a name="ETag-fn::getatt"></a>
The current version of the distribution tenant.

`Id`  <a name="Id-fn::getatt"></a>
The ID of the distribution tenant.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The date and time when the distribution tenant was updated.

`Status`  <a name="Status-fn::getatt"></a>
The status of the distribution tenant.

## Examples
<a name="aws-resource-cloudfront-distributiontenant--examples"></a>



**Topics**
+ [Create a distribution tenant that inherits its certificate](#aws-resource-cloudfront-distributiontenant--examples--Create_a_distribution_tenant_that_inherits_its_certificate)
+ [Create a distribution tenant with its own certificate](#aws-resource-cloudfront-distributiontenant--examples--Create_a_distribution_tenant_with_its_own_certificate)
+ [Create a CloudFront hosted distribution tenant](#aws-resource-cloudfront-distributiontenant--examples--Create_a_hosted_distribution_tenant)
+ [Create a self hosted distribution tenant](#aws-resource-cloudfront-distributiontenant--examples--Create_a_self_hosted_distribution_tenant)

### Create a distribution tenant that inherits its certificate
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_distribution_tenant_that_inherits_its_certificate"></a>

The following example specifies a distribution tenant that inherits its certificate from its parent multi-tenant distribution.

#### JSON
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_distribution_tenant_that_inherits_its_certificate--json"></a>

```
{
  "Resources": {
    "MyMultiTenantDistribution": {
      "Type": "AWS::CloudFront::Distribution",
      "Properties": {
        "DistributionConfig": {
          "ConnectionMode": "tenant-only",
          "ViewerCertificate": {
            "AcmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/1954f095-11b6-4daf-9952-0c308a00944d",
            "SslSupportMethod": "sni-only"
          },
          "TenantConfig": {
            "ParameterDefinitions": [
              {
                "Name": "tenantName",
                "Definition": {
                  "StringSchema": {
                    "Comment": "Tenant name",
                    "DefaultValue": "root",
                    "Required": false
                  }
                }
              }
            ]
          },
          "DefaultCacheBehavior": {
            "TargetOriginId": "MyBucket.Arn",
            "ViewerProtocolPolicy": "allow-all",
            "AllowedMethods": [
              "GET",
              "HEAD"
            ],
            "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6"
          },
          "Enabled": true,
          "Origins": [
            {
              "DomainName": "MyBucket.RegionalDomainName",
              "Id": "MyBucket.Arn",
              "OriginPath": "/{{tenantName}}",
              "S3OriginConfig": {
                "OriginAccessIdentity": ""
              }
            }
          ]
        }
      }
    },
    "MyBucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "amzn-s3-demo-bucket",
        "BucketEncryption": {
          "ServerSideEncryptionConfiguration": [
            {
              "ServerSideEncryptionByDefault": {
                "SSEAlgorithm": "aws:kms",
                "KMSMasterKeyID": "alias/aws/s3"
              }
            }
          ]
        },
        "PublicAccessBlockConfiguration": {
          "IgnorePublicAcls": true,
          "RestrictPublicBuckets": true
        }
      }
    },
    "MyBucketBucketPolicy": {
      "Type": "AWS::S3::BucketPolicy",
      "Properties": {
        "Bucket": "MyBucket",
        "PolicyDocument": {
          "Id": "RequireEncryptionInTransit",
          "Version": "2012-10-17",		 	 	 
          "Statement": [
            {
              "Principal": "*",
              "Action": "*",
              "Effect": "Deny",
              "Resource": [
                "MyBucket.Arn",
                "${MyBucket.Arn}/*"
              ],
              "Condition": {
                "Bool": {
                  "aws:SecureTransport": "false"
                }
              }
            }
          ]
        }
      }
    },
    "MyDistributionTenant": {
      "Type": "AWS::CloudFront::DistributionTenant",
      "Properties": {
        "Domains": [
          "my-distribution-tenant.example.com"
        ],
        "DistributionId": "MyMultiTenantDistribution.Id",
        "Name": "MyDistributionTenant",
        "Enabled": true,
        "Parameters": [
          {
            "Name": "tenantName",
            "Value": "first-user"
          }
        ]
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_distribution_tenant_that_inherits_its_certificate--yaml"></a>

```
Resources:
  MyMultiTenantDistribution:
    Type: AWS::CloudFront::Distribution
    Properties:
      DistributionConfig:
        ConnectionMode: tenant-only
        ViewerCertificate:
          AcmCertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/1954f095-11b6-4daf-9952-0c308a00944d
          SslSupportMethod: sni-only
        TenantConfig: 
          ParameterDefinitions:
            - Name: tenantName
              Definition:
                StringSchema:
                  Comment: "Tenant name"
                  DefaultValue: "root"
                  Required: false
        DefaultCacheBehavior:
          TargetOriginId: !GetAtt MyBucket.Arn
          ViewerProtocolPolicy: allow-all
          AllowedMethods:
            - GET
            - HEAD
          CachePolicyId: 658327ea-f89d-4fab-a63d-7e88639e58f6 # CachingOptimized PolicyId
        Enabled: true
        Origins:
          - DomainName: !GetAtt MyBucket.RegionalDomainName
            Id: !GetAtt MyBucket.Arn
            OriginPath: "/{{tenantName}}"
            S3OriginConfig:
              OriginAccessIdentity: ""
  
  MyBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: amzn-s3-demo-bucket
      BucketEncryption:
        ServerSideEncryptionConfiguration:
          - ServerSideEncryptionByDefault:
              SSEAlgorithm: aws:kms
              KMSMasterKeyID: alias/aws/s3
      PublicAccessBlockConfiguration:
        IgnorePublicAcls: true
        RestrictPublicBuckets: true
  MyBucketBucketPolicy:
    Type: AWS::S3::BucketPolicy
    Properties:
      Bucket: !Ref MyBucket
      PolicyDocument:
        Id: RequireEncryptionInTransit
        Version: '2012-10-17		 	 	 '
        Statement:
          - Principal: '*'
            Action: '*'
            Effect: Deny
            Resource:
              - !GetAtt MyBucket.Arn
              - !Sub ${MyBucket.Arn}/*
            Condition:
              Bool:
                aws:SecureTransport: 'false'
  
  MyDistributionTenant:
    Type: AWS::CloudFront::DistributionTenant
    Properties:
      Domains:
        - my-distribution-tenant.example.com
      DistributionId: !GetAtt MyMultiTenantDistribution.Id
      Name: MyDistributionTenant
      Enabled: true
      Parameters:
        - Name: tenantName
          Value: first-user
```

### Create a distribution tenant with its own certificate
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_distribution_tenant_with_its_own_certificate"></a>

The following example specifies a distribution tenant with its own certificate.

#### JSON
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_distribution_tenant_with_its_own_certificate--json"></a>

```
{
  "Resources": {
    "MyMultiTenantDistribution": {
      "Type": "AWS::CloudFront::Distribution",
      "Properties": {
        "DistributionConfig": {
          "ConnectionMode": "tenant-only",
          "ViewerCertificate": {
            "AcmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/1954f095-11b6-4daf-9952-0c308a00944d",
            "SslSupportMethod": "sni-only"
          },
          "TenantConfig": {
            "ParameterDefinitions": [
              {
                "Name": "tenantName",
                "Definition": {
                  "StringSchema": {
                    "Comment": "Tenant name",
                    "DefaultValue": "root",
                    "Required": false
                  }
                }
              }
            ]
          },
          "DefaultCacheBehavior": {
            "TargetOriginId": "MyBucket.Arn",
            "ViewerProtocolPolicy": "allow-all",
            "AllowedMethods": [
              "GET",
              "HEAD"
            ],
            "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6"
          },
          "Enabled": true,
          "Origins": [
            {
              "DomainName": "MyBucket.RegionalDomainName",
              "Id": "MyBucket.Arn",
              "OriginPath": "/{{tenantName}}",
              "S3OriginConfig": {
                "OriginAccessIdentity": ""
              }
            }
          ]
        }
      }
    },
    "MyBucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "amzn-s3-demo-bucket",
        "BucketEncryption": {
          "ServerSideEncryptionConfiguration": [
            {
              "ServerSideEncryptionByDefault": {
                "SSEAlgorithm": "aws:kms",
                "KMSMasterKeyID": "alias/aws/s3"
              }
            }
          ]
        },
        "PublicAccessBlockConfiguration": {
          "IgnorePublicAcls": true,
          "RestrictPublicBuckets": true
        }
      }
    },
    "MyBucketBucketPolicy": {
      "Type": "AWS::S3::BucketPolicy",
      "Properties": {
        "Bucket": "MyBucket",
        "PolicyDocument": {
          "Id": "RequireEncryptionInTransit",
          "Version": "2012-10-17",		 	 	 
          "Statement": [
            {
              "Principal": "*",
              "Action": "*",
              "Effect": "Deny",
              "Resource": [
                "MyBucket.Arn",
                "${MyBucket.Arn}/*"
              ],
              "Condition": {
                "Bool": {
                  "aws:SecureTransport": "false"
                }
              }
            }
          ]
        }
      }
    },
    "MyDistributionTenant": {
      "Type": "AWS::CloudFront::DistributionTenant",
      "Properties": {
        "Domains": [
          "my-distribution-tenant.example.com"
        ],
        "DistributionId": "MyMultiTenantDistribution.Id",
        "Name": "MyDistributionTenant",
        "Enabled": true,
        "Parameters": [
          {
            "Name": "tenantName",
            "Value": "first-user"
          }
        ]
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_distribution_tenant_with_its_own_certificate--yaml"></a>

```
Resources:
  MyMultiTenantDistribution:
    Type: AWS::CloudFront::Distribution
    Properties:
      DistributionConfig:
        ConnectionMode: tenant-only
        TenantConfig: 
          ParameterDefinitions:
            - Name: tenantName
              Definition:
                StringSchema:
                  Comment: "Tenant name"
                  DefaultValue: "root"
                  Required: false
        DefaultCacheBehavior:
          TargetOriginId: !GetAtt MyBucket.Arn
          ViewerProtocolPolicy: allow-all
          AllowedMethods:
            - GET
            - HEAD
          CachePolicyId: 658327ea-f89d-4fab-a63d-7e88639e58f6 # CachingOptimized PolicyId
        Enabled: true
        Origins:
          - DomainName: !GetAtt MyBucket.RegionalDomainName
            Id: !GetAtt MyBucket.Arn
            OriginPath: "/{{tenantName}}"
            S3OriginConfig:
              OriginAccessIdentity: ""
  
  MyBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: amzn-s3-demo-bucket
      BucketEncryption:
        ServerSideEncryptionConfiguration:
          - ServerSideEncryptionByDefault:
              SSEAlgorithm: aws:kms
              KMSMasterKeyID: alias/aws/s3
      PublicAccessBlockConfiguration:
        IgnorePublicAcls: true
        RestrictPublicBuckets: true
  MyBucketBucketPolicy:
    Type: AWS::S3::BucketPolicy
    Properties:
      Bucket: !Ref MyBucket
      PolicyDocument:
        Id: RequireEncryptionInTransit
        Version: '2012-10-17		 	 	 '
        Statement:
          - Principal: '*'
            Action: '*'
            Effect: Deny
            Resource:
              - !GetAtt MyBucket.Arn
              - !Sub ${MyBucket.Arn}/*
            Condition:
              Bool:
                aws:SecureTransport: 'false'
  
  MyDistributionTenant:
    Type: AWS::CloudFront::DistributionTenant
    Properties:
      Domains:
        - my-distribution-tenant.example.com
      DistributionId: !GetAtt MyMultiTenantDistribution.Id
      Name: MyDistributionTenant
      Enabled: true
      Customizations:
        Certificate:
          Arn: arn:aws:acm:us-east-1:123456789012:certificate/1954f095-11b6-4daf-9952-0c308a00944d
      Parameters:
        - Name: tenantName
          Value: first-user
```

### Create a CloudFront hosted distribution tenant
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_hosted_distribution_tenant"></a>

The following example specifies a CloudFront hosted distribution tenant.

#### JSON
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_hosted_distribution_tenant--json"></a>

```
{
  "Resources": {
    "MyMultiTenantDistribution": {
      "Type": "AWS::CloudFront::Distribution",
      "Properties": {
        "DistributionConfig": {
          "ConnectionMode": "tenant-only",
          "TenantConfig": {
            "ParameterDefinitions": [
              {
                "Name": "tenantName",
                "Definition": {
                  "StringSchema": {
                    "Comment": "Tenant name",
                    "DefaultValue": "root",
                    "Required": false
                  }
                }
              }
            ]
          },
          "DefaultCacheBehavior": {
            "TargetOriginId": "MyBucket.Arn",
            "ViewerProtocolPolicy": "allow-all",
            "AllowedMethods": [
              "GET",
              "HEAD"
            ],
            "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6"
          },
          "Enabled": true,
          "Origins": [
            {
              "DomainName": "MyBucket.RegionalDomainName",
              "Id": "MyBucket.Arn",
              "OriginPath": "/{{tenantName}}",
              "S3OriginConfig": {
                "OriginAccessIdentity": ""
              }
            }
          ]
        }
      }
    },
    "MyBucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "amzn-s3-demo-bucket",
        "BucketEncryption": {
          "ServerSideEncryptionConfiguration": [
            {
              "ServerSideEncryptionByDefault": {
                "SSEAlgorithm": "aws:kms",
                "KMSMasterKeyID": "alias/aws/s3"
              }
            }
          ]
        },
        "PublicAccessBlockConfiguration": {
          "IgnorePublicAcls": true,
          "RestrictPublicBuckets": true
        }
      }
    },
    "MyBucketBucketPolicy": {
      "Type": "AWS::S3::BucketPolicy",
      "Properties": {
        "Bucket": "MyBucket",
        "PolicyDocument": {
          "Id": "RequireEncryptionInTransit",
          "Version": "2012-10-17",		 	 	 
          "Statement": [
            {
              "Principal": "*",
              "Action": "*",
              "Effect": "Deny",
              "Resource": [
                "MyBucket.Arn",
                "${MyBucket.Arn}/*"
              ],
              "Condition": {
                "Bool": {
                  "aws:SecureTransport": "false"
                }
              }
            }
          ]
        }
      }
    },
    "MyConnectionGroup": {
      "Type": "AWS::CloudFront::ConnectionGroup",
      "Properties": {
        "Name": "cf-hosted-connection-group-cfn"
      }
    },
    "RecordSet": {
      "Type": "AWS::Route53::RecordSet",
      "Properties": {
        "Name": "my-distribution-tenant.example.com",
        "Type": "CNAME",
        "HostedZoneId": "Z06559422OQIFCZO0EORK",
        "TTL": 300,
        "ResourceRecords": [
          "MyConnectionGroup.RoutingEndpoint"
        ]
      }
    },
    "MyDistributionTenant": {
      "Type": "AWS::CloudFront::DistributionTenant",
      "Properties": {
        "ConnectionGroupId": "MyConnectionGroup.Id",
        "Domains": [
          "my-distribution-tenant.example.com"
        ],
        "DistributionId": "MyMultiTenantDistribution.Id",
        "Name": "MyDistributionTenant",
        "Enabled": true,
        "ManagedCertificateRequest": {
          "ValidationTokenHost": "cloudfront"
        },
        "Parameters": [
          {
            "Name": "tenantName",
            "Value": "first-user"
          }
        ]
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_hosted_distribution_tenant--yaml"></a>

```
Resources:
  MyMultiTenantDistribution:
    Type: AWS::CloudFront::Distribution
    Properties:
      DistributionConfig:
        ConnectionMode: tenant-only
        TenantConfig: 
          ParameterDefinitions:
            - Name: tenantName
              Definition:
                StringSchema:
                  Comment: "Tenant name"
                  DefaultValue: "root"
                  Required: false
        DefaultCacheBehavior:
          TargetOriginId: !GetAtt MyBucket.Arn
          ViewerProtocolPolicy: allow-all
          AllowedMethods:
            - GET
            - HEAD
          CachePolicyId: 658327ea-f89d-4fab-a63d-7e88639e58f6 # CachingOptimized PolicyId
        Enabled: true
        Origins:
          - DomainName: !GetAtt MyBucket.RegionalDomainName
            Id: !GetAtt MyBucket.Arn
            OriginPath: "/{{tenantName}}"
            S3OriginConfig:
              OriginAccessIdentity: ""
  
  MyBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: amzn-s3-demo-bucket
      BucketEncryption:
        ServerSideEncryptionConfiguration:
          - ServerSideEncryptionByDefault:
              SSEAlgorithm: aws:kms
              KMSMasterKeyID: alias/aws/s3
      PublicAccessBlockConfiguration:
        IgnorePublicAcls: true
        RestrictPublicBuckets: true
  MyBucketBucketPolicy:
    Type: AWS::S3::BucketPolicy
    Properties:
      Bucket: !Ref MyBucket
      PolicyDocument:
        Id: RequireEncryptionInTransit
        Version: '2012-10-17		 	 	 '
        Statement:
          - Principal: '*'
            Action: '*'
            Effect: Deny
            Resource:
              - !GetAtt MyBucket.Arn
              - !Sub ${MyBucket.Arn}/*
            Condition:
              Bool:
                aws:SecureTransport: 'false'

  MyConnectionGroup:
    Type: AWS::CloudFront::ConnectionGroup
    Properties:
      Name: cf-hosted-connection-group-cfn

  RecordSet:
    Type: AWS::Route53::RecordSet
    Properties:
      Name: my-distribution-tenant.example.com
      Type: CNAME
      HostedZoneId: Z06559422OQIFCZO0EORK
      TTL: 300
      ResourceRecords: 
        - !GetAtt MyConnectionGroup.RoutingEndpoint
  
  MyDistributionTenant:
    Type: AWS::CloudFront::DistributionTenant
    Properties:
      ConnectionGroupId: !GetAtt MyConnectionGroup.Id
      Domains:
        - my-distribution-tenant.example.com
      DistributionId: !GetAtt MyMultiTenantDistribution.Id
      Name: MyDistributionTenant
      Enabled: true
      ManagedCertificateRequest:
        ValidationTokenHost: cloudfront
      Parameters:
        - Name: tenantName
          Value: first-user
```

### Create a self hosted distribution tenant
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_self_hosted_distribution_tenant"></a>

The following example specifies a self hosted distribution tenant.

**Important**  
You must set up token validation for the distribution tenant when using this option. For more information, see [Request certificates for your CloudFront distribution tenant](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managed-cloudfront-certificates.html) in the *Amazon CloudFront Developer Guide*.

#### JSON
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_self_hosted_distribution_tenant--json"></a>

```
{
  "Resources": {
    "MyMultiTenantDistribution": {
      "Type": "AWS::CloudFront::Distribution",
      "Properties": {
        "DistributionConfig": {
          "ConnectionMode": "tenant-only",
          "TenantConfig": {
            "ParameterDefinitions": [
              {
                "Name": "tenantName",
                "Definition": {
                  "StringSchema": {
                    "Comment": "Tenant name",
                    "DefaultValue": "root",
                    "Required": false
                  }
                }
              }
            ]
          },
          "DefaultCacheBehavior": {
            "TargetOriginId": "MyBucket.Arn",
            "ViewerProtocolPolicy": "allow-all",
            "AllowedMethods": [
              "GET",
              "HEAD"
            ],
            "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6"
          },
          "Enabled": true,
          "Origins": [
            {
              "DomainName": "MyBucket.RegionalDomainName",
              "Id": "MyBucket.Arn",
              "OriginPath": "/{{tenantName}}",
              "S3OriginConfig": {
                "OriginAccessIdentity": ""
              }
            }
          ]
        }
      }
    },
    "MyBucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "amzn-s3-demo-bucket",
        "BucketEncryption": {
          "ServerSideEncryptionConfiguration": [
            {
              "ServerSideEncryptionByDefault": {
                "SSEAlgorithm": "aws:kms",
                "KMSMasterKeyID": "alias/aws/s3"
              }
            }
          ]
        },
        "PublicAccessBlockConfiguration": {
          "IgnorePublicAcls": true,
          "RestrictPublicBuckets": true
        }
      }
    },
    "MyBucketBucketPolicy": {
      "Type": "AWS::S3::BucketPolicy",
      "Properties": {
        "Bucket": "MyBucket",
        "PolicyDocument": {
          "Id": "RequireEncryptionInTransit",
          "Version": "2012-10-17",		 	 	 
          "Statement": [
            {
              "Principal": "*",
              "Action": "*",
              "Effect": "Deny",
              "Resource": [
                "MyBucket.Arn",
                "${MyBucket.Arn}/*"
              ],
              "Condition": {
                "Bool": {
                  "aws:SecureTransport": "false"
                }
              }
            }
          ]
        }
      }
    },
    "MyConnectionGroup": {
      "Type": "AWS::CloudFront::ConnectionGroup",
      "Properties": {
        "Name": "cf-hosted-connection-group-cfn"
      }
    },
    "RecordSet": {
      "Type": "AWS::Route53::RecordSet",
      "Properties": {
        "Name": "my-distribution-tenant.example.com",
        "Type": "CNAME",
        "HostedZoneId": "Z06559422OQIFCZO0EORK",
        "TTL": 300,
        "ResourceRecords": [
          "MyConnectionGroup.RoutingEndpoint"
        ]
      }
    },
    "MyDistributionTenant": {
      "Type": "AWS::CloudFront::DistributionTenant",
      "Properties": {
        "ConnectionGroupId": "MyConnectionGroup.Id",
        "Domains": [
          "my-distribution-tenant.example.com"
        ],
        "DistributionId": "MyMultiTenantDistribution.Id",
        "Name": "MyDistributionTenant",
        "Enabled": true,
        "ManagedCertificateRequest": {
          "ValidationTokenHost": "self-hosted",
          "PrimaryDomainName": "my-distribution-tenant.example.com"
        },
        "Parameters": [
          {
            "Name": "tenantName",
            "Value": "first-user"
          }
        ]
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-cloudfront-distributiontenant--examples--Create_a_self_hosted_distribution_tenant--yaml"></a>

```
Resources:
  MyMultiTenantDistribution:
    Type: AWS::CloudFront::Distribution
    Properties:
      DistributionConfig:
        ConnectionMode: tenant-only
        TenantConfig: 
          ParameterDefinitions:
            - Name: tenantName
              Definition:
                StringSchema:
                  Comment: "Tenant name"
                  DefaultValue: "root"
                  Required: false
        DefaultCacheBehavior:
          TargetOriginId: !GetAtt MyBucket.Arn
          ViewerProtocolPolicy: allow-all
          AllowedMethods:
            - GET
            - HEAD
          CachePolicyId: 658327ea-f89d-4fab-a63d-7e88639e58f6 # CachingOptimized PolicyId
        Enabled: true
        Origins:
          - DomainName: !GetAtt MyBucket.RegionalDomainName
            Id: !GetAtt MyBucket.Arn
            OriginPath: "/{{tenantName}}"
            S3OriginConfig:
              OriginAccessIdentity: ""
  
  MyBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: amzn-s3-demo-bucket
      BucketEncryption:
        ServerSideEncryptionConfiguration:
          - ServerSideEncryptionByDefault:
              SSEAlgorithm: aws:kms
              KMSMasterKeyID: alias/aws/s3
      PublicAccessBlockConfiguration:
        IgnorePublicAcls: true
        RestrictPublicBuckets: true
  MyBucketBucketPolicy:
    Type: AWS::S3::BucketPolicy
    Properties:
      Bucket: !Ref MyBucket
      PolicyDocument:
        Id: RequireEncryptionInTransit
        Version: '2012-10-17		 	 	 '
        Statement:
          - Principal: '*'
            Action: '*'
            Effect: Deny
            Resource:
              - !GetAtt MyBucket.Arn
              - !Sub ${MyBucket.Arn}/*
            Condition:
              Bool:
                aws:SecureTransport: 'false'

  MyConnectionGroup:
    Type: AWS::CloudFront::ConnectionGroup
    Properties:
      Name: cf-hosted-connection-group-cfn

  RecordSet:
    Type: AWS::Route53::RecordSet
    Properties:
      Name: my-distribution-tenant.example.com
      Type: CNAME
      HostedZoneId: Z06559422OQIFCZO0EORK
      TTL: 300
      ResourceRecords: 
        - !GetAtt MyConnectionGroup.RoutingEndpoint
  
  MyDistributionTenant:
    Type: AWS::CloudFront::DistributionTenant
    Properties:
      ConnectionGroupId: !GetAtt MyConnectionGroup.Id
      Domains:
        - my-distribution-tenant.example.com
      DistributionId: !GetAtt MyMultiTenantDistribution.Id
      Name: MyDistributionTenant
      Enabled: true
      ManagedCertificateRequest:
        ValidationTokenHost: self-hosted
        PrimaryDomainName: my-distribution-tenant.example.com
      Parameters:
        - Name: tenantName
          Value: first-user
```

## See also
<a name="aws-resource-cloudfront-distributiontenant--seealso"></a>
+ [Understand how multi-tenant distributions work](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html) in the *Amazon CloudFront Developer Guide*
+ [Request certificates for your CloudFront distribution tenant](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managed-cloudfront-certificates.html) in the *Amazon CloudFront Developer Guide*



# AWS::CloudFront::DistributionTenant Certificate
<a name="aws-properties-cloudfront-distributiontenant-certificate"></a>

The AWS Certificate Manager (ACM) certificate associated with your distribution.

## Syntax
<a name="aws-properties-cloudfront-distributiontenant-certificate-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distributiontenant-certificate-syntax.json"></a>

```
{
  "[Arn](#cfn-cloudfront-distributiontenant-certificate-arn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distributiontenant-certificate-syntax.yaml"></a>

```
  [Arn](#cfn-cloudfront-distributiontenant-certificate-arn): String
```

## Properties
<a name="aws-properties-cloudfront-distributiontenant-certificate-properties"></a>

`Arn`  <a name="cfn-cloudfront-distributiontenant-certificate-arn"></a>
The Amazon Resource Name (ARN) of the ACM certificate.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::DistributionTenant Customizations
<a name="aws-properties-cloudfront-distributiontenant-customizations"></a>

Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and AWS WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

## Syntax
<a name="aws-properties-cloudfront-distributiontenant-customizations-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distributiontenant-customizations-syntax.json"></a>

```
{
  "[Certificate](#cfn-cloudfront-distributiontenant-customizations-certificate)" : Certificate,
  "[GeoRestrictions](#cfn-cloudfront-distributiontenant-customizations-georestrictions)" : GeoRestrictionCustomization,
  "[WebAcl](#cfn-cloudfront-distributiontenant-customizations-webacl)" : WebAclCustomization
}
```

### YAML
<a name="aws-properties-cloudfront-distributiontenant-customizations-syntax.yaml"></a>

```
  [Certificate](#cfn-cloudfront-distributiontenant-customizations-certificate): 
    Certificate
  [GeoRestrictions](#cfn-cloudfront-distributiontenant-customizations-georestrictions): 
    GeoRestrictionCustomization
  [WebAcl](#cfn-cloudfront-distributiontenant-customizations-webacl): 
    WebAclCustomization
```

## Properties
<a name="aws-properties-cloudfront-distributiontenant-customizations-properties"></a>

`Certificate`  <a name="cfn-cloudfront-distributiontenant-customizations-certificate"></a>
The AWS Certificate Manager (ACM) certificate.  
*Required*: No  
*Type*: [Certificate](aws-properties-cloudfront-distributiontenant-certificate.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GeoRestrictions`  <a name="cfn-cloudfront-distributiontenant-customizations-georestrictions"></a>
The geographic restrictions.  
*Required*: No  
*Type*: [GeoRestrictionCustomization](aws-properties-cloudfront-distributiontenant-georestrictioncustomization.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WebAcl`  <a name="cfn-cloudfront-distributiontenant-customizations-webacl"></a>
The AWS WAF web ACL.  
*Required*: No  
*Type*: [WebAclCustomization](aws-properties-cloudfront-distributiontenant-webaclcustomization.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::DistributionTenant DomainResult
<a name="aws-properties-cloudfront-distributiontenant-domainresult"></a>

The details about the domain result.

## Syntax
<a name="aws-properties-cloudfront-distributiontenant-domainresult-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distributiontenant-domainresult-syntax.json"></a>

```
{
  "[Domain](#cfn-cloudfront-distributiontenant-domainresult-domain)" : String,
  "[Status](#cfn-cloudfront-distributiontenant-domainresult-status)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distributiontenant-domainresult-syntax.yaml"></a>

```
  [Domain](#cfn-cloudfront-distributiontenant-domainresult-domain): String
  [Status](#cfn-cloudfront-distributiontenant-domainresult-status): String
```

## Properties
<a name="aws-properties-cloudfront-distributiontenant-domainresult-properties"></a>

`Domain`  <a name="cfn-cloudfront-distributiontenant-domainresult-domain"></a>
The specified domain.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-cloudfront-distributiontenant-domainresult-status"></a>
Whether the domain is active or inactive.  
*Required*: No  
*Type*: String  
*Allowed values*: `active | inactive`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::DistributionTenant GeoRestrictionCustomization
<a name="aws-properties-cloudfront-distributiontenant-georestrictioncustomization"></a>

The customizations that you specified for the distribution tenant for geographic restrictions.

## Syntax
<a name="aws-properties-cloudfront-distributiontenant-georestrictioncustomization-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distributiontenant-georestrictioncustomization-syntax.json"></a>

```
{
  "[Locations](#cfn-cloudfront-distributiontenant-georestrictioncustomization-locations)" : [ String, ... ],
  "[RestrictionType](#cfn-cloudfront-distributiontenant-georestrictioncustomization-restrictiontype)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distributiontenant-georestrictioncustomization-syntax.yaml"></a>

```
  [Locations](#cfn-cloudfront-distributiontenant-georestrictioncustomization-locations): 
    - String
  [RestrictionType](#cfn-cloudfront-distributiontenant-georestrictioncustomization-restrictiontype): String
```

## Properties
<a name="aws-properties-cloudfront-distributiontenant-georestrictioncustomization-properties"></a>

`Locations`  <a name="cfn-cloudfront-distributiontenant-georestrictioncustomization-locations"></a>
The locations for geographic restrictions.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RestrictionType`  <a name="cfn-cloudfront-distributiontenant-georestrictioncustomization-restrictiontype"></a>
The method that you want to use to restrict distribution of your content by country:  
+ `none`: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.
+ `blacklist`: The `Location` elements specify the countries in which you don't want CloudFront to distribute your content.
+ `whitelist`: The `Location` elements specify the countries in which you want CloudFront to distribute your content.
*Required*: No  
*Type*: String  
*Allowed values*: `blacklist | whitelist | none`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::DistributionTenant ManagedCertificateRequest
<a name="aws-properties-cloudfront-distributiontenant-managedcertificaterequest"></a>

An object that represents the request for the Amazon CloudFront managed ACM certificate.

## Syntax
<a name="aws-properties-cloudfront-distributiontenant-managedcertificaterequest-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distributiontenant-managedcertificaterequest-syntax.json"></a>

```
{
  "[CertificateTransparencyLoggingPreference](#cfn-cloudfront-distributiontenant-managedcertificaterequest-certificatetransparencyloggingpreference)" : String,
  "[PrimaryDomainName](#cfn-cloudfront-distributiontenant-managedcertificaterequest-primarydomainname)" : String,
  "[ValidationTokenHost](#cfn-cloudfront-distributiontenant-managedcertificaterequest-validationtokenhost)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distributiontenant-managedcertificaterequest-syntax.yaml"></a>

```
  [CertificateTransparencyLoggingPreference](#cfn-cloudfront-distributiontenant-managedcertificaterequest-certificatetransparencyloggingpreference): String
  [PrimaryDomainName](#cfn-cloudfront-distributiontenant-managedcertificaterequest-primarydomainname): String
  [ValidationTokenHost](#cfn-cloudfront-distributiontenant-managedcertificaterequest-validationtokenhost): String
```

## Properties
<a name="aws-properties-cloudfront-distributiontenant-managedcertificaterequest-properties"></a>

`CertificateTransparencyLoggingPreference`  <a name="cfn-cloudfront-distributiontenant-managedcertificaterequest-certificatetransparencyloggingpreference"></a>
You can opt out of certificate transparency logging by specifying the `disabled` option. Opt in by specifying `enabled`. For more information, see [Certificate Transparency Logging ](https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency) in the *AWS Certificate Manager User Guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `enabled | disabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PrimaryDomainName`  <a name="cfn-cloudfront-distributiontenant-managedcertificaterequest-primarydomainname"></a>
The primary domain name associated with the CloudFront managed ACM certificate.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ValidationTokenHost`  <a name="cfn-cloudfront-distributiontenant-managedcertificaterequest-validationtokenhost"></a>
Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.  
+ For `cloudfront`, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
+ For `self-hosted`, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
*Required*: No  
*Type*: String  
*Allowed values*: `cloudfront | self-hosted`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::DistributionTenant Parameter
<a name="aws-properties-cloudfront-distributiontenant-parameter"></a>

A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

## Syntax
<a name="aws-properties-cloudfront-distributiontenant-parameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distributiontenant-parameter-syntax.json"></a>

```
{
  "[Name](#cfn-cloudfront-distributiontenant-parameter-name)" : String,
  "[Value](#cfn-cloudfront-distributiontenant-parameter-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distributiontenant-parameter-syntax.yaml"></a>

```
  [Name](#cfn-cloudfront-distributiontenant-parameter-name): String
  [Value](#cfn-cloudfront-distributiontenant-parameter-value): String
```

## Properties
<a name="aws-properties-cloudfront-distributiontenant-parameter-properties"></a>

`Name`  <a name="cfn-cloudfront-distributiontenant-parameter-name"></a>
The parameter name.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9-_]+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-distributiontenant-parameter-value"></a>
The parameter value.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::DistributionTenant Tag
<a name="aws-properties-cloudfront-distributiontenant-tag"></a>

A complex type that contains `Tag` key and `Tag` value.

## Syntax
<a name="aws-properties-cloudfront-distributiontenant-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distributiontenant-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cloudfront-distributiontenant-tag-key)" : String,
  "[Value](#cfn-cloudfront-distributiontenant-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distributiontenant-tag-syntax.yaml"></a>

```
  [Key](#cfn-cloudfront-distributiontenant-tag-key): String
  [Value](#cfn-cloudfront-distributiontenant-tag-value): String
```

## Properties
<a name="aws-properties-cloudfront-distributiontenant-tag-properties"></a>

`Key`  <a name="cfn-cloudfront-distributiontenant-tag-key"></a>
A string that contains `Tag` key.  
The string length should be between 1 and 128 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-distributiontenant-tag-value"></a>
A string that contains an optional `Tag` value.  
The string length should be between 0 and 256 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::DistributionTenant WebAclCustomization
<a name="aws-properties-cloudfront-distributiontenant-webaclcustomization"></a>

The AWS WAF web ACL customization specified for the distribution tenant.

## Syntax
<a name="aws-properties-cloudfront-distributiontenant-webaclcustomization-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-distributiontenant-webaclcustomization-syntax.json"></a>

```
{
  "[Action](#cfn-cloudfront-distributiontenant-webaclcustomization-action)" : String,
  "[Arn](#cfn-cloudfront-distributiontenant-webaclcustomization-arn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-distributiontenant-webaclcustomization-syntax.yaml"></a>

```
  [Action](#cfn-cloudfront-distributiontenant-webaclcustomization-action): String
  [Arn](#cfn-cloudfront-distributiontenant-webaclcustomization-arn): String
```

## Properties
<a name="aws-properties-cloudfront-distributiontenant-webaclcustomization-properties"></a>

`Action`  <a name="cfn-cloudfront-distributiontenant-webaclcustomization-action"></a>
The action for the AWS WAF web ACL customization. You can specify `override` to specify a separate AWS WAF web ACL for the distribution tenant. If you specify `disable`, the distribution tenant won't have AWS WAF web ACL protections and won't inherit from the multi-tenant distribution.  
*Required*: No  
*Type*: String  
*Allowed values*: `override | disable`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Arn`  <a name="cfn-cloudfront-distributiontenant-webaclcustomization-arn"></a>
The Amazon Resource Name (ARN) of the AWS WAF web ACL.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Function
<a name="aws-resource-cloudfront-function"></a>

Creates a CloudFront function.

To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage.

By default, when you create a function, it’s in the `DEVELOPMENT` stage. In this stage, you can [test the function](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/test-function.html) in the CloudFront console (or with `TestFunction` in the CloudFront API).

When you’re ready to use your function with a CloudFront distribution, publish the function to the `LIVE` stage. You can do this in the CloudFront console, with `PublishFunction` in the CloudFront API, or by updating the `AWS::CloudFront::Function` resource with the `AutoPublish` property set to `true`. When the function is published to the `LIVE` stage, you can attach it to a distribution’s cache behavior, using the function’s ARN.

To automatically publish the function to the `LIVE` stage when it’s created, set the `AutoPublish` property to `true`.

## Syntax
<a name="aws-resource-cloudfront-function-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-function-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::Function",
  "Properties" : {
      "[AutoPublish](#cfn-cloudfront-function-autopublish)" : Boolean,
      "[FunctionCode](#cfn-cloudfront-function-functioncode)" : String,
      "[FunctionConfig](#cfn-cloudfront-function-functionconfig)" : FunctionConfig,
      "[FunctionMetadata](#cfn-cloudfront-function-functionmetadata)" : FunctionMetadata,
      "[Name](#cfn-cloudfront-function-name)" : String
    }
}
```

### YAML
<a name="aws-resource-cloudfront-function-syntax.yaml"></a>

```
Type: AWS::CloudFront::Function
Properties:
  [AutoPublish](#cfn-cloudfront-function-autopublish): Boolean
  [FunctionCode](#cfn-cloudfront-function-functioncode): String
  [FunctionConfig](#cfn-cloudfront-function-functionconfig): 
    FunctionConfig
  [FunctionMetadata](#cfn-cloudfront-function-functionmetadata): 
    FunctionMetadata
  [Name](#cfn-cloudfront-function-name): String
```

## Properties
<a name="aws-resource-cloudfront-function-properties"></a>

`AutoPublish`  <a name="cfn-cloudfront-function-autopublish"></a>
A flag that determines whether to automatically publish the function to the `LIVE` stage when it’s created. To automatically publish to the `LIVE` stage, set this property to `true`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FunctionCode`  <a name="cfn-cloudfront-function-functioncode"></a>
The function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FunctionConfig`  <a name="cfn-cloudfront-function-functionconfig"></a>
Contains configuration information about a CloudFront function.  
*Required*: Yes  
*Type*: [FunctionConfig](aws-properties-cloudfront-function-functionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FunctionMetadata`  <a name="cfn-cloudfront-function-functionmetadata"></a>
Contains metadata about a CloudFront function.  
*Required*: No  
*Type*: [FunctionMetadata](aws-properties-cloudfront-function-functionmetadata.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-function-name"></a>
A name to identify the function.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z0-9-_]{1,64}`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-cloudfront-function-return-values"></a>

### Fn::GetAtt
<a name="aws-resource-cloudfront-function-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-function-return-values-fn--getatt-fn--getatt"></a>

`FunctionARN`  <a name="FunctionARN-fn::getatt"></a>
The ARN of the function. For example:  
`arn:aws:cloudfront::123456789012:function/ExampleFunction`.  
To get the function ARN, use the following syntax:  
 `!GetAtt Function_Logical_ID.FunctionMetadata.FunctionARN` 

`FunctionMetadata.FunctionARN`  <a name="FunctionMetadata.FunctionARN-fn::getatt"></a>
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.

## Examples
<a name="aws-resource-cloudfront-function--examples"></a>



### Create a CloudFront function
<a name="aws-resource-cloudfront-function--examples--Create_a_CloudFront_function"></a>

The following examples show how to create a basic CloudFront function.

#### YAML
<a name="aws-resource-cloudfront-function--examples--Create_a_CloudFront_function--yaml"></a>

```
Resources:
  CloudFrontFunction:
    Type: AWS::CloudFront::Function
    Properties:
      Name: MyFunctionName
      FunctionConfig:
        Comment: A basic CloudFront function
        Runtime: cloudfront-js-2.0
      FunctionCode: |
        function handler(event) {
            // NOTE: This example function is for a viewer request event trigger.
            // Choose viewer request for the event trigger when you associate this function with a distribution.
            var response = {
                statusCode: 200,
                statusDescription: 'OK',
                headers: {
                    'cloudfront-functions': { value: 'generated-by-CloudFront-Functions' }
                }
            };
            return response;
        }
      AutoPublish: true
```

#### JSON
<a name="aws-resource-cloudfront-function--examples--Create_a_CloudFront_function--json"></a>

```
{
    "Resources": {
        "CloudFrontFunction": {
            "Type": "AWS::CloudFront::Function",
            "Properties": {
                "Name": "MyFunctionNameJSON",
                "FunctionConfig": {
                    "Comment": "A basic CloudFront function",
                    "Runtime": "cloudfront-js-2.0"
                },
                "FunctionCode": "function handler(event) {\n    // NOTE: This example function is for a viewer request event trigger.\n    // Choose viewer request for the event trigger when you associate this function with a distribution.\n    var response = {\n        statusCode: 200,\n        statusDescription: 'OK',\n        headers: {\n            'cloudfront-functions': { value: 'generated-by-CloudFront-Functions' }\n        }\n    };\n    return response;\n}\n",
                "AutoPublish": true
            }
        }
    }
}
```

# AWS::CloudFront::Function FunctionConfig
<a name="aws-properties-cloudfront-function-functionconfig"></a>

Contains configuration information about a CloudFront function.

## Syntax
<a name="aws-properties-cloudfront-function-functionconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-function-functionconfig-syntax.json"></a>

```
{
  "[Comment](#cfn-cloudfront-function-functionconfig-comment)" : String,
  "[KeyValueStoreAssociations](#cfn-cloudfront-function-functionconfig-keyvaluestoreassociations)" : [ KeyValueStoreAssociation, ... ],
  "[Runtime](#cfn-cloudfront-function-functionconfig-runtime)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-function-functionconfig-syntax.yaml"></a>

```
  [Comment](#cfn-cloudfront-function-functionconfig-comment): String
  [KeyValueStoreAssociations](#cfn-cloudfront-function-functionconfig-keyvaluestoreassociations): 
    - KeyValueStoreAssociation
  [Runtime](#cfn-cloudfront-function-functionconfig-runtime): String
```

## Properties
<a name="aws-properties-cloudfront-function-functionconfig-properties"></a>

`Comment`  <a name="cfn-cloudfront-function-functionconfig-comment"></a>
A comment to describe the function.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyValueStoreAssociations`  <a name="cfn-cloudfront-function-functionconfig-keyvaluestoreassociations"></a>
The configuration for the key value store associations.  
*Required*: No  
*Type*: Array of [KeyValueStoreAssociation](aws-properties-cloudfront-function-keyvaluestoreassociation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Runtime`  <a name="cfn-cloudfront-function-functionconfig-runtime"></a>
The function's runtime environment version.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `cloudfront-js-1.0 | cloudfront-js-2.0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Function FunctionMetadata
<a name="aws-properties-cloudfront-function-functionmetadata"></a>

Contains metadata about a CloudFront function.

## Syntax
<a name="aws-properties-cloudfront-function-functionmetadata-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-function-functionmetadata-syntax.json"></a>

```
{
  "[FunctionARN](#cfn-cloudfront-function-functionmetadata-functionarn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-function-functionmetadata-syntax.yaml"></a>

```
  [FunctionARN](#cfn-cloudfront-function-functionmetadata-functionarn): String
```

## Properties
<a name="aws-properties-cloudfront-function-functionmetadata-properties"></a>

`FunctionARN`  <a name="cfn-cloudfront-function-functionmetadata-functionarn"></a>
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::Function KeyValueStoreAssociation
<a name="aws-properties-cloudfront-function-keyvaluestoreassociation"></a>

The key value store association.

## Syntax
<a name="aws-properties-cloudfront-function-keyvaluestoreassociation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-function-keyvaluestoreassociation-syntax.json"></a>

```
{
  "[KeyValueStoreARN](#cfn-cloudfront-function-keyvaluestoreassociation-keyvaluestorearn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-function-keyvaluestoreassociation-syntax.yaml"></a>

```
  [KeyValueStoreARN](#cfn-cloudfront-function-keyvaluestoreassociation-keyvaluestorearn): String
```

## Properties
<a name="aws-properties-cloudfront-function-keyvaluestoreassociation-properties"></a>

`KeyValueStoreARN`  <a name="cfn-cloudfront-function-keyvaluestoreassociation-keyvaluestorearn"></a>
The Amazon Resource Name (ARN) of the key value store association.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:aws:cloudfront::[0-9]{12}:key-value-store\/[0-9a-fA-F-]{36}`  
*Minimum*: `0`  
*Maximum*: `85`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::KeyGroup
<a name="aws-resource-cloudfront-keygroup"></a>

A key group.

A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html).

## Syntax
<a name="aws-resource-cloudfront-keygroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-keygroup-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::KeyGroup",
  "Properties" : {
      "[KeyGroupConfig](#cfn-cloudfront-keygroup-keygroupconfig)" : KeyGroupConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-keygroup-syntax.yaml"></a>

```
Type: AWS::CloudFront::KeyGroup
Properties:
  [KeyGroupConfig](#cfn-cloudfront-keygroup-keygroupconfig): 
    KeyGroupConfig
```

## Properties
<a name="aws-resource-cloudfront-keygroup-properties"></a>

`KeyGroupConfig`  <a name="cfn-cloudfront-keygroup-keygroupconfig"></a>
The key group configuration.  
*Required*: Yes  
*Type*: [KeyGroupConfig](aws-properties-cloudfront-keygroup-keygroupconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-keygroup-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-keygroup-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the key group. For example: `e9fcd3cf-f3f4-4b61-bd85-9ba9e091b309`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-keygroup-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-keygroup-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The identifier for the key group.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The date and time when the key group was last modified.

# AWS::CloudFront::KeyGroup KeyGroupConfig
<a name="aws-properties-cloudfront-keygroup-keygroupconfig"></a>

A key group configuration.

A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html).

## Syntax
<a name="aws-properties-cloudfront-keygroup-keygroupconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-keygroup-keygroupconfig-syntax.json"></a>

```
{
  "[Comment](#cfn-cloudfront-keygroup-keygroupconfig-comment)" : String,
  "[Items](#cfn-cloudfront-keygroup-keygroupconfig-items)" : [ String, ... ],
  "[Name](#cfn-cloudfront-keygroup-keygroupconfig-name)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-keygroup-keygroupconfig-syntax.yaml"></a>

```
  [Comment](#cfn-cloudfront-keygroup-keygroupconfig-comment): String
  [Items](#cfn-cloudfront-keygroup-keygroupconfig-items): 
    - String
  [Name](#cfn-cloudfront-keygroup-keygroupconfig-name): String
```

## Properties
<a name="aws-properties-cloudfront-keygroup-keygroupconfig-properties"></a>

`Comment`  <a name="cfn-cloudfront-keygroup-keygroupconfig-comment"></a>
A comment to describe the key group. The comment cannot be longer than 128 characters.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Items`  <a name="cfn-cloudfront-keygroup-keygroupconfig-items"></a>
A list of the identifiers of the public keys in the key group.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-keygroup-keygroupconfig-name"></a>
A name to identify the key group.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::KeyValueStore
<a name="aws-resource-cloudfront-keyvaluestore"></a>

The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.

## Syntax
<a name="aws-resource-cloudfront-keyvaluestore-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-keyvaluestore-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::KeyValueStore",
  "Properties" : {
      "[Comment](#cfn-cloudfront-keyvaluestore-comment)" : String,
      "[ImportSource](#cfn-cloudfront-keyvaluestore-importsource)" : ImportSource,
      "[Name](#cfn-cloudfront-keyvaluestore-name)" : String
    }
}
```

### YAML
<a name="aws-resource-cloudfront-keyvaluestore-syntax.yaml"></a>

```
Type: AWS::CloudFront::KeyValueStore
Properties:
  [Comment](#cfn-cloudfront-keyvaluestore-comment): String
  [ImportSource](#cfn-cloudfront-keyvaluestore-importsource): 
    ImportSource
  [Name](#cfn-cloudfront-keyvaluestore-name): String
```

## Properties
<a name="aws-resource-cloudfront-keyvaluestore-properties"></a>

`Comment`  <a name="cfn-cloudfront-keyvaluestore-comment"></a>
A comment for the key value store.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ImportSource`  <a name="cfn-cloudfront-keyvaluestore-importsource"></a>
The import source for the key value store.  
*Required*: No  
*Type*: [ImportSource](aws-properties-cloudfront-keyvaluestore-importsource.md)  
*Update requires*: Updates are not supported.

`Name`  <a name="cfn-cloudfront-keyvaluestore-name"></a>
The name of the key value store.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-cloudfront-keyvaluestore-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-keyvaluestore-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-cloudfront-keyvaluestore-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-cloudfront-keyvaluestore-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the key value store.

`Id`  <a name="Id-fn::getatt"></a>
The unique Id for the key value store.

`Status`  <a name="Status-fn::getatt"></a>
The current status of the key value store. For more information, see [Key value store statuses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/kvs-with-functions-create.html#key-value-store-status) in the *Amazon CloudFront Developer Guide.*

## Examples
<a name="aws-resource-cloudfront-keyvaluestore--examples"></a>



### Key value store
<a name="aws-resource-cloudfront-keyvaluestore--examples--Key_value_store"></a>

The following example creates a key value store named DemoKeyValueStore and a CloudFront function named DemoFunction.

#### JSON
<a name="aws-resource-cloudfront-keyvaluestore--examples--Key_value_store--json"></a>

```
{
    "Resources": {
        "KeyValueStore": {
            "Type": "AWS::CloudFront::KeyValueStore",
            "Properties": {"Name": "DemoKeyValueStore"}
        },
        "Function": {
            "Type": "AWS::CloudFront::Function",
            "Name": "DemoFunction",
            "FunctionConfig": {
                "Comment": "Function with KeyValueStore",
                "Runtime": "cloudfront-js-2.0",
                "KeyValueStoreAssociations": [
                    {
                        "KeyValueStoreARN": {"Fn::Sub": "${KeyValueStore.Arn}"}
                    }
                ]
            },
            "FunctionCode": {"Fn::Sub": "const kvsId = '${KeyValueStore.Id}';\n// ... remaining function code ..."},
            "AutoPublish": true
        }
    }
}
```

#### YAML
<a name="aws-resource-cloudfront-keyvaluestore--examples--Key_value_store--yaml"></a>

```
Resources:
  KeyValueStore:
    Type: 'AWS::CloudFront::KeyValueStore'
    Properties:
      Name: 'DemoKeyValueStore'
  Function:
    Type: 'AWS::CloudFront::Function'
    Properties:
      Name: 'DemoFunction'
      FunctionConfig:
        Comment: 'Function with KeyValueStore'
        Runtime: 'cloudfront-js-2.0'
        KeyValueStoreAssociations:
          - KeyValueStoreARN: !Sub '${KeyValueStore.Arn}'
      FunctionCode: !Sub |
        const kvsId = '${KeyValueStore.Id}';
        // ... Remaining function code ...
      AutoPublish: true
```

# AWS::CloudFront::KeyValueStore ImportSource
<a name="aws-properties-cloudfront-keyvaluestore-importsource"></a>

The import source for the key value store.

## Syntax
<a name="aws-properties-cloudfront-keyvaluestore-importsource-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-keyvaluestore-importsource-syntax.json"></a>

```
{
  "[SourceArn](#cfn-cloudfront-keyvaluestore-importsource-sourcearn)" : String,
  "[SourceType](#cfn-cloudfront-keyvaluestore-importsource-sourcetype)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-keyvaluestore-importsource-syntax.yaml"></a>

```
  [SourceArn](#cfn-cloudfront-keyvaluestore-importsource-sourcearn): String
  [SourceType](#cfn-cloudfront-keyvaluestore-importsource-sourcetype): String
```

## Properties
<a name="aws-properties-cloudfront-keyvaluestore-importsource-properties"></a>

`SourceArn`  <a name="cfn-cloudfront-keyvaluestore-importsource-sourcearn"></a>
The Amazon Resource Name (ARN) of the import source for the key value store.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceType`  <a name="cfn-cloudfront-keyvaluestore-importsource-sourcetype"></a>
The source type of the import source for the key value store.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `S3`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::MonitoringSubscription
<a name="aws-resource-cloudfront-monitoringsubscription"></a>

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

## Syntax
<a name="aws-resource-cloudfront-monitoringsubscription-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-monitoringsubscription-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::MonitoringSubscription",
  "Properties" : {
      "[DistributionId](#cfn-cloudfront-monitoringsubscription-distributionid)" : String,
      "[MonitoringSubscription](#cfn-cloudfront-monitoringsubscription-monitoringsubscription)" : MonitoringSubscription
    }
}
```

### YAML
<a name="aws-resource-cloudfront-monitoringsubscription-syntax.yaml"></a>

```
Type: AWS::CloudFront::MonitoringSubscription
Properties:
  [DistributionId](#cfn-cloudfront-monitoringsubscription-distributionid): String
  [MonitoringSubscription](#cfn-cloudfront-monitoringsubscription-monitoringsubscription): 
    MonitoringSubscription
```

## Properties
<a name="aws-resource-cloudfront-monitoringsubscription-properties"></a>

`DistributionId`  <a name="cfn-cloudfront-monitoringsubscription-distributionid"></a>
The ID of the distribution that you are enabling metrics for.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MonitoringSubscription`  <a name="cfn-cloudfront-monitoringsubscription-monitoringsubscription"></a>
A subscription configuration for additional CloudWatch metrics.  
*Required*: Yes  
*Type*: [MonitoringSubscription](aws-properties-cloudfront-monitoringsubscription-monitoringsubscription.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-monitoringsubscription-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-monitoringsubscription-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier for the monitoring subscription, which is the same as the distribution ID of the distribution that the subscription is for.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

# AWS::CloudFront::MonitoringSubscription MonitoringSubscription
<a name="aws-properties-cloudfront-monitoringsubscription-monitoringsubscription"></a>

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

## Syntax
<a name="aws-properties-cloudfront-monitoringsubscription-monitoringsubscription-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-monitoringsubscription-monitoringsubscription-syntax.json"></a>

```
{
  "[RealtimeMetricsSubscriptionConfig](#cfn-cloudfront-monitoringsubscription-monitoringsubscription-realtimemetricssubscriptionconfig)" : RealtimeMetricsSubscriptionConfig
}
```

### YAML
<a name="aws-properties-cloudfront-monitoringsubscription-monitoringsubscription-syntax.yaml"></a>

```
  [RealtimeMetricsSubscriptionConfig](#cfn-cloudfront-monitoringsubscription-monitoringsubscription-realtimemetricssubscriptionconfig): 
    RealtimeMetricsSubscriptionConfig
```

## Properties
<a name="aws-properties-cloudfront-monitoringsubscription-monitoringsubscription-properties"></a>

`RealtimeMetricsSubscriptionConfig`  <a name="cfn-cloudfront-monitoringsubscription-monitoringsubscription-realtimemetricssubscriptionconfig"></a>
A subscription configuration for additional CloudWatch metrics.  
*Required*: No  
*Type*: [RealtimeMetricsSubscriptionConfig](aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::MonitoringSubscription RealtimeMetricsSubscriptionConfig
<a name="aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig"></a>

A subscription configuration for additional CloudWatch metrics.

## Syntax
<a name="aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig-syntax.json"></a>

```
{
  "[RealtimeMetricsSubscriptionStatus](#cfn-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig-realtimemetricssubscriptionstatus)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig-syntax.yaml"></a>

```
  [RealtimeMetricsSubscriptionStatus](#cfn-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig-realtimemetricssubscriptionstatus): String
```

## Properties
<a name="aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig-properties"></a>

`RealtimeMetricsSubscriptionStatus`  <a name="cfn-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig-realtimemetricssubscriptionstatus"></a>
A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Enabled | Disabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::OriginAccessControl
<a name="aws-resource-cloudfront-originaccesscontrol"></a>

Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.

This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.

For more information about using a CloudFront origin access control, see [Restricting access to an AWS origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-resource-cloudfront-originaccesscontrol-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-originaccesscontrol-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::OriginAccessControl",
  "Properties" : {
      "[OriginAccessControlConfig](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig)" : OriginAccessControlConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-originaccesscontrol-syntax.yaml"></a>

```
Type: AWS::CloudFront::OriginAccessControl
Properties:
  [OriginAccessControlConfig](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig): 
    OriginAccessControlConfig
```

## Properties
<a name="aws-resource-cloudfront-originaccesscontrol-properties"></a>

`OriginAccessControlConfig`  <a name="cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig"></a>
The origin access control.  
*Required*: Yes  
*Type*: [OriginAccessControlConfig](aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-originaccesscontrol-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-originaccesscontrol-return-values-ref"></a>

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-originaccesscontrol-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-originaccesscontrol-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The unique identifier of the origin access control.

# AWS::CloudFront::OriginAccessControl OriginAccessControlConfig
<a name="aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig"></a>

Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.

This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.

For more information about using a CloudFront origin access control, see [Restricting access to an AWS origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig-syntax.json"></a>

```
{
  "[Description](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-description)" : String,
  "[Name](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-name)" : String,
  "[OriginAccessControlOriginType](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-originaccesscontrolorigintype)" : String,
  "[SigningBehavior](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingbehavior)" : String,
  "[SigningProtocol](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingprotocol)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig-syntax.yaml"></a>

```
  [Description](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-description): String
  [Name](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-name): String
  [OriginAccessControlOriginType](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-originaccesscontrolorigintype): String
  [SigningBehavior](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingbehavior): String
  [SigningProtocol](#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingprotocol): String
```

## Properties
<a name="aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig-properties"></a>

`Description`  <a name="cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-description"></a>
A description of the origin access control.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-name"></a>
A name to identify the origin access control. You can specify up to 64 characters.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginAccessControlOriginType`  <a name="cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-originaccesscontrolorigintype"></a>
The type of origin that this origin access control is for.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(s3|mediastore|lambda|mediapackagev2)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SigningBehavior`  <a name="cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingbehavior"></a>
Specifies which requests CloudFront signs (adds authentication information to). Specify `always` for the most common use case. For more information, see [origin access control advanced settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) in the *Amazon CloudFront Developer Guide*.  
This field can have one of the following values:  
+ `always` – CloudFront signs all origin requests, overwriting the `Authorization` header from the viewer request if one exists.
+ `never` – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
+ `no-override` – If the viewer request doesn't contain the `Authorization` header, then CloudFront signs the origin request. If the viewer request contains the `Authorization` header, then CloudFront doesn't sign the origin request and instead passes along the `Authorization` header from the viewer request. **WARNING: To pass along the `Authorization` header from the viewer request, you *must* add the `Authorization` header to a [cache policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) for all cache behaviors that use origins associated with this origin access control.**
*Required*: Yes  
*Type*: String  
*Pattern*: `^(never|no-override|always)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SigningProtocol`  <a name="cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingprotocol"></a>
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is `sigv4`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(sigv4)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::OriginRequestPolicy
<a name="aws-resource-cloudfront-originrequestpolicy"></a>

An origin request policy.

When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
+ The request body and the URL path (without the domain name) from the viewer request.
+ The headers that CloudFront automatically includes in every origin request, including `Host`, `User-Agent`, and `X-Amz-Cf-Id`.
+ All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use `CachePolicy`.

## Syntax
<a name="aws-resource-cloudfront-originrequestpolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-originrequestpolicy-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::OriginRequestPolicy",
  "Properties" : {
      "[OriginRequestPolicyConfig](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig)" : OriginRequestPolicyConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-originrequestpolicy-syntax.yaml"></a>

```
Type: AWS::CloudFront::OriginRequestPolicy
Properties:
  [OriginRequestPolicyConfig](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig): 
    OriginRequestPolicyConfig
```

## Properties
<a name="aws-resource-cloudfront-originrequestpolicy-properties"></a>

`OriginRequestPolicyConfig`  <a name="cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig"></a>
The origin request policy configuration.  
*Required*: Yes  
*Type*: [OriginRequestPolicyConfig](aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-originrequestpolicy-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-originrequestpolicy-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the origin request policy ID. For example: `befd7079-9bbc-4ebf-8ade-498a3694176c`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-originrequestpolicy-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-originrequestpolicy-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The unique identifier for the origin request policy. For example: `befd7079-9bbc-4ebf-8ade-498a3694176c`.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The date and time when the origin request policy was last modified.

# AWS::CloudFront::OriginRequestPolicy CookiesConfig
<a name="aws-properties-cloudfront-originrequestpolicy-cookiesconfig"></a>

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.

## Syntax
<a name="aws-properties-cloudfront-originrequestpolicy-cookiesconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-originrequestpolicy-cookiesconfig-syntax.json"></a>

```
{
  "[CookieBehavior](#cfn-cloudfront-originrequestpolicy-cookiesconfig-cookiebehavior)" : String,
  "[Cookies](#cfn-cloudfront-originrequestpolicy-cookiesconfig-cookies)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-originrequestpolicy-cookiesconfig-syntax.yaml"></a>

```
  [CookieBehavior](#cfn-cloudfront-originrequestpolicy-cookiesconfig-cookiebehavior): String
  [Cookies](#cfn-cloudfront-originrequestpolicy-cookiesconfig-cookies): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-originrequestpolicy-cookiesconfig-properties"></a>

`CookieBehavior`  <a name="cfn-cloudfront-originrequestpolicy-cookiesconfig-cookiebehavior"></a>
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:  
+ `none` – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to `none`, any cookies that are listed in a `CachePolicy`*are* included in origin requests.
+ `whitelist` – Only the cookies in viewer requests that are listed in the `CookieNames` type are included in requests that CloudFront sends to the origin.
+ `all` – All cookies in viewer requests are included in requests that CloudFront sends to the origin.
+ `allExcept` – All cookies in viewer requests are included in requests that CloudFront sends to the origin, * **except** * for those listed in the `CookieNames` type, which are not included.
*Required*: Yes  
*Type*: String  
*Pattern*: `^(none|whitelist|all|allExcept)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Cookies`  <a name="cfn-cloudfront-originrequestpolicy-cookiesconfig-cookies"></a>
Contains a list of cookie names.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::OriginRequestPolicy HeadersConfig
<a name="aws-properties-cloudfront-originrequestpolicy-headersconfig"></a>

An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.

## Syntax
<a name="aws-properties-cloudfront-originrequestpolicy-headersconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-originrequestpolicy-headersconfig-syntax.json"></a>

```
{
  "[HeaderBehavior](#cfn-cloudfront-originrequestpolicy-headersconfig-headerbehavior)" : String,
  "[Headers](#cfn-cloudfront-originrequestpolicy-headersconfig-headers)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-originrequestpolicy-headersconfig-syntax.yaml"></a>

```
  [HeaderBehavior](#cfn-cloudfront-originrequestpolicy-headersconfig-headerbehavior): String
  [Headers](#cfn-cloudfront-originrequestpolicy-headersconfig-headers): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-originrequestpolicy-headersconfig-properties"></a>

`HeaderBehavior`  <a name="cfn-cloudfront-originrequestpolicy-headersconfig-headerbehavior"></a>
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:  
+ `none` – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to `none`, any headers that are listed in a `CachePolicy`*are* included in origin requests.
+ `whitelist` – Only the HTTP headers that are listed in the `Headers` type are included in requests that CloudFront sends to the origin.
+ `allViewer` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.
+ `allViewerAndWhitelistCloudFront` – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the `Headers` type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.
+ `allExcept` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, * **except** * for those listed in the `Headers` type, which are not included.
*Required*: Yes  
*Type*: String  
*Pattern*: `^(none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Headers`  <a name="cfn-cloudfront-originrequestpolicy-headersconfig-headers"></a>
Contains a list of HTTP header names.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::OriginRequestPolicy OriginRequestPolicyConfig
<a name="aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig"></a>

An origin request policy configuration.

This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
+ The request body and the URL path (without the domain name) from the viewer request.
+ The headers that CloudFront automatically includes in every origin request, including `Host`, `User-Agent`, and `X-Amz-Cf-Id`.
+ All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use `CachePolicy`.

## Syntax
<a name="aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig-syntax.json"></a>

```
{
  "[Comment](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-comment)" : String,
  "[CookiesConfig](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-cookiesconfig)" : CookiesConfig,
  "[HeadersConfig](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-headersconfig)" : HeadersConfig,
  "[Name](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-name)" : String,
  "[QueryStringsConfig](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-querystringsconfig)" : QueryStringsConfig
}
```

### YAML
<a name="aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig-syntax.yaml"></a>

```
  [Comment](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-comment): String
  [CookiesConfig](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-cookiesconfig): 
    CookiesConfig
  [HeadersConfig](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-headersconfig): 
    HeadersConfig
  [Name](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-name): String
  [QueryStringsConfig](#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-querystringsconfig): 
    QueryStringsConfig
```

## Properties
<a name="aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig-properties"></a>

`Comment`  <a name="cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-comment"></a>
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CookiesConfig`  <a name="cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-cookiesconfig"></a>
The cookies from viewer requests to include in origin requests.  
*Required*: Yes  
*Type*: [CookiesConfig](aws-properties-cloudfront-originrequestpolicy-cookiesconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HeadersConfig`  <a name="cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-headersconfig"></a>
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.  
*Required*: Yes  
*Type*: [HeadersConfig](aws-properties-cloudfront-originrequestpolicy-headersconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-name"></a>
A unique name to identify the origin request policy.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStringsConfig`  <a name="cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-querystringsconfig"></a>
The URL query strings from viewer requests to include in origin requests.  
*Required*: Yes  
*Type*: [QueryStringsConfig](aws-properties-cloudfront-originrequestpolicy-querystringsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::OriginRequestPolicy QueryStringsConfig
<a name="aws-properties-cloudfront-originrequestpolicy-querystringsconfig"></a>

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.

## Syntax
<a name="aws-properties-cloudfront-originrequestpolicy-querystringsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-originrequestpolicy-querystringsconfig-syntax.json"></a>

```
{
  "[QueryStringBehavior](#cfn-cloudfront-originrequestpolicy-querystringsconfig-querystringbehavior)" : String,
  "[QueryStrings](#cfn-cloudfront-originrequestpolicy-querystringsconfig-querystrings)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-originrequestpolicy-querystringsconfig-syntax.yaml"></a>

```
  [QueryStringBehavior](#cfn-cloudfront-originrequestpolicy-querystringsconfig-querystringbehavior): 
    String
  [QueryStrings](#cfn-cloudfront-originrequestpolicy-querystringsconfig-querystrings): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-originrequestpolicy-querystringsconfig-properties"></a>

`QueryStringBehavior`  <a name="cfn-cloudfront-originrequestpolicy-querystringsconfig-querystringbehavior"></a>
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:  
+ `none` – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to `none`, any query strings that are listed in a `CachePolicy`*are* included in origin requests.
+ `whitelist` – Only the query strings in viewer requests that are listed in the `QueryStringNames` type are included in requests that CloudFront sends to the origin.
+ `all` – All query strings in viewer requests are included in requests that CloudFront sends to the origin.
+ `allExcept` – All query strings in viewer requests are included in requests that CloudFront sends to the origin, * **except** * for those listed in the `QueryStringNames` type, which are not included.
*Required*: Yes  
*Type*: String  
*Pattern*: `^(none|whitelist|all|allExcept)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStrings`  <a name="cfn-cloudfront-originrequestpolicy-querystringsconfig-querystrings"></a>
Contains a list of query string names.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::PublicKey
<a name="aws-resource-cloudfront-publickey"></a>

A public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).

CloudFront supports signed URLs and signed cookies with RSA 2048 or ECDSA 256 key signatures. Field-level encryption is only compatible with RSA 2048 key signatures.

## Syntax
<a name="aws-resource-cloudfront-publickey-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-publickey-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::PublicKey",
  "Properties" : {
      "[PublicKeyConfig](#cfn-cloudfront-publickey-publickeyconfig)" : PublicKeyConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-publickey-syntax.yaml"></a>

```
Type: AWS::CloudFront::PublicKey
Properties:
  [PublicKeyConfig](#cfn-cloudfront-publickey-publickeyconfig): 
    PublicKeyConfig
```

## Properties
<a name="aws-resource-cloudfront-publickey-properties"></a>

`PublicKeyConfig`  <a name="cfn-cloudfront-publickey-publickeyconfig"></a>
Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).  
*Required*: Yes  
*Type*: [PublicKeyConfig](aws-properties-cloudfront-publickey-publickeyconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-publickey-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-publickey-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the public key. For example: `K36X4X2EO997HM`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-publickey-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-publickey-return-values-fn--getatt-fn--getatt"></a>

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
The date and time when the public key was uploaded.

`Id`  <a name="Id-fn::getatt"></a>
The identifier of the public key.

# AWS::CloudFront::PublicKey PublicKeyConfig
<a name="aws-properties-cloudfront-publickey-publickeyconfig"></a>

Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).

CloudFront supports signed URLs and signed cookies with RSA 2048 or ECDSA 256 key signatures. Field-level encryption is only compatible with RSA 2048 key signatures.

## Syntax
<a name="aws-properties-cloudfront-publickey-publickeyconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-publickey-publickeyconfig-syntax.json"></a>

```
{
  "[CallerReference](#cfn-cloudfront-publickey-publickeyconfig-callerreference)" : String,
  "[Comment](#cfn-cloudfront-publickey-publickeyconfig-comment)" : String,
  "[EncodedKey](#cfn-cloudfront-publickey-publickeyconfig-encodedkey)" : String,
  "[Name](#cfn-cloudfront-publickey-publickeyconfig-name)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-publickey-publickeyconfig-syntax.yaml"></a>

```
  [CallerReference](#cfn-cloudfront-publickey-publickeyconfig-callerreference): String
  [Comment](#cfn-cloudfront-publickey-publickeyconfig-comment): String
  [EncodedKey](#cfn-cloudfront-publickey-publickeyconfig-encodedkey): String
  [Name](#cfn-cloudfront-publickey-publickeyconfig-name): String
```

## Properties
<a name="aws-properties-cloudfront-publickey-publickeyconfig-properties"></a>

`CallerReference`  <a name="cfn-cloudfront-publickey-publickeyconfig-callerreference"></a>
A string included in the request to help make sure that the request can't be replayed.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Comment`  <a name="cfn-cloudfront-publickey-publickeyconfig-comment"></a>
A comment to describe the public key. The comment cannot be longer than 128 characters.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncodedKey`  <a name="cfn-cloudfront-publickey-publickeyconfig-encodedkey"></a>
The public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-publickey-publickeyconfig-name"></a>
A name to help identify the public key.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::RealtimeLogConfig
<a name="aws-resource-cloudfront-realtimelogconfig"></a>

A real-time log configuration.

## Syntax
<a name="aws-resource-cloudfront-realtimelogconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-realtimelogconfig-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::RealtimeLogConfig",
  "Properties" : {
      "[EndPoints](#cfn-cloudfront-realtimelogconfig-endpoints)" : [ EndPoint, ... ],
      "[Fields](#cfn-cloudfront-realtimelogconfig-fields)" : [ String, ... ],
      "[Name](#cfn-cloudfront-realtimelogconfig-name)" : String,
      "[SamplingRate](#cfn-cloudfront-realtimelogconfig-samplingrate)" : Number
    }
}
```

### YAML
<a name="aws-resource-cloudfront-realtimelogconfig-syntax.yaml"></a>

```
Type: AWS::CloudFront::RealtimeLogConfig
Properties:
  [EndPoints](#cfn-cloudfront-realtimelogconfig-endpoints): 
    - EndPoint
  [Fields](#cfn-cloudfront-realtimelogconfig-fields): 
    - String
  [Name](#cfn-cloudfront-realtimelogconfig-name): String
  [SamplingRate](#cfn-cloudfront-realtimelogconfig-samplingrate): Number
```

## Properties
<a name="aws-resource-cloudfront-realtimelogconfig-properties"></a>

`EndPoints`  <a name="cfn-cloudfront-realtimelogconfig-endpoints"></a>
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.  
*Required*: Yes  
*Type*: Array of [EndPoint](aws-properties-cloudfront-realtimelogconfig-endpoint.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Fields`  <a name="cfn-cloudfront-realtimelogconfig-fields"></a>
A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.  
For more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the *Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-realtimelogconfig-name"></a>
The unique name of this real-time log configuration.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SamplingRate`  <a name="cfn-cloudfront-realtimelogconfig-samplingrate"></a>
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-realtimelogconfig-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-realtimelogconfig-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the real-time log configuration. For example: `arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-realtimelogconfig-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-realtimelogconfig-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
 The Amazon Resource Name (ARN) of the real-time log configuration. For example: `arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig`.

# AWS::CloudFront::RealtimeLogConfig EndPoint
<a name="aws-properties-cloudfront-realtimelogconfig-endpoint"></a>

Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

## Syntax
<a name="aws-properties-cloudfront-realtimelogconfig-endpoint-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-realtimelogconfig-endpoint-syntax.json"></a>

```
{
  "[KinesisStreamConfig](#cfn-cloudfront-realtimelogconfig-endpoint-kinesisstreamconfig)" : KinesisStreamConfig,
  "[StreamType](#cfn-cloudfront-realtimelogconfig-endpoint-streamtype)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-realtimelogconfig-endpoint-syntax.yaml"></a>

```
  [KinesisStreamConfig](#cfn-cloudfront-realtimelogconfig-endpoint-kinesisstreamconfig): 
    KinesisStreamConfig
  [StreamType](#cfn-cloudfront-realtimelogconfig-endpoint-streamtype): String
```

## Properties
<a name="aws-properties-cloudfront-realtimelogconfig-endpoint-properties"></a>

`KinesisStreamConfig`  <a name="cfn-cloudfront-realtimelogconfig-endpoint-kinesisstreamconfig"></a>
Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.  
*Required*: Yes  
*Type*: [KinesisStreamConfig](aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StreamType`  <a name="cfn-cloudfront-realtimelogconfig-endpoint-streamtype"></a>
The type of data stream where you are sending real-time log data. The only valid value is `Kinesis`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::RealtimeLogConfig KinesisStreamConfig
<a name="aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig"></a>

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

## Syntax
<a name="aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig-syntax.json"></a>

```
{
  "[RoleArn](#cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-rolearn)" : String,
  "[StreamArn](#cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-streamarn)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig-syntax.yaml"></a>

```
  [RoleArn](#cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-rolearn): String
  [StreamArn](#cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-streamarn): String
```

## Properties
<a name="aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig-properties"></a>

`RoleArn`  <a name="cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-rolearn"></a>
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.  
For more information the IAM role, see [Real-time log configuration IAM role](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) in the *Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StreamArn`  <a name="cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-streamarn"></a>
The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy
<a name="aws-resource-cloudfront-responseheaderspolicy"></a>

A response headers policy.

A response headers policy contains information about a set of HTTP response headers.

After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.

For more information, see [Adding or removing HTTP headers in CloudFront responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) in the *Amazon CloudFront Developer Guide*.

## Syntax
<a name="aws-resource-cloudfront-responseheaderspolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-responseheaderspolicy-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::ResponseHeadersPolicy",
  "Properties" : {
      "[ResponseHeadersPolicyConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig)" : ResponseHeadersPolicyConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-responseheaderspolicy-syntax.yaml"></a>

```
Type: AWS::CloudFront::ResponseHeadersPolicy
Properties:
  [ResponseHeadersPolicyConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig): 
    ResponseHeadersPolicyConfig
```

## Properties
<a name="aws-resource-cloudfront-responseheaderspolicy-properties"></a>

`ResponseHeadersPolicyConfig`  <a name="cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig"></a>
A response headers policy configuration.  
*Required*: Yes  
*Type*: [ResponseHeadersPolicyConfig](aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-responseheaderspolicy-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-responseheaderspolicy-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the response headers policy ID. For example: `57f99797-3b20-4e1b-a728-27972a74082a`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-responseheaderspolicy-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-responseheaderspolicy-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The unique identifier for the response headers policy. For example: `57f99797-3b20-4e1b-a728-27972a74082a`.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The date and time when the response headers policy was last modified.

## Examples
<a name="aws-resource-cloudfront-responseheaderspolicy--examples"></a>



### Create a response headers policy
<a name="aws-resource-cloudfront-responseheaderspolicy--examples--Create_a_response_headers_policy"></a>

The following example creates a response headers policy.

#### JSON
<a name="aws-resource-cloudfront-responseheaderspolicy--examples--Create_a_response_headers_policy--json"></a>

```
{
  "Resources": {
    "MyResponseHeadersPolicy": {
      "Type": "AWS::CloudFront::ResponseHeadersPolicy",
      "Properties": {
        "ResponseHeadersPolicyConfig": {
          "Name": {
            "Fn::Join": [
              "-",
              [
                "canary-response-header-policy",
                {
                  "Fn::Select": [
                    0,
                    {
                      "Fn::Split": [
                        "-",
                        {
                          "Fn::Select": [
                            2,
                            {
                              "Fn::Split": [
                                "/",
                                {
                                  "Ref": "AWS::StackId"
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            ]
          },
          "Comment": "Sample Comment",
          "CorsConfig": {
            "AccessControlAllowCredentials": true,
            "AccessControlAllowHeaders": {
              "Items": ["Header1"]
            },
            "AccessControlAllowMethods": {
              "Items": ["GET", "POST"]
            },
            "AccessControlAllowOrigins": {
              "Items": ["example1.com", "example2.com", "example3.com"]
            },
            "AccessControlExposeHeaders": {
              "Items": [
                "ExposeHeader1",
                "ExposeHeader2",
                "ExposeHeader3",
                "ExposeHeader4"
              ]
            },
            "AccessControlMaxAgeSec": 1200,
            "OriginOverride": true
          },
          "CustomHeadersConfig": {
            "Items": [
              {
                "Header": "HeaderX",
                "Override": true,
                "Value": "ValueX"
              },
              {
                "Header": "HeaderY",
                "Override": true,
                "Value": "ValueY"
              }
            ]
          },
          "RemoveHeadersConfig": {
            "Items": [
              {
                "Header": "RemoveHeaderX"
              },
              {
                "Header": "RemoveHeaderY"
              }
            ]
          },
          "SecurityHeadersConfig": {
            "ContentSecurityPolicy": {
              "ContentSecurityPolicy": "MyPolicy",
              "Override": true
            },
            "ContentTypeOptions": {
              "Override": true
            },
            "FrameOptions": {
              "FrameOption": "SAMEORIGIN",
              "Override": true
            },
            "ReferrerPolicy": {
              "ReferrerPolicy": "origin-when-cross-origin",
              "Override": true
            },
            "StrictTransportSecurity": {
              "AccessControlMaxAgeSec": 2400,
              "IncludeSubdomains": true,
              "Override": true,
              "Preload": true
            },
            "XSSProtection": {
              "ModeBlock": true,
              "Override": true,
              "Protection": true
            }
          }
        }
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-cloudfront-responseheaderspolicy--examples--Create_a_response_headers_policy--yaml"></a>

```
Resources:
  ABCDE1FGHI:
  MyWaitConditionHandle:
    Type: AWS::CloudFormation::WaitConditionHandle
  MyResponseHeadersPolicy:
    Type: AWS::CloudFront::ResponseHeadersPolicy
    Properties:
      ResponseHeadersPolicyConfig:
        Name: !Join
          - "-"
          - - "canary-response-header-policy"
            - !Select
              - 0
              - !Split
                - "-"
                - !Select
                  - 2
                  - !Split
                    - "/"
                    - !Ref "AWS::StackId"
        Comment: "Sample Comment"
        CorsConfig:
          AccessControlAllowCredentials: true
          AccessControlAllowHeaders:
            Items:
              - "Header1"
          AccessControlAllowMethods:
            Items:
              - "GET"
              - "POST"
          AccessControlAllowOrigins:
            Items:
              - "example1.com"
              - "example2.com"
              - "example3.com"
          AccessControlExposeHeaders:
            Items:
              - "ExposeHeader1"
              - "ExposeHeader2"
              - "ExposeHeader3"
              - "ExposeHeader4"
          AccessControlMaxAgeSec: 1200
          OriginOverride: true
        CustomHeadersConfig:
          Items:
            - Header: "HeaderX"
              Override: true
              Value: "ValueX"
            - Header: "HeaderY"
              Override: true
              Value: "ValueY"
        RemoveHeadersConfig:
          Items:
            - Header: "RemoveHeaderX"
            - Header: "RemoveHeaderY"
        SecurityHeadersConfig:
          ContentSecurityPolicy:
            ContentSecurityPolicy: "MyPolicy"
            Override: true
          ContentTypeOptions:
            Override: true
          FrameOptions:
            FrameOption: "SAMEORIGIN"
            Override: true
          ReferrerPolicy:
            ReferrerPolicy: "origin-when-cross-origin"
            Override: true
          StrictTransportSecurity:
            AccessControlMaxAgeSec: 2400
            IncludeSubdomains: true
            Override: true
            Preload: true
          XSSProtection:
            ModeBlock: true
            Override: true
            Protection: true
  RHPolicyWaiterCustomResource:
    Type: AWS::CloudFormation::CustomResource
    DeletionPolicy: Retain
    Properties:
      ServiceToken: !ImportValue RHPolicyLambdaWaiter
      WaitSeconds: 300
```

# AWS::CloudFront::ResponseHeadersPolicy AccessControlAllowHeaders
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders"></a>

A list of HTTP header names that CloudFront includes as values for the `Access-Control-Allow-Headers` HTTP response header.

For more information about the `Access-Control-Allow-Headers` HTTP response header, see [Access-Control-Allow-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-responseheaderspolicy-accesscontrolallowheaders-items)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-responseheaderspolicy-accesscontrolallowheaders-items): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders-properties"></a>

`Items`  <a name="cfn-cloudfront-responseheaderspolicy-accesscontrolallowheaders-items"></a>
The list of HTTP header names. You can specify `*` to allow all headers.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy AccessControlAllowMethods
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods"></a>

A list of HTTP methods that CloudFront includes as values for the `Access-Control-Allow-Methods` HTTP response header.

For more information about the `Access-Control-Allow-Methods` HTTP response header, see [Access-Control-Allow-Methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-responseheaderspolicy-accesscontrolallowmethods-items)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-responseheaderspolicy-accesscontrolallowmethods-items): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods-properties"></a>

`Items`  <a name="cfn-cloudfront-responseheaderspolicy-accesscontrolallowmethods-items"></a>
The list of HTTP methods. Valid values are:  
+  `GET` 
+  `DELETE` 
+  `HEAD` 
+  `OPTIONS` 
+  `PATCH` 
+  `POST` 
+  `PUT` 
+  `ALL` 
`ALL` is a special value that includes all of the listed HTTP methods.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy AccessControlAllowOrigins
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins"></a>

A list of origins (domain names) that CloudFront can use as the value for the `Access-Control-Allow-Origin` HTTP response header.

For more information about the `Access-Control-Allow-Origin` HTTP response header, see [Access-Control-Allow-Origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-responseheaderspolicy-accesscontrolalloworigins-items)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-responseheaderspolicy-accesscontrolalloworigins-items): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins-properties"></a>

`Items`  <a name="cfn-cloudfront-responseheaderspolicy-accesscontrolalloworigins-items"></a>
The list of origins (domain names). You can specify `*` to allow all origins.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy AccessControlExposeHeaders
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders"></a>

A list of HTTP headers that CloudFront includes as values for the `Access-Control-Expose-Headers` HTTP response header.

For more information about the `Access-Control-Expose-Headers` HTTP response header, see [Access-Control-Expose-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-responseheaderspolicy-accesscontrolexposeheaders-items)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-responseheaderspolicy-accesscontrolexposeheaders-items): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders-properties"></a>

`Items`  <a name="cfn-cloudfront-responseheaderspolicy-accesscontrolexposeheaders-items"></a>
The list of HTTP headers. You can specify `*` to expose all headers.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy ContentSecurityPolicy
<a name="aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy"></a>

The policy directives and their values that CloudFront includes as values for the `Content-Security-Policy` HTTP response header.

For more information about the `Content-Security-Policy` HTTP response header, see [Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy-syntax.json"></a>

```
{
  "[ContentSecurityPolicy](#cfn-cloudfront-responseheaderspolicy-contentsecuritypolicy-contentsecuritypolicy)" : String,
  "[Override](#cfn-cloudfront-responseheaderspolicy-contentsecuritypolicy-override)" : Boolean
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy-syntax.yaml"></a>

```
  [ContentSecurityPolicy](#cfn-cloudfront-responseheaderspolicy-contentsecuritypolicy-contentsecuritypolicy): String
  [Override](#cfn-cloudfront-responseheaderspolicy-contentsecuritypolicy-override): Boolean
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy-properties"></a>

`ContentSecurityPolicy`  <a name="cfn-cloudfront-responseheaderspolicy-contentsecuritypolicy-contentsecuritypolicy"></a>
The policy directives and their values that CloudFront includes as values for the `Content-Security-Policy` HTTP response header.  
*Required*: Yes  
*Type*: [String](#aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Override`  <a name="cfn-cloudfront-responseheaderspolicy-contentsecuritypolicy-override"></a>
A Boolean that determines whether CloudFront overrides the `Content-Security-Policy` HTTP response header received from the origin with the one specified in this response headers policy.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy ContentTypeOptions
<a name="aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions"></a>

Determines whether CloudFront includes the `X-Content-Type-Options` HTTP response header with its value set to `nosniff`.

For more information about the `X-Content-Type-Options` HTTP response header, see [X-Content-Type-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions-syntax.json"></a>

```
{
  "[Override](#cfn-cloudfront-responseheaderspolicy-contenttypeoptions-override)" : Boolean
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions-syntax.yaml"></a>

```
  [Override](#cfn-cloudfront-responseheaderspolicy-contenttypeoptions-override): Boolean
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions-properties"></a>

`Override`  <a name="cfn-cloudfront-responseheaderspolicy-contenttypeoptions-override"></a>
A Boolean that determines whether CloudFront overrides the `X-Content-Type-Options` HTTP response header received from the origin with the one specified in this response headers policy.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy CorsConfig
<a name="aws-properties-cloudfront-responseheaderspolicy-corsconfig"></a>

A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for CORS requests that match a cache behavior associated with this response headers policy.

For more information about CORS, see [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-corsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-corsconfig-syntax.json"></a>

```
{
  "[AccessControlAllowCredentials](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowcredentials)" : Boolean,
  "[AccessControlAllowHeaders](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowheaders)" : AccessControlAllowHeaders,
  "[AccessControlAllowMethods](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowmethods)" : AccessControlAllowMethods,
  "[AccessControlAllowOrigins](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolalloworigins)" : AccessControlAllowOrigins,
  "[AccessControlExposeHeaders](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolexposeheaders)" : AccessControlExposeHeaders,
  "[AccessControlMaxAgeSec](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolmaxagesec)" : Integer,
  "[OriginOverride](#cfn-cloudfront-responseheaderspolicy-corsconfig-originoverride)" : Boolean
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-corsconfig-syntax.yaml"></a>

```
  [AccessControlAllowCredentials](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowcredentials): Boolean
  [AccessControlAllowHeaders](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowheaders): 
    AccessControlAllowHeaders
  [AccessControlAllowMethods](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowmethods): 
    AccessControlAllowMethods
  [AccessControlAllowOrigins](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolalloworigins): 
    AccessControlAllowOrigins
  [AccessControlExposeHeaders](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolexposeheaders): 
    AccessControlExposeHeaders
  [AccessControlMaxAgeSec](#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolmaxagesec): Integer
  [OriginOverride](#cfn-cloudfront-responseheaderspolicy-corsconfig-originoverride): Boolean
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-corsconfig-properties"></a>

`AccessControlAllowCredentials`  <a name="cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowcredentials"></a>
A Boolean that CloudFront uses as the value for the `Access-Control-Allow-Credentials` HTTP response header.  
For more information about the `Access-Control-Allow-Credentials` HTTP response header, see [Access-Control-Allow-Credentials](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials) in the MDN Web Docs.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AccessControlAllowHeaders`  <a name="cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowheaders"></a>
A list of HTTP header names that CloudFront includes as values for the `Access-Control-Allow-Headers` HTTP response header.  
For more information about the `Access-Control-Allow-Headers` HTTP response header, see [Access-Control-Allow-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) in the MDN Web Docs.  
*Required*: Yes  
*Type*: [AccessControlAllowHeaders](aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AccessControlAllowMethods`  <a name="cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowmethods"></a>
A list of HTTP methods that CloudFront includes as values for the `Access-Control-Allow-Methods` HTTP response header.  
For more information about the `Access-Control-Allow-Methods` HTTP response header, see [Access-Control-Allow-Methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) in the MDN Web Docs.  
*Required*: Yes  
*Type*: [AccessControlAllowMethods](aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AccessControlAllowOrigins`  <a name="cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolalloworigins"></a>
A list of origins (domain names) that CloudFront can use as the value for the `Access-Control-Allow-Origin` HTTP response header.  
For more information about the `Access-Control-Allow-Origin` HTTP response header, see [Access-Control-Allow-Origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) in the MDN Web Docs.  
*Required*: Yes  
*Type*: [AccessControlAllowOrigins](aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AccessControlExposeHeaders`  <a name="cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolexposeheaders"></a>
A list of HTTP headers that CloudFront includes as values for the `Access-Control-Expose-Headers` HTTP response header.  
For more information about the `Access-Control-Expose-Headers` HTTP response header, see [Access-Control-Expose-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) in the MDN Web Docs.  
*Required*: No  
*Type*: [AccessControlExposeHeaders](aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AccessControlMaxAgeSec`  <a name="cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolmaxagesec"></a>
A number that CloudFront uses as the value for the `Access-Control-Max-Age` HTTP response header.  
For more information about the `Access-Control-Max-Age` HTTP response header, see [Access-Control-Max-Age](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age) in the MDN Web Docs.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginOverride`  <a name="cfn-cloudfront-responseheaderspolicy-corsconfig-originoverride"></a>
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy CustomHeader
<a name="aws-properties-cloudfront-responseheaderspolicy-customheader"></a>

An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-customheader-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-customheader-syntax.json"></a>

```
{
  "[Header](#cfn-cloudfront-responseheaderspolicy-customheader-header)" : String,
  "[Override](#cfn-cloudfront-responseheaderspolicy-customheader-override)" : Boolean,
  "[Value](#cfn-cloudfront-responseheaderspolicy-customheader-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-customheader-syntax.yaml"></a>

```
  [Header](#cfn-cloudfront-responseheaderspolicy-customheader-header): String
  [Override](#cfn-cloudfront-responseheaderspolicy-customheader-override): Boolean
  [Value](#cfn-cloudfront-responseheaderspolicy-customheader-value): String
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-customheader-properties"></a>

`Header`  <a name="cfn-cloudfront-responseheaderspolicy-customheader-header"></a>
The HTTP response header name.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Override`  <a name="cfn-cloudfront-responseheaderspolicy-customheader-override"></a>
A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-responseheaderspolicy-customheader-value"></a>
The value for the HTTP response header.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy CustomHeadersConfig
<a name="aws-properties-cloudfront-responseheaderspolicy-customheadersconfig"></a>

A list of HTTP response header names and their values. CloudFront includes these headers in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-customheadersconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-customheadersconfig-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-responseheaderspolicy-customheadersconfig-items)" : [ CustomHeader, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-customheadersconfig-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-responseheaderspolicy-customheadersconfig-items): 
    - CustomHeader
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-customheadersconfig-properties"></a>

`Items`  <a name="cfn-cloudfront-responseheaderspolicy-customheadersconfig-items"></a>
The list of HTTP response headers and their values.  
*Required*: Yes  
*Type*: Array of [CustomHeader](aws-properties-cloudfront-responseheaderspolicy-customheader.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy FrameOptions
<a name="aws-properties-cloudfront-responseheaderspolicy-frameoptions"></a>

Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header's value.

For more information about the `X-Frame-Options` HTTP response header, see [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-frameoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-frameoptions-syntax.json"></a>

```
{
  "[FrameOption](#cfn-cloudfront-responseheaderspolicy-frameoptions-frameoption)" : String,
  "[Override](#cfn-cloudfront-responseheaderspolicy-frameoptions-override)" : Boolean
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-frameoptions-syntax.yaml"></a>

```
  [FrameOption](#cfn-cloudfront-responseheaderspolicy-frameoptions-frameoption): String
  [Override](#cfn-cloudfront-responseheaderspolicy-frameoptions-override): Boolean
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-frameoptions-properties"></a>

`FrameOption`  <a name="cfn-cloudfront-responseheaderspolicy-frameoptions-frameoption"></a>
The value of the `X-Frame-Options` HTTP response header. Valid values are `DENY` and `SAMEORIGIN`.  
For more information about these values, see [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(DENY|SAMEORIGIN)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Override`  <a name="cfn-cloudfront-responseheaderspolicy-frameoptions-override"></a>
A Boolean that determines whether CloudFront overrides the `X-Frame-Options` HTTP response header received from the origin with the one specified in this response headers policy.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy ReferrerPolicy
<a name="aws-properties-cloudfront-responseheaderspolicy-referrerpolicy"></a>

Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header's value.

For more information about the `Referrer-Policy` HTTP response header, see [Referrer-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-referrerpolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-referrerpolicy-syntax.json"></a>

```
{
  "[Override](#cfn-cloudfront-responseheaderspolicy-referrerpolicy-override)" : Boolean,
  "[ReferrerPolicy](#cfn-cloudfront-responseheaderspolicy-referrerpolicy-referrerpolicy)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-referrerpolicy-syntax.yaml"></a>

```
  [Override](#cfn-cloudfront-responseheaderspolicy-referrerpolicy-override): Boolean
  [ReferrerPolicy](#cfn-cloudfront-responseheaderspolicy-referrerpolicy-referrerpolicy): String
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-referrerpolicy-properties"></a>

`Override`  <a name="cfn-cloudfront-responseheaderspolicy-referrerpolicy-override"></a>
A Boolean that determines whether CloudFront overrides the `Referrer-Policy` HTTP response header received from the origin with the one specified in this response headers policy.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReferrerPolicy`  <a name="cfn-cloudfront-responseheaderspolicy-referrerpolicy-referrerpolicy"></a>
The value of the `Referrer-Policy` HTTP response header. Valid values are:  
+  `no-referrer` 
+  `no-referrer-when-downgrade` 
+  `origin` 
+  `origin-when-cross-origin` 
+  `same-origin` 
+  `strict-origin` 
+  `strict-origin-when-cross-origin` 
+  `unsafe-url` 
For more information about these values, see [Referrer-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs.  
*Required*: Yes  
*Type*: [String](#aws-properties-cloudfront-responseheaderspolicy-referrerpolicy)  
*Pattern*: `^(no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy RemoveHeader
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheader"></a>

The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheader-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheader-syntax.json"></a>

```
{
  "[Header](#cfn-cloudfront-responseheaderspolicy-removeheader-header)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheader-syntax.yaml"></a>

```
  [Header](#cfn-cloudfront-responseheaderspolicy-removeheader-header): String
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheader-properties"></a>

`Header`  <a name="cfn-cloudfront-responseheaderspolicy-removeheader-header"></a>
The HTTP header name.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy RemoveHeadersConfig
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig"></a>

A list of HTTP header names that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig-syntax.json"></a>

```
{
  "[Items](#cfn-cloudfront-responseheaderspolicy-removeheadersconfig-items)" : [ RemoveHeader, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig-syntax.yaml"></a>

```
  [Items](#cfn-cloudfront-responseheaderspolicy-removeheadersconfig-items): 
    - RemoveHeader
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig-properties"></a>

`Items`  <a name="cfn-cloudfront-responseheaderspolicy-removeheadersconfig-items"></a>
The list of HTTP header names.  
*Required*: Yes  
*Type*: Array of [RemoveHeader](aws-properties-cloudfront-responseheaderspolicy-removeheader.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy ResponseHeadersPolicyConfig
<a name="aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig"></a>

A response headers policy configuration.

A response headers policy configuration contains metadata about the response headers policy, and configurations for sets of HTTP response headers.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-syntax.json"></a>

```
{
  "[Comment](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-comment)" : String,
  "[CorsConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-corsconfig)" : CorsConfig,
  "[CustomHeadersConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-customheadersconfig)" : CustomHeadersConfig,
  "[Name](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-name)" : String,
  "[RemoveHeadersConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-removeheadersconfig)" : RemoveHeadersConfig,
  "[SecurityHeadersConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-securityheadersconfig)" : SecurityHeadersConfig,
  "[ServerTimingHeadersConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-servertimingheadersconfig)" : ServerTimingHeadersConfig
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-syntax.yaml"></a>

```
  [Comment](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-comment): String
  [CorsConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-corsconfig): 
    CorsConfig
  [CustomHeadersConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-customheadersconfig): 
    CustomHeadersConfig
  [Name](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-name): String
  [RemoveHeadersConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-removeheadersconfig): 
    RemoveHeadersConfig
  [SecurityHeadersConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-securityheadersconfig): 
    SecurityHeadersConfig
  [ServerTimingHeadersConfig](#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-servertimingheadersconfig): 
    ServerTimingHeadersConfig
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-properties"></a>

`Comment`  <a name="cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-comment"></a>
A comment to describe the response headers policy.  
The comment cannot be longer than 128 characters.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CorsConfig`  <a name="cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-corsconfig"></a>
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).  
*Required*: No  
*Type*: [CorsConfig](aws-properties-cloudfront-responseheaderspolicy-corsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomHeadersConfig`  <a name="cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-customheadersconfig"></a>
A configuration for a set of custom HTTP response headers.  
*Required*: No  
*Type*: [CustomHeadersConfig](aws-properties-cloudfront-responseheaderspolicy-customheadersconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-name"></a>
A name to identify the response headers policy.  
The name must be unique for response headers policies in this AWS account.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RemoveHeadersConfig`  <a name="cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-removeheadersconfig"></a>
A configuration for a set of HTTP headers to remove from the HTTP response.  
*Required*: No  
*Type*: [RemoveHeadersConfig](aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityHeadersConfig`  <a name="cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-securityheadersconfig"></a>
A configuration for a set of security-related HTTP response headers.  
*Required*: No  
*Type*: [SecurityHeadersConfig](aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerTimingHeadersConfig`  <a name="cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-servertimingheadersconfig"></a>
A configuration for enabling the `Server-Timing` header in HTTP responses sent from CloudFront.  
*Required*: No  
*Type*: [ServerTimingHeadersConfig](aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy SecurityHeadersConfig
<a name="aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig"></a>

A configuration for a set of security-related HTTP response headers. CloudFront adds these headers to HTTP responses that it sends for requests that match a cache behavior associated with this response headers policy.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig-syntax.json"></a>

```
{
  "[ContentSecurityPolicy](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-contentsecuritypolicy)" : ContentSecurityPolicy,
  "[ContentTypeOptions](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-contenttypeoptions)" : ContentTypeOptions,
  "[FrameOptions](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-frameoptions)" : FrameOptions,
  "[ReferrerPolicy](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-referrerpolicy)" : ReferrerPolicy,
  "[StrictTransportSecurity](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-stricttransportsecurity)" : StrictTransportSecurity,
  "[XSSProtection](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-xssprotection)" : XSSProtection
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig-syntax.yaml"></a>

```
  [ContentSecurityPolicy](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-contentsecuritypolicy): 
    ContentSecurityPolicy
  [ContentTypeOptions](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-contenttypeoptions): 
    ContentTypeOptions
  [FrameOptions](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-frameoptions): 
    FrameOptions
  [ReferrerPolicy](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-referrerpolicy): 
    ReferrerPolicy
  [StrictTransportSecurity](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-stricttransportsecurity): 
    StrictTransportSecurity
  [XSSProtection](#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-xssprotection): 
    XSSProtection
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig-properties"></a>

`ContentSecurityPolicy`  <a name="cfn-cloudfront-responseheaderspolicy-securityheadersconfig-contentsecuritypolicy"></a>
The policy directives and their values that CloudFront includes as values for the `Content-Security-Policy` HTTP response header.  
For more information about the `Content-Security-Policy` HTTP response header, see [Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs.  
*Required*: No  
*Type*: [ContentSecurityPolicy](aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContentTypeOptions`  <a name="cfn-cloudfront-responseheaderspolicy-securityheadersconfig-contenttypeoptions"></a>
Determines whether CloudFront includes the `X-Content-Type-Options` HTTP response header with its value set to `nosniff`.  
For more information about the `X-Content-Type-Options` HTTP response header, see [X-Content-Type-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) in the MDN Web Docs.  
*Required*: No  
*Type*: [ContentTypeOptions](aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FrameOptions`  <a name="cfn-cloudfront-responseheaderspolicy-securityheadersconfig-frameoptions"></a>
Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header's value.  
For more information about the `X-Frame-Options` HTTP response header, see [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs.  
*Required*: No  
*Type*: [FrameOptions](aws-properties-cloudfront-responseheaderspolicy-frameoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReferrerPolicy`  <a name="cfn-cloudfront-responseheaderspolicy-securityheadersconfig-referrerpolicy"></a>
Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header's value.  
For more information about the `Referrer-Policy` HTTP response header, see [Referrer-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs.  
*Required*: No  
*Type*: [ReferrerPolicy](aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StrictTransportSecurity`  <a name="cfn-cloudfront-responseheaderspolicy-securityheadersconfig-stricttransportsecurity"></a>
Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header's value.  
For more information about the `Strict-Transport-Security` HTTP response header, see [Security headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#understanding-response-headers-policies-security) in the *Amazon CloudFront Developer Guide* and [Strict-Transport-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs.  
*Required*: No  
*Type*: [StrictTransportSecurity](aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`XSSProtection`  <a name="cfn-cloudfront-responseheaderspolicy-securityheadersconfig-xssprotection"></a>
Determines whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header's value.  
For more information about the `X-XSS-Protection` HTTP response header, see [X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs.  
*Required*: No  
*Type*: [XSSProtection](aws-properties-cloudfront-responseheaderspolicy-xssprotection.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy ServerTimingHeadersConfig
<a name="aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig"></a>

A configuration for enabling the `Server-Timing` header in HTTP responses sent from CloudFront.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig-syntax.json"></a>

```
{
  "[Enabled](#cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-enabled)" : Boolean,
  "[SamplingRate](#cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-samplingrate)" : Number
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig-syntax.yaml"></a>

```
  [Enabled](#cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-enabled): Boolean
  [SamplingRate](#cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-samplingrate): Number
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig-properties"></a>

`Enabled`  <a name="cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-enabled"></a>
A Boolean that determines whether CloudFront adds the `Server-Timing` header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SamplingRate`  <a name="cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-samplingrate"></a>
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the `Server-Timing` header to. When you set the sampling rate to 100, CloudFront adds the `Server-Timing` header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy StrictTransportSecurity
<a name="aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity"></a>

Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header's value.

For more information about the `Strict-Transport-Security` HTTP response header, see [Strict-Transport-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity-syntax.json"></a>

```
{
  "[AccessControlMaxAgeSec](#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-accesscontrolmaxagesec)" : Integer,
  "[IncludeSubdomains](#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-includesubdomains)" : Boolean,
  "[Override](#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-override)" : Boolean,
  "[Preload](#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-preload)" : Boolean
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity-syntax.yaml"></a>

```
  [AccessControlMaxAgeSec](#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-accesscontrolmaxagesec): Integer
  [IncludeSubdomains](#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-includesubdomains): Boolean
  [Override](#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-override): Boolean
  [Preload](#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-preload): Boolean
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity-properties"></a>

`AccessControlMaxAgeSec`  <a name="cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-accesscontrolmaxagesec"></a>
A number that CloudFront uses as the value for the `max-age` directive in the `Strict-Transport-Security` HTTP response header.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IncludeSubdomains`  <a name="cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-includesubdomains"></a>
A Boolean that determines whether CloudFront includes the `includeSubDomains` directive in the `Strict-Transport-Security` HTTP response header.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Override`  <a name="cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-override"></a>
A Boolean that determines whether CloudFront overrides the `Strict-Transport-Security` HTTP response header received from the origin with the one specified in this response headers policy.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Preload`  <a name="cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-preload"></a>
A Boolean that determines whether CloudFront includes the `preload` directive in the `Strict-Transport-Security` HTTP response header.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::ResponseHeadersPolicy XSSProtection
<a name="aws-properties-cloudfront-responseheaderspolicy-xssprotection"></a>

Determines whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header's value.

For more information about the `X-XSS-Protection` HTTP response header, see [X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs.

## Syntax
<a name="aws-properties-cloudfront-responseheaderspolicy-xssprotection-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-responseheaderspolicy-xssprotection-syntax.json"></a>

```
{
  "[ModeBlock](#cfn-cloudfront-responseheaderspolicy-xssprotection-modeblock)" : Boolean,
  "[Override](#cfn-cloudfront-responseheaderspolicy-xssprotection-override)" : Boolean,
  "[Protection](#cfn-cloudfront-responseheaderspolicy-xssprotection-protection)" : Boolean,
  "[ReportUri](#cfn-cloudfront-responseheaderspolicy-xssprotection-reporturi)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-responseheaderspolicy-xssprotection-syntax.yaml"></a>

```
  [ModeBlock](#cfn-cloudfront-responseheaderspolicy-xssprotection-modeblock): Boolean
  [Override](#cfn-cloudfront-responseheaderspolicy-xssprotection-override): Boolean
  [Protection](#cfn-cloudfront-responseheaderspolicy-xssprotection-protection): Boolean
  [ReportUri](#cfn-cloudfront-responseheaderspolicy-xssprotection-reporturi): String
```

## Properties
<a name="aws-properties-cloudfront-responseheaderspolicy-xssprotection-properties"></a>

`ModeBlock`  <a name="cfn-cloudfront-responseheaderspolicy-xssprotection-modeblock"></a>
A Boolean that determines whether CloudFront includes the `mode=block` directive in the `X-XSS-Protection` header.  
For more information about this directive, see [X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Override`  <a name="cfn-cloudfront-responseheaderspolicy-xssprotection-override"></a>
A Boolean that determines whether CloudFront overrides the `X-XSS-Protection` HTTP response header received from the origin with the one specified in this response headers policy.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Protection`  <a name="cfn-cloudfront-responseheaderspolicy-xssprotection-protection"></a>
A Boolean that determines the value of the `X-XSS-Protection` HTTP response header. When this setting is `true`, the value of the `X-XSS-Protection` header is `1`. When this setting is `false`, the value of the `X-XSS-Protection` header is `0`.  
For more information about these settings, see [X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReportUri`  <a name="cfn-cloudfront-responseheaderspolicy-xssprotection-reporturi"></a>
A reporting URI, which CloudFront uses as the value of the `report` directive in the `X-XSS-Protection` header.  
You cannot specify a `ReportUri` when `ModeBlock` is `true`.  
For more information about using a reporting URL, see [X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::StreamingDistribution
<a name="aws-resource-cloudfront-streamingdistribution"></a>

This resource is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, [read the announcement](https://forums.aws.amazon.com/ann.jspa?annID=7356) on the Amazon CloudFront discussion forum.

## Syntax
<a name="aws-resource-cloudfront-streamingdistribution-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-streamingdistribution-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::StreamingDistribution",
  "Properties" : {
      "[StreamingDistributionConfig](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig)" : StreamingDistributionConfig,
      "[Tags](#cfn-cloudfront-streamingdistribution-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-cloudfront-streamingdistribution-syntax.yaml"></a>

```
Type: AWS::CloudFront::StreamingDistribution
Properties:
  [StreamingDistributionConfig](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig): 
    StreamingDistributionConfig
  [Tags](#cfn-cloudfront-streamingdistribution-tags): 
    - Tag
```

## Properties
<a name="aws-resource-cloudfront-streamingdistribution-properties"></a>

`StreamingDistributionConfig`  <a name="cfn-cloudfront-streamingdistribution-streamingdistributionconfig"></a>
The current configuration information for the RTMP distribution.  
*Required*: Yes  
*Type*: [StreamingDistributionConfig](aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-cloudfront-streamingdistribution-tags"></a>
A complex type that contains zero or more `Tag` elements.  
*Required*: Yes  
*Type*: Array of [Tag](aws-properties-cloudfront-streamingdistribution-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-streamingdistribution-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-streamingdistribution-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the streaming distribution ID, such as `E1E7FEN9T35R9W`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cloudfront-streamingdistribution-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cloudfront-streamingdistribution-return-values-fn--getatt-fn--getatt"></a>

`DomainName`  <a name="DomainName-fn::getatt"></a>
The domain name of the resource, such as `d111111abcdef8.cloudfront.net`.

# AWS::CloudFront::StreamingDistribution Logging
<a name="aws-properties-cloudfront-streamingdistribution-logging"></a>

A complex type that controls whether access logs are written for the streaming distribution.

## Syntax
<a name="aws-properties-cloudfront-streamingdistribution-logging-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-streamingdistribution-logging-syntax.json"></a>

```
{
  "[Bucket](#cfn-cloudfront-streamingdistribution-logging-bucket)" : String,
  "[Enabled](#cfn-cloudfront-streamingdistribution-logging-enabled)" : Boolean,
  "[Prefix](#cfn-cloudfront-streamingdistribution-logging-prefix)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-streamingdistribution-logging-syntax.yaml"></a>

```
  [Bucket](#cfn-cloudfront-streamingdistribution-logging-bucket): String
  [Enabled](#cfn-cloudfront-streamingdistribution-logging-enabled): Boolean
  [Prefix](#cfn-cloudfront-streamingdistribution-logging-prefix): String
```

## Properties
<a name="aws-properties-cloudfront-streamingdistribution-logging-properties"></a>

`Bucket`  <a name="cfn-cloudfront-streamingdistribution-logging-bucket"></a>
The Amazon S3 bucket to store the access logs in, for example, `amzn-s3-demo-bucket.s3.amazonaws.com`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-cloudfront-streamingdistribution-logging-enabled"></a>
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify `false` for `Enabled`, and specify `empty Bucket` and `Prefix` elements. If you specify `false` for `Enabled` but you specify values for `Bucket` and `Prefix`, the values are automatically deleted.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Prefix`  <a name="cfn-cloudfront-streamingdistribution-logging-prefix"></a>
An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, `myprefix/`. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty `Prefix` element in the `Logging` element.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-streamingdistribution-logging--seealso"></a>
+ [StreamingLoggingConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_StreamingLoggingConfig.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::StreamingDistribution S3Origin
<a name="aws-properties-cloudfront-streamingdistribution-s3origin"></a>

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

## Syntax
<a name="aws-properties-cloudfront-streamingdistribution-s3origin-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-streamingdistribution-s3origin-syntax.json"></a>

```
{
  "[DomainName](#cfn-cloudfront-streamingdistribution-s3origin-domainname)" : String,
  "[OriginAccessIdentity](#cfn-cloudfront-streamingdistribution-s3origin-originaccessidentity)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-streamingdistribution-s3origin-syntax.yaml"></a>

```
  [DomainName](#cfn-cloudfront-streamingdistribution-s3origin-domainname): String
  [OriginAccessIdentity](#cfn-cloudfront-streamingdistribution-s3origin-originaccessidentity): String
```

## Properties
<a name="aws-properties-cloudfront-streamingdistribution-s3origin-properties"></a>

`DomainName`  <a name="cfn-cloudfront-streamingdistribution-s3origin-domainname"></a>
The DNS name of the Amazon S3 origin.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginAccessIdentity`  <a name="cfn-cloudfront-streamingdistribution-s3origin-originaccessidentity"></a>
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 bucket through CloudFront.  
If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty `OriginAccessIdentity` element.  
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` element.  
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.  
For more information, see [Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the * Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-streamingdistribution-s3origin--seealso"></a>
+ [S3Origin](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_S3Origin.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::StreamingDistribution StreamingDistributionConfig
<a name="aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig"></a>

The RTMP distribution's configuration information.

## Syntax
<a name="aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig-syntax.json"></a>

```
{
  "[Aliases](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-aliases)" : [ String, ... ],
  "[Comment](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-comment)" : String,
  "[Enabled](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-enabled)" : Boolean,
  "[Logging](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-logging)" : Logging,
  "[PriceClass](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-priceclass)" : String,
  "[S3Origin](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-s3origin)" : S3Origin,
  "[TrustedSigners](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-trustedsigners)" : TrustedSigners
}
```

### YAML
<a name="aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig-syntax.yaml"></a>

```
  [Aliases](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-aliases): 
    - String
  [Comment](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-comment): String
  [Enabled](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-enabled): Boolean
  [Logging](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-logging): 
    Logging
  [PriceClass](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-priceclass): String
  [S3Origin](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-s3origin): 
    S3Origin
  [TrustedSigners](#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-trustedsigners): 
    TrustedSigners
```

## Properties
<a name="aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig-properties"></a>

`Aliases`  <a name="cfn-cloudfront-streamingdistribution-streamingdistributionconfig-aliases"></a>
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Comment`  <a name="cfn-cloudfront-streamingdistribution-streamingdistributionconfig-comment"></a>
Any comments you want to include about the streaming distribution.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-cloudfront-streamingdistribution-streamingdistributionconfig-enabled"></a>
Whether the streaming distribution is enabled to accept user requests for content.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Logging`  <a name="cfn-cloudfront-streamingdistribution-streamingdistributionconfig-logging"></a>
A complex type that controls whether access logs are written for the streaming distribution.  
*Required*: No  
*Type*: [Logging](aws-properties-cloudfront-streamingdistribution-logging.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PriceClass`  <a name="cfn-cloudfront-streamingdistribution-streamingdistributionconfig-priceclass"></a>
A complex type that contains information about price class for this streaming distribution.  
*Required*: No  
*Type*: String  
*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All | None`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Origin`  <a name="cfn-cloudfront-streamingdistribution-streamingdistributionconfig-s3origin"></a>
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.  
*Required*: Yes  
*Type*: [S3Origin](aws-properties-cloudfront-streamingdistribution-s3origin.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrustedSigners`  <a name="cfn-cloudfront-streamingdistribution-streamingdistributionconfig-trustedsigners"></a>
A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.  
*Required*: Yes  
*Type*: [TrustedSigners](aws-properties-cloudfront-streamingdistribution-trustedsigners.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig--seealso"></a>
+ [StreamingDistributionConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_StreamingDistributionConfig.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::StreamingDistribution Tag
<a name="aws-properties-cloudfront-streamingdistribution-tag"></a>

A complex type that contains `Tag` key and `Tag` value.

## Syntax
<a name="aws-properties-cloudfront-streamingdistribution-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-streamingdistribution-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cloudfront-streamingdistribution-tag-key)" : String,
  "[Value](#cfn-cloudfront-streamingdistribution-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-streamingdistribution-tag-syntax.yaml"></a>

```
  [Key](#cfn-cloudfront-streamingdistribution-tag-key): String
  [Value](#cfn-cloudfront-streamingdistribution-tag-value): String
```

## Properties
<a name="aws-properties-cloudfront-streamingdistribution-tag-properties"></a>

`Key`  <a name="cfn-cloudfront-streamingdistribution-tag-key"></a>
A string that contains `Tag` key.  
The string length should be between 1 and 128 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-streamingdistribution-tag-value"></a>
A string that contains an optional `Tag` value.  
The string length should be between 0 and 256 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::StreamingDistribution TrustedSigners
<a name="aws-properties-cloudfront-streamingdistribution-trustedsigners"></a>

A list of AWS accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.

## Syntax
<a name="aws-properties-cloudfront-streamingdistribution-trustedsigners-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-streamingdistribution-trustedsigners-syntax.json"></a>

```
{
  "[AwsAccountNumbers](#cfn-cloudfront-streamingdistribution-trustedsigners-awsaccountnumbers)" : [ String, ... ],
  "[Enabled](#cfn-cloudfront-streamingdistribution-trustedsigners-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-cloudfront-streamingdistribution-trustedsigners-syntax.yaml"></a>

```
  [AwsAccountNumbers](#cfn-cloudfront-streamingdistribution-trustedsigners-awsaccountnumbers): 
    - String
  [Enabled](#cfn-cloudfront-streamingdistribution-trustedsigners-enabled): Boolean
```

## Properties
<a name="aws-properties-cloudfront-streamingdistribution-trustedsigners-properties"></a>

`AwsAccountNumbers`  <a name="cfn-cloudfront-streamingdistribution-trustedsigners-awsaccountnumbers"></a>
An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is `self`.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-cloudfront-streamingdistribution-trustedsigners-enabled"></a>
This field is `true` if any of the AWS accounts in the list are configured as trusted signers. If not, this field is `false`.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-cloudfront-streamingdistribution-trustedsigners--seealso"></a>
+ [TrustedSigners](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_TrustedSigners.html) in the *Amazon CloudFront API Reference*



# AWS::CloudFront::TrustStore
<a name="aws-resource-cloudfront-truststore"></a>

A trust store.

## Syntax
<a name="aws-resource-cloudfront-truststore-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-truststore-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::TrustStore",
  "Properties" : {
      "[CaCertificatesBundleSource](#cfn-cloudfront-truststore-cacertificatesbundlesource)" : CaCertificatesBundleSource,
      "[Name](#cfn-cloudfront-truststore-name)" : String,
      "[Tags](#cfn-cloudfront-truststore-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-cloudfront-truststore-syntax.yaml"></a>

```
Type: AWS::CloudFront::TrustStore
Properties:
  [CaCertificatesBundleSource](#cfn-cloudfront-truststore-cacertificatesbundlesource): 
    CaCertificatesBundleSource
  [Name](#cfn-cloudfront-truststore-name): String
  [Tags](#cfn-cloudfront-truststore-tags): 
    - Tag
```

## Properties
<a name="aws-resource-cloudfront-truststore-properties"></a>

`CaCertificatesBundleSource`  <a name="cfn-cloudfront-truststore-cacertificatesbundlesource"></a>
A CA certificates bundle source.  
*Required*: No  
*Type*: [CaCertificatesBundleSource](aws-properties-cloudfront-truststore-cacertificatesbundlesource.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-truststore-name"></a>
The trust store's name.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-cloudfront-truststore-tags"></a>
A complex type that contains zero or more `Tag` elements.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cloudfront-truststore-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-truststore-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-truststore-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-cloudfront-truststore-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-cloudfront-truststore-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The trust store's Amazon Resource Name (ARN).

`ETag`  <a name="ETag-fn::getatt"></a>
The version identifier for the current version of the trust store.

`Id`  <a name="Id-fn::getatt"></a>
The trust store's ID.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The trust store's last modified time.

`NumberOfCaCertificates`  <a name="NumberOfCaCertificates-fn::getatt"></a>
The trust store's number of CA certificates.

`Status`  <a name="Status-fn::getatt"></a>
The trust store's status.

# AWS::CloudFront::TrustStore CaCertificatesBundleS3Location
<a name="aws-properties-cloudfront-truststore-cacertificatesbundles3location"></a>

The CA certificates bundle location in Amazon S3.

## Syntax
<a name="aws-properties-cloudfront-truststore-cacertificatesbundles3location-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-truststore-cacertificatesbundles3location-syntax.json"></a>

```
{
  "[Bucket](#cfn-cloudfront-truststore-cacertificatesbundles3location-bucket)" : String,
  "[Key](#cfn-cloudfront-truststore-cacertificatesbundles3location-key)" : String,
  "[Region](#cfn-cloudfront-truststore-cacertificatesbundles3location-region)" : String,
  "[Version](#cfn-cloudfront-truststore-cacertificatesbundles3location-version)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-truststore-cacertificatesbundles3location-syntax.yaml"></a>

```
  [Bucket](#cfn-cloudfront-truststore-cacertificatesbundles3location-bucket): String
  [Key](#cfn-cloudfront-truststore-cacertificatesbundles3location-key): String
  [Region](#cfn-cloudfront-truststore-cacertificatesbundles3location-region): String
  [Version](#cfn-cloudfront-truststore-cacertificatesbundles3location-version): String
```

## Properties
<a name="aws-properties-cloudfront-truststore-cacertificatesbundles3location-properties"></a>

`Bucket`  <a name="cfn-cloudfront-truststore-cacertificatesbundles3location-bucket"></a>
The S3 bucket.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Key`  <a name="cfn-cloudfront-truststore-cacertificatesbundles3location-key"></a>
The location's key.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Region`  <a name="cfn-cloudfront-truststore-cacertificatesbundles3location-region"></a>
The location's Region.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z]{2}-[a-z]+-\d`  
*Minimum*: `1`  
*Maximum*: `32`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Version`  <a name="cfn-cloudfront-truststore-cacertificatesbundles3location-version"></a>
The location's version.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::TrustStore CaCertificatesBundleSource
<a name="aws-properties-cloudfront-truststore-cacertificatesbundlesource"></a>

A CA certificates bundle source.

## Syntax
<a name="aws-properties-cloudfront-truststore-cacertificatesbundlesource-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-truststore-cacertificatesbundlesource-syntax.json"></a>

```
{
  "[CaCertificatesBundleS3Location](#cfn-cloudfront-truststore-cacertificatesbundlesource-cacertificatesbundles3location)" : CaCertificatesBundleS3Location
}
```

### YAML
<a name="aws-properties-cloudfront-truststore-cacertificatesbundlesource-syntax.yaml"></a>

```
  [CaCertificatesBundleS3Location](#cfn-cloudfront-truststore-cacertificatesbundlesource-cacertificatesbundles3location): 
    CaCertificatesBundleS3Location
```

## Properties
<a name="aws-properties-cloudfront-truststore-cacertificatesbundlesource-properties"></a>

`CaCertificatesBundleS3Location`  <a name="cfn-cloudfront-truststore-cacertificatesbundlesource-cacertificatesbundles3location"></a>
The CA certificates bundle location in Amazon S3.  
*Required*: Yes  
*Type*: [CaCertificatesBundleS3Location](aws-properties-cloudfront-truststore-cacertificatesbundles3location.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::TrustStore Tag
<a name="aws-properties-cloudfront-truststore-tag"></a>

A complex type that contains `Tag` key and `Tag` value.

## Syntax
<a name="aws-properties-cloudfront-truststore-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-truststore-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cloudfront-truststore-tag-key)" : String,
  "[Value](#cfn-cloudfront-truststore-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-truststore-tag-syntax.yaml"></a>

```
  [Key](#cfn-cloudfront-truststore-tag-key): String
  [Value](#cfn-cloudfront-truststore-tag-value): String
```

## Properties
<a name="aws-properties-cloudfront-truststore-tag-properties"></a>

`Key`  <a name="cfn-cloudfront-truststore-tag-key"></a>
A string that contains `Tag` key.  
The string length should be between 1 and 128 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-truststore-tag-value"></a>
A string that contains an optional `Tag` value.  
The string length should be between 0 and 256 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::VpcOrigin
<a name="aws-resource-cloudfront-vpcorigin"></a>

An Amazon CloudFront VPC origin.

## Syntax
<a name="aws-resource-cloudfront-vpcorigin-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-cloudfront-vpcorigin-syntax.json"></a>

```
{
  "Type" : "AWS::CloudFront::VpcOrigin",
  "Properties" : {
      "[Tags](#cfn-cloudfront-vpcorigin-tags)" : [ Tag, ... ],
      "[VpcOriginEndpointConfig](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig)" : VpcOriginEndpointConfig
    }
}
```

### YAML
<a name="aws-resource-cloudfront-vpcorigin-syntax.yaml"></a>

```
Type: AWS::CloudFront::VpcOrigin
Properties:
  [Tags](#cfn-cloudfront-vpcorigin-tags): 
    - Tag
  [VpcOriginEndpointConfig](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig): 
    VpcOriginEndpointConfig
```

## Properties
<a name="aws-resource-cloudfront-vpcorigin-properties"></a>

`Tags`  <a name="cfn-cloudfront-vpcorigin-tags"></a>
A complex type that contains zero or more `Tag` elements.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cloudfront-vpcorigin-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcOriginEndpointConfig`  <a name="cfn-cloudfront-vpcorigin-vpcoriginendpointconfig"></a>
The VPC origin endpoint configuration.  
*Required*: Yes  
*Type*: [VpcOriginEndpointConfig](aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cloudfront-vpcorigin-return-values"></a>

### Ref
<a name="aws-resource-cloudfront-vpcorigin-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-cloudfront-vpcorigin-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-cloudfront-vpcorigin-return-values-fn--getatt-fn--getatt"></a>

`AccountId`  <a name="AccountId-fn::getatt"></a>
The account ID of the AWS account that owns the VPC origin.

`Arn`  <a name="Arn-fn::getatt"></a>
The VPC origin ARN.

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
The VPC origin created time.

`Id`  <a name="Id-fn::getatt"></a>
The VPC origin ID.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
The VPC origin last modified time.

`Status`  <a name="Status-fn::getatt"></a>
The VPC origin status.

# AWS::CloudFront::VpcOrigin Tag
<a name="aws-properties-cloudfront-vpcorigin-tag"></a>

A complex type that contains `Tag` key and `Tag` value.

## Syntax
<a name="aws-properties-cloudfront-vpcorigin-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-vpcorigin-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cloudfront-vpcorigin-tag-key)" : String,
  "[Value](#cfn-cloudfront-vpcorigin-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cloudfront-vpcorigin-tag-syntax.yaml"></a>

```
  [Key](#cfn-cloudfront-vpcorigin-tag-key): String
  [Value](#cfn-cloudfront-vpcorigin-tag-value): String
```

## Properties
<a name="aws-properties-cloudfront-vpcorigin-tag-properties"></a>

`Key`  <a name="cfn-cloudfront-vpcorigin-tag-key"></a>
A string that contains `Tag` key.  
The string length should be between 1 and 128 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cloudfront-vpcorigin-tag-value"></a>
A string that contains an optional `Tag` value.  
The string length should be between 0 and 256 characters. Valid characters include `a-z`, `A-Z`, `0-9`, space, and the special characters `_ - . : / = + @`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CloudFront::VpcOrigin VpcOriginEndpointConfig
<a name="aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig"></a>

An Amazon CloudFront VPC origin endpoint configuration.

## Syntax
<a name="aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig-syntax.json"></a>

```
{
  "[Arn](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-arn)" : String,
  "[HTTPPort](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpport)" : Integer,
  "[HTTPSPort](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpsport)" : Integer,
  "[Name](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-name)" : String,
  "[OriginProtocolPolicy](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originprotocolpolicy)" : String,
  "[OriginSSLProtocols](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originsslprotocols)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig-syntax.yaml"></a>

```
  [Arn](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-arn): String
  [HTTPPort](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpport): Integer
  [HTTPSPort](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpsport): Integer
  [Name](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-name): String
  [OriginProtocolPolicy](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originprotocolpolicy): String
  [OriginSSLProtocols](#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originsslprotocols): 
    - String
```

## Properties
<a name="aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig-properties"></a>

`Arn`  <a name="cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-arn"></a>
The ARN of the CloudFront VPC origin endpoint configuration.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HTTPPort`  <a name="cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpport"></a>
The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is `80`.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HTTPSPort`  <a name="cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpsport"></a>
The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is `443`.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-name"></a>
The name of the CloudFront VPC origin endpoint configuration.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginProtocolPolicy`  <a name="cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originprotocolpolicy"></a>
The origin protocol policy for the CloudFront VPC origin endpoint configuration.  
*Required*: No  
*Type*: String  
*Allowed values*: `http-only | match-viewer | https-only`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OriginSSLProtocols`  <a name="cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originsslprotocols"></a>
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include `SSLv3`, `TLSv1`, `TLSv1.1`, and `TLSv1.2`.  
For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)