azure-native.awsconnector.CloudFrontDistribution
Explore with Pulumi AI
A Microsoft.AwsConnector resource Azure REST API version: 2024-12-01.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:awsconnector:CloudFrontDistribution lnrbtgon /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudFrontDistributions/{name}
Create CloudFrontDistribution Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CloudFrontDistribution(name: string, args: CloudFrontDistributionArgs, opts?: CustomResourceOptions);
@overload
def CloudFrontDistribution(resource_name: str,
args: CloudFrontDistributionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CloudFrontDistribution(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
properties: Optional[CloudFrontDistributionPropertiesArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewCloudFrontDistribution(ctx *Context, name string, args CloudFrontDistributionArgs, opts ...ResourceOption) (*CloudFrontDistribution, error)
public CloudFrontDistribution(string name, CloudFrontDistributionArgs args, CustomResourceOptions? opts = null)
public CloudFrontDistribution(String name, CloudFrontDistributionArgs args)
public CloudFrontDistribution(String name, CloudFrontDistributionArgs args, CustomResourceOptions options)
type: azure-native:awsconnector:CloudFrontDistribution
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CloudFrontDistributionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CloudFrontDistributionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CloudFrontDistributionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CloudFrontDistributionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CloudFrontDistributionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var cloudFrontDistributionResource = new AzureNative.AwsConnector.CloudFrontDistribution("cloudFrontDistributionResource", new()
{
ResourceGroupName = "string",
Location = "string",
Name = "string",
Properties = new AzureNative.AwsConnector.Inputs.CloudFrontDistributionPropertiesArgs
{
Arn = "string",
AwsAccountId = "string",
AwsProperties = new AzureNative.AwsConnector.Inputs.AwsCloudFrontDistributionPropertiesArgs
{
DistributionConfig = new AzureNative.AwsConnector.Inputs.DistributionConfigArgs
{
Aliases = new[]
{
"string",
},
CacheBehaviors = new[]
{
new AzureNative.AwsConnector.Inputs.CacheBehaviorArgs
{
AllowedMethods = new[]
{
"string",
},
CachePolicyId = "string",
CachedMethods = new[]
{
"string",
},
Compress = false,
DefaultTTL = 0,
FieldLevelEncryptionId = "string",
ForwardedValues = new AzureNative.AwsConnector.Inputs.ForwardedValuesArgs
{
Cookies = new AzureNative.AwsConnector.Inputs.CookiesArgs
{
Forward = "string",
WhitelistedNames = new[]
{
"string",
},
},
Headers = new[]
{
"string",
},
QueryString = false,
QueryStringCacheKeys = new[]
{
"string",
},
},
FunctionAssociations = new[]
{
new AzureNative.AwsConnector.Inputs.FunctionAssociationArgs
{
EventType = "string",
FunctionARN = "string",
},
},
LambdaFunctionAssociations = new[]
{
new AzureNative.AwsConnector.Inputs.LambdaFunctionAssociationArgs
{
EventType = "string",
IncludeBody = false,
LambdaFunctionARN = "string",
},
},
MaxTTL = 0,
MinTTL = 0,
OriginRequestPolicyId = "string",
PathPattern = "string",
RealtimeLogConfigArn = "string",
ResponseHeadersPolicyId = "string",
SmoothStreaming = false,
TargetOriginId = "string",
TrustedKeyGroups = new[]
{
"string",
},
TrustedSigners = new[]
{
"string",
},
ViewerProtocolPolicy = "string",
},
},
CnamEs = new[]
{
"string",
},
Comment = "string",
ContinuousDeploymentPolicyId = "string",
CustomErrorResponses = new[]
{
new AzureNative.AwsConnector.Inputs.CustomErrorResponseArgs
{
ErrorCachingMinTTL = 0,
ErrorCode = 0,
ResponseCode = 0,
ResponsePagePath = "string",
},
},
CustomOrigin = new AzureNative.AwsConnector.Inputs.LegacyCustomOriginArgs
{
DnsName = "string",
HttpPort = 0,
HttpsPort = 0,
OriginProtocolPolicy = "string",
OriginSSLProtocols = new[]
{
"string",
},
},
DefaultCacheBehavior = new AzureNative.AwsConnector.Inputs.DefaultCacheBehaviorArgs
{
AllowedMethods = new[]
{
"string",
},
CachePolicyId = "string",
CachedMethods = new[]
{
"string",
},
Compress = false,
DefaultTTL = 0,
FieldLevelEncryptionId = "string",
ForwardedValues = new AzureNative.AwsConnector.Inputs.ForwardedValuesArgs
{
Cookies = new AzureNative.AwsConnector.Inputs.CookiesArgs
{
Forward = "string",
WhitelistedNames = new[]
{
"string",
},
},
Headers = new[]
{
"string",
},
QueryString = false,
QueryStringCacheKeys = new[]
{
"string",
},
},
FunctionAssociations = new[]
{
new AzureNative.AwsConnector.Inputs.FunctionAssociationArgs
{
EventType = "string",
FunctionARN = "string",
},
},
LambdaFunctionAssociations = new[]
{
new AzureNative.AwsConnector.Inputs.LambdaFunctionAssociationArgs
{
EventType = "string",
IncludeBody = false,
LambdaFunctionARN = "string",
},
},
MaxTTL = 0,
MinTTL = 0,
OriginRequestPolicyId = "string",
RealtimeLogConfigArn = "string",
ResponseHeadersPolicyId = "string",
SmoothStreaming = false,
TargetOriginId = "string",
TrustedKeyGroups = new[]
{
"string",
},
TrustedSigners = new[]
{
"string",
},
ViewerProtocolPolicy = "string",
},
DefaultRootObject = "string",
Enabled = false,
HttpVersion = "string",
IpV6Enabled = false,
Logging = new AzureNative.AwsConnector.Inputs.LoggingArgs
{
Bucket = "string",
ClusterLogging = new[]
{
new AzureNative.AwsConnector.Inputs.LogSetupArgs
{
Enabled = false,
Types = new[]
{
"string",
},
},
},
IncludeCookies = false,
Prefix = "string",
},
OriginGroups = new AzureNative.AwsConnector.Inputs.OriginGroupsArgs
{
Items = new[]
{
new AzureNative.AwsConnector.Inputs.OriginGroupArgs
{
FailoverCriteria = new AzureNative.AwsConnector.Inputs.OriginGroupFailoverCriteriaArgs
{
StatusCodes = new AzureNative.AwsConnector.Inputs.StatusCodesArgs
{
Items = new[]
{
0,
},
Quantity = 0,
},
},
Id = "string",
Members = new AzureNative.AwsConnector.Inputs.OriginGroupMembersArgs
{
Items = new[]
{
new AzureNative.AwsConnector.Inputs.OriginGroupMemberArgs
{
OriginId = "string",
},
},
Quantity = 0,
},
},
},
Quantity = 0,
},
Origins = new[]
{
AzureNative.AwsConnector.Origin.AWS_KMS,
},
PriceClass = "string",
Restrictions = new AzureNative.AwsConnector.Inputs.RestrictionsArgs
{
GeoRestriction = new AzureNative.AwsConnector.Inputs.GeoRestrictionArgs
{
Locations = new[]
{
"string",
},
RestrictionType = "string",
},
},
S3Origin = new AzureNative.AwsConnector.Inputs.LegacyS3OriginArgs
{
DnsName = "string",
OriginAccessIdentity = "string",
},
Staging = false,
ViewerCertificate = new AzureNative.AwsConnector.Inputs.ViewerCertificateArgs
{
AcmCertificateArn = "string",
CloudFrontDefaultCertificate = false,
IamCertificateId = "string",
MinimumProtocolVersion = "string",
SslSupportMethod = "string",
},
WebACLId = "string",
},
DomainName = "string",
Id = "string",
Tags = new[]
{
new AzureNative.AwsConnector.Inputs.TagArgs
{
Key = "string",
Value = "string",
},
},
},
AwsRegion = "string",
AwsSourceSchema = "string",
AwsTags =
{
{ "string", "string" },
},
PublicCloudConnectorsResourceId = "string",
PublicCloudResourceName = "string",
},
Tags =
{
{ "string", "string" },
},
});
example, err := awsconnector.NewCloudFrontDistribution(ctx, "cloudFrontDistributionResource", &awsconnector.CloudFrontDistributionArgs{
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Properties: &awsconnector.CloudFrontDistributionPropertiesArgs{
Arn: pulumi.String("string"),
AwsAccountId: pulumi.String("string"),
AwsProperties: &awsconnector.AwsCloudFrontDistributionPropertiesArgs{
DistributionConfig: &awsconnector.DistributionConfigArgs{
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
CacheBehaviors: awsconnector.CacheBehaviorArray{
&awsconnector.CacheBehaviorArgs{
AllowedMethods: pulumi.StringArray{
pulumi.String("string"),
},
CachePolicyId: pulumi.String("string"),
CachedMethods: pulumi.StringArray{
pulumi.String("string"),
},
Compress: pulumi.Bool(false),
DefaultTTL: pulumi.Int(0),
FieldLevelEncryptionId: pulumi.String("string"),
ForwardedValues: &awsconnector.ForwardedValuesArgs{
Cookies: &awsconnector.CookiesArgs{
Forward: pulumi.String("string"),
WhitelistedNames: pulumi.StringArray{
pulumi.String("string"),
},
},
Headers: pulumi.StringArray{
pulumi.String("string"),
},
QueryString: pulumi.Bool(false),
QueryStringCacheKeys: pulumi.StringArray{
pulumi.String("string"),
},
},
FunctionAssociations: awsconnector.FunctionAssociationArray{
&awsconnector.FunctionAssociationArgs{
EventType: pulumi.String("string"),
FunctionARN: pulumi.String("string"),
},
},
LambdaFunctionAssociations: awsconnector.LambdaFunctionAssociationArray{
&awsconnector.LambdaFunctionAssociationArgs{
EventType: pulumi.String("string"),
IncludeBody: pulumi.Bool(false),
LambdaFunctionARN: pulumi.String("string"),
},
},
MaxTTL: pulumi.Int(0),
MinTTL: pulumi.Int(0),
OriginRequestPolicyId: pulumi.String("string"),
PathPattern: pulumi.String("string"),
RealtimeLogConfigArn: pulumi.String("string"),
ResponseHeadersPolicyId: pulumi.String("string"),
SmoothStreaming: pulumi.Bool(false),
TargetOriginId: pulumi.String("string"),
TrustedKeyGroups: pulumi.StringArray{
pulumi.String("string"),
},
TrustedSigners: pulumi.StringArray{
pulumi.String("string"),
},
ViewerProtocolPolicy: pulumi.String("string"),
},
},
CnamEs: pulumi.StringArray{
pulumi.String("string"),
},
Comment: pulumi.String("string"),
ContinuousDeploymentPolicyId: pulumi.String("string"),
CustomErrorResponses: awsconnector.CustomErrorResponseArray{
&awsconnector.CustomErrorResponseArgs{
ErrorCachingMinTTL: pulumi.Int(0),
ErrorCode: pulumi.Int(0),
ResponseCode: pulumi.Int(0),
ResponsePagePath: pulumi.String("string"),
},
},
CustomOrigin: &awsconnector.LegacyCustomOriginArgs{
DnsName: pulumi.String("string"),
HttpPort: pulumi.Int(0),
HttpsPort: pulumi.Int(0),
OriginProtocolPolicy: pulumi.String("string"),
OriginSSLProtocols: pulumi.StringArray{
pulumi.String("string"),
},
},
DefaultCacheBehavior: &awsconnector.DefaultCacheBehaviorArgs{
AllowedMethods: pulumi.StringArray{
pulumi.String("string"),
},
CachePolicyId: pulumi.String("string"),
CachedMethods: pulumi.StringArray{
pulumi.String("string"),
},
Compress: pulumi.Bool(false),
DefaultTTL: pulumi.Int(0),
FieldLevelEncryptionId: pulumi.String("string"),
ForwardedValues: &awsconnector.ForwardedValuesArgs{
Cookies: &awsconnector.CookiesArgs{
Forward: pulumi.String("string"),
WhitelistedNames: pulumi.StringArray{
pulumi.String("string"),
},
},
Headers: pulumi.StringArray{
pulumi.String("string"),
},
QueryString: pulumi.Bool(false),
QueryStringCacheKeys: pulumi.StringArray{
pulumi.String("string"),
},
},
FunctionAssociations: awsconnector.FunctionAssociationArray{
&awsconnector.FunctionAssociationArgs{
EventType: pulumi.String("string"),
FunctionARN: pulumi.String("string"),
},
},
LambdaFunctionAssociations: awsconnector.LambdaFunctionAssociationArray{
&awsconnector.LambdaFunctionAssociationArgs{
EventType: pulumi.String("string"),
IncludeBody: pulumi.Bool(false),
LambdaFunctionARN: pulumi.String("string"),
},
},
MaxTTL: pulumi.Int(0),
MinTTL: pulumi.Int(0),
OriginRequestPolicyId: pulumi.String("string"),
RealtimeLogConfigArn: pulumi.String("string"),
ResponseHeadersPolicyId: pulumi.String("string"),
SmoothStreaming: pulumi.Bool(false),
TargetOriginId: pulumi.String("string"),
TrustedKeyGroups: pulumi.StringArray{
pulumi.String("string"),
},
TrustedSigners: pulumi.StringArray{
pulumi.String("string"),
},
ViewerProtocolPolicy: pulumi.String("string"),
},
DefaultRootObject: pulumi.String("string"),
Enabled: pulumi.Bool(false),
HttpVersion: pulumi.String("string"),
IpV6Enabled: pulumi.Bool(false),
Logging: &awsconnector.LoggingArgs{
Bucket: pulumi.String("string"),
ClusterLogging: awsconnector.LogSetupArray{
&awsconnector.LogSetupArgs{
Enabled: pulumi.Bool(false),
Types: pulumi.StringArray{
pulumi.String("string"),
},
},
},
IncludeCookies: pulumi.Bool(false),
Prefix: pulumi.String("string"),
},
OriginGroups: &awsconnector.OriginGroupsArgs{
Items: awsconnector.OriginGroupArray{
&awsconnector.OriginGroupArgs{
FailoverCriteria: &awsconnector.OriginGroupFailoverCriteriaArgs{
StatusCodes: &awsconnector.StatusCodesArgs{
Items: pulumi.IntArray{
pulumi.Int(0),
},
Quantity: pulumi.Int(0),
},
},
Id: pulumi.String("string"),
Members: &awsconnector.OriginGroupMembersArgs{
Items: awsconnector.OriginGroupMemberArray{
&awsconnector.OriginGroupMemberArgs{
OriginId: pulumi.String("string"),
},
},
Quantity: pulumi.Int(0),
},
},
},
Quantity: pulumi.Int(0),
},
Origins: awsconnector.OriginArray{
awsconnector.Origin_AWS_KMS,
},
PriceClass: pulumi.String("string"),
Restrictions: &awsconnector.RestrictionsArgs{
GeoRestriction: &awsconnector.GeoRestrictionArgs{
Locations: pulumi.StringArray{
pulumi.String("string"),
},
RestrictionType: pulumi.String("string"),
},
},
S3Origin: &awsconnector.LegacyS3OriginArgs{
DnsName: pulumi.String("string"),
OriginAccessIdentity: pulumi.String("string"),
},
Staging: pulumi.Bool(false),
ViewerCertificate: &awsconnector.ViewerCertificateArgs{
AcmCertificateArn: pulumi.String("string"),
CloudFrontDefaultCertificate: pulumi.Bool(false),
IamCertificateId: pulumi.String("string"),
MinimumProtocolVersion: pulumi.String("string"),
SslSupportMethod: pulumi.String("string"),
},
WebACLId: pulumi.String("string"),
},
DomainName: pulumi.String("string"),
Id: pulumi.String("string"),
Tags: awsconnector.TagArray{
&awsconnector.TagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
AwsRegion: pulumi.String("string"),
AwsSourceSchema: pulumi.String("string"),
AwsTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
PublicCloudConnectorsResourceId: pulumi.String("string"),
PublicCloudResourceName: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var cloudFrontDistributionResource = new CloudFrontDistribution("cloudFrontDistributionResource", CloudFrontDistributionArgs.builder()
.resourceGroupName("string")
.location("string")
.name("string")
.properties(CloudFrontDistributionPropertiesArgs.builder()
.arn("string")
.awsAccountId("string")
.awsProperties(AwsCloudFrontDistributionPropertiesArgs.builder()
.distributionConfig(DistributionConfigArgs.builder()
.aliases("string")
.cacheBehaviors(CacheBehaviorArgs.builder()
.allowedMethods("string")
.cachePolicyId("string")
.cachedMethods("string")
.compress(false)
.defaultTTL(0)
.fieldLevelEncryptionId("string")
.forwardedValues(ForwardedValuesArgs.builder()
.cookies(CookiesArgs.builder()
.forward("string")
.whitelistedNames("string")
.build())
.headers("string")
.queryString(false)
.queryStringCacheKeys("string")
.build())
.functionAssociations(FunctionAssociationArgs.builder()
.eventType("string")
.functionARN("string")
.build())
.lambdaFunctionAssociations(LambdaFunctionAssociationArgs.builder()
.eventType("string")
.includeBody(false)
.lambdaFunctionARN("string")
.build())
.maxTTL(0)
.minTTL(0)
.originRequestPolicyId("string")
.pathPattern("string")
.realtimeLogConfigArn("string")
.responseHeadersPolicyId("string")
.smoothStreaming(false)
.targetOriginId("string")
.trustedKeyGroups("string")
.trustedSigners("string")
.viewerProtocolPolicy("string")
.build())
.cnamEs("string")
.comment("string")
.continuousDeploymentPolicyId("string")
.customErrorResponses(CustomErrorResponseArgs.builder()
.errorCachingMinTTL(0)
.errorCode(0)
.responseCode(0)
.responsePagePath("string")
.build())
.customOrigin(LegacyCustomOriginArgs.builder()
.dnsName("string")
.httpPort(0)
.httpsPort(0)
.originProtocolPolicy("string")
.originSSLProtocols("string")
.build())
.defaultCacheBehavior(DefaultCacheBehaviorArgs.builder()
.allowedMethods("string")
.cachePolicyId("string")
.cachedMethods("string")
.compress(false)
.defaultTTL(0)
.fieldLevelEncryptionId("string")
.forwardedValues(ForwardedValuesArgs.builder()
.cookies(CookiesArgs.builder()
.forward("string")
.whitelistedNames("string")
.build())
.headers("string")
.queryString(false)
.queryStringCacheKeys("string")
.build())
.functionAssociations(FunctionAssociationArgs.builder()
.eventType("string")
.functionARN("string")
.build())
.lambdaFunctionAssociations(LambdaFunctionAssociationArgs.builder()
.eventType("string")
.includeBody(false)
.lambdaFunctionARN("string")
.build())
.maxTTL(0)
.minTTL(0)
.originRequestPolicyId("string")
.realtimeLogConfigArn("string")
.responseHeadersPolicyId("string")
.smoothStreaming(false)
.targetOriginId("string")
.trustedKeyGroups("string")
.trustedSigners("string")
.viewerProtocolPolicy("string")
.build())
.defaultRootObject("string")
.enabled(false)
.httpVersion("string")
.ipV6Enabled(false)
.logging(LoggingArgs.builder()
.bucket("string")
.clusterLogging(LogSetupArgs.builder()
.enabled(false)
.types("string")
.build())
.includeCookies(false)
.prefix("string")
.build())
.originGroups(OriginGroupsArgs.builder()
.items(OriginGroupArgs.builder()
.failoverCriteria(OriginGroupFailoverCriteriaArgs.builder()
.statusCodes(StatusCodesArgs.builder()
.items(0)
.quantity(0)
.build())
.build())
.id("string")
.members(OriginGroupMembersArgs.builder()
.items(OriginGroupMemberArgs.builder()
.originId("string")
.build())
.quantity(0)
.build())
.build())
.quantity(0)
.build())
.origins("AWS_KMS")
.priceClass("string")
.restrictions(RestrictionsArgs.builder()
.geoRestriction(GeoRestrictionArgs.builder()
.locations("string")
.restrictionType("string")
.build())
.build())
.s3Origin(LegacyS3OriginArgs.builder()
.dnsName("string")
.originAccessIdentity("string")
.build())
.staging(false)
.viewerCertificate(ViewerCertificateArgs.builder()
.acmCertificateArn("string")
.cloudFrontDefaultCertificate(false)
.iamCertificateId("string")
.minimumProtocolVersion("string")
.sslSupportMethod("string")
.build())
.webACLId("string")
.build())
.domainName("string")
.id("string")
.tags(TagArgs.builder()
.key("string")
.value("string")
.build())
.build())
.awsRegion("string")
.awsSourceSchema("string")
.awsTags(Map.of("string", "string"))
.publicCloudConnectorsResourceId("string")
.publicCloudResourceName("string")
.build())
.tags(Map.of("string", "string"))
.build());
cloud_front_distribution_resource = azure_native.awsconnector.CloudFrontDistribution("cloudFrontDistributionResource",
resource_group_name="string",
location="string",
name="string",
properties={
"arn": "string",
"aws_account_id": "string",
"aws_properties": {
"distribution_config": {
"aliases": ["string"],
"cache_behaviors": [{
"allowed_methods": ["string"],
"cache_policy_id": "string",
"cached_methods": ["string"],
"compress": False,
"default_ttl": 0,
"field_level_encryption_id": "string",
"forwarded_values": {
"cookies": {
"forward": "string",
"whitelisted_names": ["string"],
},
"headers": ["string"],
"query_string": False,
"query_string_cache_keys": ["string"],
},
"function_associations": [{
"event_type": "string",
"function_arn": "string",
}],
"lambda_function_associations": [{
"event_type": "string",
"include_body": False,
"lambda_function_arn": "string",
}],
"max_ttl": 0,
"min_ttl": 0,
"origin_request_policy_id": "string",
"path_pattern": "string",
"realtime_log_config_arn": "string",
"response_headers_policy_id": "string",
"smooth_streaming": False,
"target_origin_id": "string",
"trusted_key_groups": ["string"],
"trusted_signers": ["string"],
"viewer_protocol_policy": "string",
}],
"cnam_es": ["string"],
"comment": "string",
"continuous_deployment_policy_id": "string",
"custom_error_responses": [{
"error_caching_min_ttl": 0,
"error_code": 0,
"response_code": 0,
"response_page_path": "string",
}],
"custom_origin": {
"dns_name": "string",
"http_port": 0,
"https_port": 0,
"origin_protocol_policy": "string",
"origin_ssl_protocols": ["string"],
},
"default_cache_behavior": {
"allowed_methods": ["string"],
"cache_policy_id": "string",
"cached_methods": ["string"],
"compress": False,
"default_ttl": 0,
"field_level_encryption_id": "string",
"forwarded_values": {
"cookies": {
"forward": "string",
"whitelisted_names": ["string"],
},
"headers": ["string"],
"query_string": False,
"query_string_cache_keys": ["string"],
},
"function_associations": [{
"event_type": "string",
"function_arn": "string",
}],
"lambda_function_associations": [{
"event_type": "string",
"include_body": False,
"lambda_function_arn": "string",
}],
"max_ttl": 0,
"min_ttl": 0,
"origin_request_policy_id": "string",
"realtime_log_config_arn": "string",
"response_headers_policy_id": "string",
"smooth_streaming": False,
"target_origin_id": "string",
"trusted_key_groups": ["string"],
"trusted_signers": ["string"],
"viewer_protocol_policy": "string",
},
"default_root_object": "string",
"enabled": False,
"http_version": "string",
"ip_v6_enabled": False,
"logging": {
"bucket": "string",
"cluster_logging": [{
"enabled": False,
"types": ["string"],
}],
"include_cookies": False,
"prefix": "string",
},
"origin_groups": {
"items": [{
"failover_criteria": {
"status_codes": {
"items": [0],
"quantity": 0,
},
},
"id": "string",
"members": {
"items": [{
"origin_id": "string",
}],
"quantity": 0,
},
}],
"quantity": 0,
},
"origins": [azure_native.awsconnector.Origin.AW_S_KMS],
"price_class": "string",
"restrictions": {
"geo_restriction": {
"locations": ["string"],
"restriction_type": "string",
},
},
"s3_origin": {
"dns_name": "string",
"origin_access_identity": "string",
},
"staging": False,
"viewer_certificate": {
"acm_certificate_arn": "string",
"cloud_front_default_certificate": False,
"iam_certificate_id": "string",
"minimum_protocol_version": "string",
"ssl_support_method": "string",
},
"web_acl_id": "string",
},
"domain_name": "string",
"id": "string",
"tags": [{
"key": "string",
"value": "string",
}],
},
"aws_region": "string",
"aws_source_schema": "string",
"aws_tags": {
"string": "string",
},
"public_cloud_connectors_resource_id": "string",
"public_cloud_resource_name": "string",
},
tags={
"string": "string",
})
const cloudFrontDistributionResource = new azure_native.awsconnector.CloudFrontDistribution("cloudFrontDistributionResource", {
resourceGroupName: "string",
location: "string",
name: "string",
properties: {
arn: "string",
awsAccountId: "string",
awsProperties: {
distributionConfig: {
aliases: ["string"],
cacheBehaviors: [{
allowedMethods: ["string"],
cachePolicyId: "string",
cachedMethods: ["string"],
compress: false,
defaultTTL: 0,
fieldLevelEncryptionId: "string",
forwardedValues: {
cookies: {
forward: "string",
whitelistedNames: ["string"],
},
headers: ["string"],
queryString: false,
queryStringCacheKeys: ["string"],
},
functionAssociations: [{
eventType: "string",
functionARN: "string",
}],
lambdaFunctionAssociations: [{
eventType: "string",
includeBody: false,
lambdaFunctionARN: "string",
}],
maxTTL: 0,
minTTL: 0,
originRequestPolicyId: "string",
pathPattern: "string",
realtimeLogConfigArn: "string",
responseHeadersPolicyId: "string",
smoothStreaming: false,
targetOriginId: "string",
trustedKeyGroups: ["string"],
trustedSigners: ["string"],
viewerProtocolPolicy: "string",
}],
cnamEs: ["string"],
comment: "string",
continuousDeploymentPolicyId: "string",
customErrorResponses: [{
errorCachingMinTTL: 0,
errorCode: 0,
responseCode: 0,
responsePagePath: "string",
}],
customOrigin: {
dnsName: "string",
httpPort: 0,
httpsPort: 0,
originProtocolPolicy: "string",
originSSLProtocols: ["string"],
},
defaultCacheBehavior: {
allowedMethods: ["string"],
cachePolicyId: "string",
cachedMethods: ["string"],
compress: false,
defaultTTL: 0,
fieldLevelEncryptionId: "string",
forwardedValues: {
cookies: {
forward: "string",
whitelistedNames: ["string"],
},
headers: ["string"],
queryString: false,
queryStringCacheKeys: ["string"],
},
functionAssociations: [{
eventType: "string",
functionARN: "string",
}],
lambdaFunctionAssociations: [{
eventType: "string",
includeBody: false,
lambdaFunctionARN: "string",
}],
maxTTL: 0,
minTTL: 0,
originRequestPolicyId: "string",
realtimeLogConfigArn: "string",
responseHeadersPolicyId: "string",
smoothStreaming: false,
targetOriginId: "string",
trustedKeyGroups: ["string"],
trustedSigners: ["string"],
viewerProtocolPolicy: "string",
},
defaultRootObject: "string",
enabled: false,
httpVersion: "string",
ipV6Enabled: false,
logging: {
bucket: "string",
clusterLogging: [{
enabled: false,
types: ["string"],
}],
includeCookies: false,
prefix: "string",
},
originGroups: {
items: [{
failoverCriteria: {
statusCodes: {
items: [0],
quantity: 0,
},
},
id: "string",
members: {
items: [{
originId: "string",
}],
quantity: 0,
},
}],
quantity: 0,
},
origins: [azure_native.awsconnector.Origin.AWS_KMS],
priceClass: "string",
restrictions: {
geoRestriction: {
locations: ["string"],
restrictionType: "string",
},
},
s3Origin: {
dnsName: "string",
originAccessIdentity: "string",
},
staging: false,
viewerCertificate: {
acmCertificateArn: "string",
cloudFrontDefaultCertificate: false,
iamCertificateId: "string",
minimumProtocolVersion: "string",
sslSupportMethod: "string",
},
webACLId: "string",
},
domainName: "string",
id: "string",
tags: [{
key: "string",
value: "string",
}],
},
awsRegion: "string",
awsSourceSchema: "string",
awsTags: {
string: "string",
},
publicCloudConnectorsResourceId: "string",
publicCloudResourceName: "string",
},
tags: {
string: "string",
},
});
type: azure-native:awsconnector:CloudFrontDistribution
properties:
location: string
name: string
properties:
arn: string
awsAccountId: string
awsProperties:
distributionConfig:
aliases:
- string
cacheBehaviors:
- allowedMethods:
- string
cachePolicyId: string
cachedMethods:
- string
compress: false
defaultTTL: 0
fieldLevelEncryptionId: string
forwardedValues:
cookies:
forward: string
whitelistedNames:
- string
headers:
- string
queryString: false
queryStringCacheKeys:
- string
functionAssociations:
- eventType: string
functionARN: string
lambdaFunctionAssociations:
- eventType: string
includeBody: false
lambdaFunctionARN: string
maxTTL: 0
minTTL: 0
originRequestPolicyId: string
pathPattern: string
realtimeLogConfigArn: string
responseHeadersPolicyId: string
smoothStreaming: false
targetOriginId: string
trustedKeyGroups:
- string
trustedSigners:
- string
viewerProtocolPolicy: string
cnamEs:
- string
comment: string
continuousDeploymentPolicyId: string
customErrorResponses:
- errorCachingMinTTL: 0
errorCode: 0
responseCode: 0
responsePagePath: string
customOrigin:
dnsName: string
httpPort: 0
httpsPort: 0
originProtocolPolicy: string
originSSLProtocols:
- string
defaultCacheBehavior:
allowedMethods:
- string
cachePolicyId: string
cachedMethods:
- string
compress: false
defaultTTL: 0
fieldLevelEncryptionId: string
forwardedValues:
cookies:
forward: string
whitelistedNames:
- string
headers:
- string
queryString: false
queryStringCacheKeys:
- string
functionAssociations:
- eventType: string
functionARN: string
lambdaFunctionAssociations:
- eventType: string
includeBody: false
lambdaFunctionARN: string
maxTTL: 0
minTTL: 0
originRequestPolicyId: string
realtimeLogConfigArn: string
responseHeadersPolicyId: string
smoothStreaming: false
targetOriginId: string
trustedKeyGroups:
- string
trustedSigners:
- string
viewerProtocolPolicy: string
defaultRootObject: string
enabled: false
httpVersion: string
ipV6Enabled: false
logging:
bucket: string
clusterLogging:
- enabled: false
types:
- string
includeCookies: false
prefix: string
originGroups:
items:
- failoverCriteria:
statusCodes:
items:
- 0
quantity: 0
id: string
members:
items:
- originId: string
quantity: 0
quantity: 0
origins:
- AWS_KMS
priceClass: string
restrictions:
geoRestriction:
locations:
- string
restrictionType: string
s3Origin:
dnsName: string
originAccessIdentity: string
staging: false
viewerCertificate:
acmCertificateArn: string
cloudFrontDefaultCertificate: false
iamCertificateId: string
minimumProtocolVersion: string
sslSupportMethod: string
webACLId: string
domainName: string
id: string
tags:
- key: string
value: string
awsRegion: string
awsSourceSchema: string
awsTags:
string: string
publicCloudConnectorsResourceId: string
publicCloudResourceName: string
resourceGroupName: string
tags:
string: string
CloudFrontDistribution Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CloudFrontDistribution resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Location string
- The geo-location where the resource lives
- Name string
- Name of CloudFrontDistribution
- Properties
Pulumi.
Azure Native. Aws Connector. Inputs. Cloud Front Distribution Properties - The resource-specific properties for this resource.
- Dictionary<string, string>
- Resource tags.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Location string
- The geo-location where the resource lives
- Name string
- Name of CloudFrontDistribution
- Properties
Cloud
Front Distribution Properties Args - The resource-specific properties for this resource.
- map[string]string
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- location String
- The geo-location where the resource lives
- name String
- Name of CloudFrontDistribution
- properties
Cloud
Front Distribution Properties - The resource-specific properties for this resource.
- Map<String,String>
- Resource tags.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- location string
- The geo-location where the resource lives
- name string
- Name of CloudFrontDistribution
- properties
Cloud
Front Distribution Properties - The resource-specific properties for this resource.
- {[key: string]: string}
- Resource tags.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- location str
- The geo-location where the resource lives
- name str
- Name of CloudFrontDistribution
- properties
Cloud
Front Distribution Properties Args - The resource-specific properties for this resource.
- Mapping[str, str]
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- location String
- The geo-location where the resource lives
- name String
- Name of CloudFrontDistribution
- properties Property Map
- The resource-specific properties for this resource.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the CloudFrontDistribution resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- System
Data Pulumi.Azure Native. Aws Connector. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Id string
- The provider-assigned unique ID for this managed resource.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id string
- The provider-assigned unique ID for this managed resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id str
- The provider-assigned unique ID for this managed resource.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
AwsCloudFrontDistributionProperties, AwsCloudFrontDistributionPropertiesArgs
- Distribution
Config Pulumi.Azure Native. Aws Connector. Inputs. Distribution Config - The distribution's configuration. A distribution configuration.
- Domain
Name string - Property domainName
- Id string
- Property id
- List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag> - A complex type that contains zero or more
Tag
elements.
- Distribution
Config DistributionConfig - The distribution's configuration. A distribution configuration.
- Domain
Name string - Property domainName
- Id string
- Property id
- []Tag
- A complex type that contains zero or more
Tag
elements.
- distribution
Config DistributionConfig - The distribution's configuration. A distribution configuration.
- domain
Name String - Property domainName
- id String
- Property id
- List<Tag>
- A complex type that contains zero or more
Tag
elements.
- distribution
Config DistributionConfig - The distribution's configuration. A distribution configuration.
- domain
Name string - Property domainName
- id string
- Property id
- Tag[]
- A complex type that contains zero or more
Tag
elements.
- distribution_
config DistributionConfig - The distribution's configuration. A distribution configuration.
- domain_
name str - Property domainName
- id str
- Property id
- Sequence[Tag]
- A complex type that contains zero or more
Tag
elements.
- distribution
Config Property Map - The distribution's configuration. A distribution configuration.
- domain
Name String - Property domainName
- id String
- Property id
- List<Property Map>
- A complex type that contains zero or more
Tag
elements.
AwsCloudFrontDistributionPropertiesResponse, AwsCloudFrontDistributionPropertiesResponseArgs
- Distribution
Config Pulumi.Azure Native. Aws Connector. Inputs. Distribution Config Response - The distribution's configuration. A distribution configuration.
- Domain
Name string - Property domainName
- Id string
- Property id
- List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag Response> - A complex type that contains zero or more
Tag
elements.
- Distribution
Config DistributionConfig Response - The distribution's configuration. A distribution configuration.
- Domain
Name string - Property domainName
- Id string
- Property id
- []Tag
Response - A complex type that contains zero or more
Tag
elements.
- distribution
Config DistributionConfig Response - The distribution's configuration. A distribution configuration.
- domain
Name String - Property domainName
- id String
- Property id
- List<Tag
Response> - A complex type that contains zero or more
Tag
elements.
- distribution
Config DistributionConfig Response - The distribution's configuration. A distribution configuration.
- domain
Name string - Property domainName
- id string
- Property id
- Tag
Response[] - A complex type that contains zero or more
Tag
elements.
- distribution_
config DistributionConfig Response - The distribution's configuration. A distribution configuration.
- domain_
name str - Property domainName
- id str
- Property id
- Sequence[Tag
Response] - A complex type that contains zero or more
Tag
elements.
- distribution
Config Property Map - The distribution's configuration. A distribution configuration.
- domain
Name String - Property domainName
- id String
- Property id
- List<Property Map>
- A complex type that contains zero or more
Tag
elements.
CacheBehavior, CacheBehaviorArgs
- Allowed
Methods List<string> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - Cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods List<string> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- Default
TTL int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - Forwarded
Values Pulumi.Azure Native. Aws Connector. Inputs. Forwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations List<Pulumi.Azure Native. Aws Connector. Inputs. Function Association> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function List<Pulumi.Associations Azure Native. Aws Connector. Inputs. Lambda Function Association> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
TTL int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
TTL int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - Trusted
Key List<string>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers List<string> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - Viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- Allowed
Methods []string - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - Cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods []string - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- Default
TTL int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - Forwarded
Values ForwardedValues - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations []FunctionAssociation - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function []LambdaAssociations Function Association - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
TTL int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
TTL int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - Trusted
Key []stringGroups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers []string - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - Viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy StringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
TTL Integer - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values ForwardedValues - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<FunctionAssociation> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<LambdaAssociations Function Association> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL Integer - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL Integer - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- path
Pattern String - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol StringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods string[] - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods string[] - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
TTL number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values ForwardedValues - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations FunctionAssociation[] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function LambdaAssociations Function Association[] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers stringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - trusted
Key string[]Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers string[] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed_
methods Sequence[str] - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache_
policy_ strid - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached_
methods Sequence[str] - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default_
ttl int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field_
level_ strencryption_ id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded_
values ForwardedValues - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function_
associations Sequence[FunctionAssociation] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda_
function_ Sequence[Lambdaassociations Function Association] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max_
ttl int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min_
ttl int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin_
request_ strpolicy_ id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- path_
pattern str - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - realtime_
log_ strconfig_ arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response_
headers_ strpolicy_ id - The identifier for a response headers policy.
- smooth_
streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target_
origin_ strid - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - trusted_
key_ Sequence[str]groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted_
signers Sequence[str] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer_
protocol_ strpolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy StringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
TTL Number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values Property Map - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<Property Map> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<Property Map>Associations - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL Number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL Number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- path
Pattern String - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol StringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
CacheBehaviorResponse, CacheBehaviorResponseArgs
- Allowed
Methods List<string> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - Cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods List<string> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- Default
TTL int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - Forwarded
Values Pulumi.Azure Native. Aws Connector. Inputs. Forwarded Values Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations List<Pulumi.Azure Native. Aws Connector. Inputs. Function Association Response> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function List<Pulumi.Associations Azure Native. Aws Connector. Inputs. Lambda Function Association Response> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
TTL int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
TTL int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - Trusted
Key List<string>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers List<string> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - Viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- Allowed
Methods []string - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - Cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods []string - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- Default
TTL int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - Forwarded
Values ForwardedValues Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations []FunctionAssociation Response - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function []LambdaAssociations Function Association Response - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
TTL int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
TTL int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - Trusted
Key []stringGroups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers []string - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - Viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy StringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
TTL Integer - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values ForwardedValues Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<FunctionAssociation Response> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<LambdaAssociations Function Association Response> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL Integer - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL Integer - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- path
Pattern String - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol StringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods string[] - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy stringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods string[] - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
TTL number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values ForwardedValues Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations FunctionAssociation Response[] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function LambdaAssociations Function Association Response[] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- path
Pattern string - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers stringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - trusted
Key string[]Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers string[] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed_
methods Sequence[str] - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache_
policy_ strid - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached_
methods Sequence[str] - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default_
ttl int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field_
level_ strencryption_ id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded_
values ForwardedValues Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function_
associations Sequence[FunctionAssociation Response] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda_
function_ Sequence[Lambdaassociations Function Association Response] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max_
ttl int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min_
ttl int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin_
request_ strpolicy_ id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- path_
pattern str - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - realtime_
log_ strconfig_ arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response_
headers_ strpolicy_ id - The identifier for a response headers policy.
- smooth_
streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target_
origin_ strid - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - trusted_
key_ Sequence[str]groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted_
signers Sequence[str] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer_
protocol_ strpolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy StringId - The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- default
TTL Number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - forwarded
Values Property Map - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<Property Map> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<Property Map>Associations - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL Number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL Number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- path
Pattern String - The pattern (for example,
images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
. The path pattern for the default cache behavior is*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. - realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they match this cache behavior. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol StringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
CloudFrontDistributionProperties, CloudFrontDistributionPropertiesArgs
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Cloud Front Distribution Properties - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsCloud Front Distribution Properties - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsCloud Front Distribution Properties - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsCloud Front Distribution Properties - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsCloud Front Distribution Properties - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
CloudFrontDistributionPropertiesResponse, CloudFrontDistributionPropertiesResponseArgs
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Cloud Front Distribution Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsCloud Front Distribution Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsCloud Front Distribution Properties Response - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- provisioning
State string - The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsCloud Front Distribution Properties Response - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning_
state str - The status of the last operation.
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsCloud Front Distribution Properties Response - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
Cookies, CookiesArgs
- Forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - Whitelisted
Names List<string> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- Forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - Whitelisted
Names []string - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- forward String
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names List<String> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names string[] - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- forward str
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted_
names Sequence[str] - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- forward String
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names List<String> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
CookiesResponse, CookiesResponseArgs
- Forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - Whitelisted
Names List<string> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- Forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - Whitelisted
Names []string - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- forward String
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names List<String> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- forward string
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names string[] - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- forward str
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted_
names Sequence[str] - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
- forward String
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNames
complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for theForward
element. - whitelisted
Names List<String> - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
CustomErrorResponse, CustomErrorResponseArgs
- Error
Caching intMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - Error
Code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- Response
Code int - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - Response
Page stringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- Error
Caching intMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - Error
Code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- Response
Code int - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - Response
Page stringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- error
Caching IntegerMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - error
Code Integer - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- response
Code Integer - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - response
Page StringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- error
Caching numberMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - error
Code number - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- response
Code number - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - response
Page stringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- error_
caching_ intmin_ ttl - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - error_
code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- response_
code int - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - response_
page_ strpath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- error
Caching NumberMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - error
Code Number - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- response
Code Number - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - response
Page StringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
CustomErrorResponseResponse, CustomErrorResponseResponseArgs
- Error
Caching intMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - Error
Code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- Response
Code int - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - Response
Page stringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- Error
Caching intMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - Error
Code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- Response
Code int - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - Response
Page stringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- error
Caching IntegerMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - error
Code Integer - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- response
Code Integer - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - response
Page StringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- error
Caching numberMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - error
Code number - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- response
Code number - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - response
Page stringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- error_
caching_ intmin_ ttl - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - error_
code int - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- response_
code int - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - response_
page_ strpath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
- error
Caching NumberMin TTL - The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode
. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. - error
Code Number - The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- response
Code Number - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200
, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify400
or500
as theResponseCode
for all 4xx or 5xx errors. + You might want to return a200
status code (OK) and static website so your customers don't know that your website is down. If you specify a value forResponseCode
, you must also specify a value forResponsePagePath
. - response
Page StringPath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode
, for example,/4xx-errors/403-forbidden.html
. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value ofPathPattern
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 ofTargetOriginId
specifies the value of theID
element for the origin that contains your custom error pages. If you specify a value forResponsePagePath
, you must also specify a value forResponseCode
. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
CustomOriginConfigResponse, CustomOriginConfigResponseArgs
- Http
Port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- Https
Port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- Origin
Keepalive intTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- Origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: +
http-only
– CloudFront always uses HTTP to connect to the origin. +match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. +https-only
– CloudFront always uses HTTPS to connect to the origin. - Origin
Read intTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- Origin
SSLProtocols List<string> - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- Http
Port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- Https
Port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- Origin
Keepalive intTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- Origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: +
http-only
– CloudFront always uses HTTP to connect to the origin. +match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. +https-only
– CloudFront always uses HTTPS to connect to the origin. - Origin
Read intTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- Origin
SSLProtocols []string - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- http
Port Integer - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port Integer - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- origin
Keepalive IntegerTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- origin
Protocol StringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: +
http-only
– CloudFront always uses HTTP to connect to the origin. +match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. +https-only
– CloudFront always uses HTTPS to connect to the origin. - origin
Read IntegerTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- origin
SSLProtocols List<String> - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- http
Port number - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port number - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- origin
Keepalive numberTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- origin
Protocol stringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: +
http-only
– CloudFront always uses HTTP to connect to the origin. +match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. +https-only
– CloudFront always uses HTTPS to connect to the origin. - origin
Read numberTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- origin
SSLProtocols string[] - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- http_
port int - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https_
port int - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- origin_
keepalive_ inttimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- origin_
protocol_ strpolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: +
http-only
– CloudFront always uses HTTP to connect to the origin. +match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. +https-only
– CloudFront always uses HTTPS to connect to the origin. - origin_
read_ inttimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- origin_
ssl_ Sequence[str]protocols - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
- http
Port Number - The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- https
Port Number - The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- origin
Keepalive NumberTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- origin
Protocol StringPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: +
http-only
– CloudFront always uses HTTP to connect to the origin. +match-viewer
– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. +https-only
– CloudFront always uses HTTPS to connect to the origin. - origin
Read NumberTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- origin
SSLProtocols List<String> - Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3
,TLSv1
,TLSv1.1
, andTLSv1.2
. For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
DefaultCacheBehavior, DefaultCacheBehaviorArgs
- Allowed
Methods List<string> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - Cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods List<string> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - Default
TTL int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - Forwarded
Values Pulumi.Azure Native. Aws Connector. Inputs. Forwarded Values - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations List<Pulumi.Azure Native. Aws Connector. Inputs. Function Association> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function List<Pulumi.Associations Azure Native. Aws Connector. Inputs. Lambda Function Association> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
TTL int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
TTL int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - Trusted
Key List<string>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers List<string> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - Viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- Allowed
Methods []string - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - Cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods []string - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - Default
TTL int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - Forwarded
Values ForwardedValues - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations []FunctionAssociation - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function []LambdaAssociations Function Association - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
TTL int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
TTL int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - Trusted
Key []stringGroups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers []string - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - Viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy StringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
TTL Integer - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values ForwardedValues - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<FunctionAssociation> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<LambdaAssociations Function Association> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL Integer - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL Integer - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol StringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods string[] - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods string[] - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
TTL number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values ForwardedValues - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations FunctionAssociation[] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function LambdaAssociations Function Association[] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers stringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - trusted
Key string[]Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers string[] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed_
methods Sequence[str] - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache_
policy_ strid - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached_
methods Sequence[str] - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default_
ttl int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field_
level_ strencryption_ id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded_
values ForwardedValues - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function_
associations Sequence[FunctionAssociation] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda_
function_ Sequence[Lambdaassociations Function Association] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max_
ttl int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min_
ttl int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin_
request_ strpolicy_ id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime_
log_ strconfig_ arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response_
headers_ strpolicy_ id - The identifier for a response headers policy.
- smooth_
streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target_
origin_ strid - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - trusted_
key_ Sequence[str]groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted_
signers Sequence[str] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer_
protocol_ strpolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy StringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
TTL Number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values Property Map - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<Property Map> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<Property Map>Associations - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL Number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL Number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol StringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
DefaultCacheBehaviorResponse, DefaultCacheBehaviorResponseArgs
- Allowed
Methods List<string> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - Cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods List<string> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - Default
TTL int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - Forwarded
Values Pulumi.Azure Native. Aws Connector. Inputs. Forwarded Values Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations List<Pulumi.Azure Native. Aws Connector. Inputs. Function Association Response> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function List<Pulumi.Associations Azure Native. Aws Connector. Inputs. Lambda Function Association Response> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
TTL int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
TTL int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - Trusted
Key List<string>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers List<string> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - Viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- Allowed
Methods []string - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - Cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - Cached
Methods []string - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - Compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - Default
TTL int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - Forwarded
Values ForwardedValues Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - Function
Associations []FunctionAssociation Response - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - Lambda
Function []LambdaAssociations Function Association Response - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- Max
TTL int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - Min
TTL int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - Origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- Realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- Response
Headers stringPolicy Id - The identifier for a response headers policy.
- Smooth
Streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - Target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - Trusted
Key []stringGroups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Trusted
Signers []string - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - Viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy StringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
TTL Integer - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values ForwardedValues Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<FunctionAssociation Response> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<LambdaAssociations Function Association Response> - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL Integer - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL Integer - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol StringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods string[] - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy stringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods string[] - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
TTL number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level stringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values ForwardedValues Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations FunctionAssociation Response[] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function LambdaAssociations Function Association Response[] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request stringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log stringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers stringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin stringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - trusted
Key string[]Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers string[] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol stringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed_
methods Sequence[str] - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache_
policy_ strid - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached_
methods Sequence[str] - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress bool
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default_
ttl int - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field_
level_ strencryption_ id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded_
values ForwardedValues Response - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function_
associations Sequence[FunctionAssociation Response] - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda_
function_ Sequence[Lambdaassociations Function Association Response] - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max_
ttl int - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min_
ttl int - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin_
request_ strpolicy_ id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime_
log_ strconfig_ arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response_
headers_ strpolicy_ id - The identifier for a response headers policy.
- smooth_
streaming bool - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target_
origin_ strid - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - trusted_
key_ Sequence[str]groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted_
signers Sequence[str] - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer_
protocol_ strpolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
- allowed
Methods List<String> - A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only
GET
andHEAD
requests. + CloudFront forwards onlyGET
,HEAD
, andOPTIONS
requests. + CloudFront forwardsGET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. - cache
Policy StringId - The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. - cached
Methods List<String> - A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to
GET
andHEAD
requests. + CloudFront caches responses toGET
,HEAD
, andOPTIONS
requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. - compress Boolean
- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true
; if not, specifyfalse
. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - default
TTL Number - This field is deprecated. We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - field
Level StringEncryption Id - The value of
ID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - forwarded
Values Property Map - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide. If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. A
DefaultCacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. 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 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 in the Amazon CloudFront Developer Guide. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. - function
Associations List<Property Map> - A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior. - lambda
Function List<Property Map>Associations - A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- max
TTL Number - This field is deprecated. We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such asCache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - min
TTL Number - This field is deprecated. We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. You must specify0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
). - origin
Request StringPolicy Id - The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- realtime
Log StringConfig Arn - The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- response
Headers StringPolicy Id - The identifier for a response headers policy.
- smooth
Streaming Boolean - Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
. - target
Origin StringId - The value of
ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior. - trusted
Key List<String>Groups - A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- trusted
Signers List<String> - We recommend using
TrustedKeyGroups
instead ofTrustedSigners
. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. - viewer
Protocol StringPolicy - The protocol that viewers can use to access the files in the origin specified by
TargetOriginId
when a request matches the path pattern inPathPattern
. You can specify the following options: +allow-all
: Viewers can use HTTP or HTTPS. +redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. +https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
DistributionConfig, DistributionConfigArgs
- Aliases List<string>
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- Cache
Behaviors List<Pulumi.Azure Native. Aws Connector. Inputs. Cache Behavior> - A complex type that contains zero or more
CacheBehavior
elements. - Cnam
Es List<string> - Property cnamEs
- Comment string
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- Continuous
Deployment stringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - Custom
Error List<Pulumi.Responses Azure Native. Aws Connector. Inputs. Custom Error Response> - A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- Custom
Origin Pulumi.Azure Native. Aws Connector. Inputs. Legacy Custom Origin - Property customOrigin
- Default
Cache Pulumi.Behavior Azure Native. Aws Connector. Inputs. Default Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if request URLs don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - Default
Root stringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - Enabled bool
- From this field, you can enable or disable the selected distribution.
- Http
Version string - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - Ip
V6Enabled bool - If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. - Logging
Pulumi.
Azure Native. Aws Connector. Inputs. Logging - A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide. A complex type that controls whether access logs are written for the distribution.
- Origin
Groups Pulumi.Azure Native. Aws Connector. Inputs. Origin Groups - A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution.
- Origins
List<Pulumi.
Azure Native. Aws Connector. Origin> - A complex type that contains information about origins for this distribution.
- Price
Class string - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - Restrictions
Pulumi.
Azure Native. Aws Connector. Inputs. Restrictions - A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content.
- S3Origin
Pulumi.
Azure Native. Aws Connector. Inputs. Legacy S3Origin - Property s3Origin
- Staging bool
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - Viewer
Certificate Pulumi.Azure Native. Aws Connector. Inputs. Viewer Certificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. 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 asd111111abcdef8.cloudfront.net
—setCloudFrontDefaultCertificate
totrue
and leave all other fields empty. If the distribution usesAliases
(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) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, setSSLSupportMethod
tosni-only
. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, setSSLSupportMethod
tovip
. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name isSslSupportMethod
. 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 forMinimumProtocolVersion
. For more information, see Security Policy in the Amazon CloudFront Developer Guide. + The location of the SSL/TLS certificate, (ACM) (recommended) or (IAM). You specify the location by setting a value in one of the following fields (not both): +ACMCertificateArn
(In CloudFormation, this field name isAcmCertificateArn
. Note the different capitalization.) +IAMCertificateId
(In CloudFormation, this field name isIamCertificateId
. 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, useViewerProtocolPolicy
in theCacheBehavior
orDefaultCacheBehavior
. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, useCustomOriginConfig
. For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide. - Web
ACLId string - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- Aliases []string
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- Cache
Behaviors []CacheBehavior - A complex type that contains zero or more
CacheBehavior
elements. - Cnam
Es []string - Property cnamEs
- Comment string
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- Continuous
Deployment stringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - Custom
Error []CustomResponses Error Response - A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- Custom
Origin LegacyCustom Origin - Property customOrigin
- Default
Cache DefaultBehavior Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if request URLs don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - Default
Root stringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - Enabled bool
- From this field, you can enable or disable the selected distribution.
- Http
Version string - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - Ip
V6Enabled bool - If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. - Logging Logging
- A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide. A complex type that controls whether access logs are written for the distribution.
- Origin
Groups OriginGroups - A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution.
- Origins []Origin
- A complex type that contains information about origins for this distribution.
- Price
Class string - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - Restrictions Restrictions
- A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content.
- S3Origin
Legacy
S3Origin - Property s3Origin
- Staging bool
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - Viewer
Certificate ViewerCertificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. 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 asd111111abcdef8.cloudfront.net
—setCloudFrontDefaultCertificate
totrue
and leave all other fields empty. If the distribution usesAliases
(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) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, setSSLSupportMethod
tosni-only
. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, setSSLSupportMethod
tovip
. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name isSslSupportMethod
. 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 forMinimumProtocolVersion
. For more information, see Security Policy in the Amazon CloudFront Developer Guide. + The location of the SSL/TLS certificate, (ACM) (recommended) or (IAM). You specify the location by setting a value in one of the following fields (not both): +ACMCertificateArn
(In CloudFormation, this field name isAcmCertificateArn
. Note the different capitalization.) +IAMCertificateId
(In CloudFormation, this field name isIamCertificateId
. 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, useViewerProtocolPolicy
in theCacheBehavior
orDefaultCacheBehavior
. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, useCustomOriginConfig
. For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide. - Web
ACLId string - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- aliases List<String>
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- cache
Behaviors List<CacheBehavior> - A complex type that contains zero or more
CacheBehavior
elements. - cnam
Es List<String> - Property cnamEs
- comment String
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- continuous
Deployment StringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - custom
Error List<CustomResponses Error Response> - A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- custom
Origin LegacyCustom Origin - Property customOrigin
- default
Cache DefaultBehavior Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if request URLs don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - default
Root StringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - enabled Boolean
- From this field, you can enable or disable the selected distribution.
- http
Version String - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - ip
V6Enabled Boolean - If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. - logging Logging
- A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide. A complex type that controls whether access logs are written for the distribution.
- origin
Groups OriginGroups - A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution.
- origins List<Origin>
- A complex type that contains information about origins for this distribution.
- price
Class String - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - restrictions Restrictions
- A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content.
- s3Origin
Legacy
S3Origin - Property s3Origin
- staging Boolean
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - viewer
Certificate ViewerCertificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. 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 asd111111abcdef8.cloudfront.net
—setCloudFrontDefaultCertificate
totrue
and leave all other fields empty. If the distribution usesAliases
(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) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, setSSLSupportMethod
tosni-only
. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, setSSLSupportMethod
tovip
. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name isSslSupportMethod
. 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 forMinimumProtocolVersion
. For more information, see Security Policy in the Amazon CloudFront Developer Guide. + The location of the SSL/TLS certificate, (ACM) (recommended) or (IAM). You specify the location by setting a value in one of the following fields (not both): +ACMCertificateArn
(In CloudFormation, this field name isAcmCertificateArn
. Note the different capitalization.) +IAMCertificateId
(In CloudFormation, this field name isIamCertificateId
. 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, useViewerProtocolPolicy
in theCacheBehavior
orDefaultCacheBehavior
. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, useCustomOriginConfig
. For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide. - web
ACLId String - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- aliases string[]
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- cache
Behaviors CacheBehavior[] - A complex type that contains zero or more
CacheBehavior
elements. - cnam
Es string[] - Property cnamEs
- comment string
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- continuous
Deployment stringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - custom
Error CustomResponses Error Response[] - A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- custom
Origin LegacyCustom Origin - Property customOrigin
- default
Cache DefaultBehavior Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if request URLs don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - default
Root stringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - enabled boolean
- From this field, you can enable or disable the selected distribution.
- http
Version string - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - ip
V6Enabled boolean - If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. - logging Logging
- A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide. A complex type that controls whether access logs are written for the distribution.
- origin
Groups OriginGroups - A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution.
- origins Origin[]
- A complex type that contains information about origins for this distribution.
- price
Class string - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - restrictions Restrictions
- A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content.
- s3Origin
Legacy
S3Origin - Property s3Origin
- staging boolean
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - viewer
Certificate ViewerCertificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. 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 asd111111abcdef8.cloudfront.net
—setCloudFrontDefaultCertificate
totrue
and leave all other fields empty. If the distribution usesAliases
(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) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, setSSLSupportMethod
tosni-only
. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, setSSLSupportMethod
tovip
. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name isSslSupportMethod
. 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 forMinimumProtocolVersion
. For more information, see Security Policy in the Amazon CloudFront Developer Guide. + The location of the SSL/TLS certificate, (ACM) (recommended) or (IAM). You specify the location by setting a value in one of the following fields (not both): +ACMCertificateArn
(In CloudFormation, this field name isAcmCertificateArn
. Note the different capitalization.) +IAMCertificateId
(In CloudFormation, this field name isIamCertificateId
. 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, useViewerProtocolPolicy
in theCacheBehavior
orDefaultCacheBehavior
. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, useCustomOriginConfig
. For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide. - web
ACLId string - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- aliases Sequence[str]
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- cache_
behaviors Sequence[CacheBehavior] - A complex type that contains zero or more
CacheBehavior
elements. - cnam_
es Sequence[str] - Property cnamEs
- comment str
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- continuous_
deployment_ strpolicy_ id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - custom_
error_ Sequence[Customresponses Error Response] - A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- custom_
origin LegacyCustom Origin - Property customOrigin
- default_
cache_ Defaultbehavior Cache Behavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if request URLs don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - default_
root_ strobject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - enabled bool
- From this field, you can enable or disable the selected distribution.
- http_
version str - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - ip_
v6_ boolenabled - If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. - logging Logging
- A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide. A complex type that controls whether access logs are written for the distribution.
- origin_
groups OriginGroups - A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution.
- origins Sequence[Origin]
- A complex type that contains information about origins for this distribution.
- price_
class str - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - restrictions Restrictions
- A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content.
- s3_
origin LegacyS3Origin - Property s3Origin
- staging bool
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - viewer_
certificate ViewerCertificate - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. 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 asd111111abcdef8.cloudfront.net
—setCloudFrontDefaultCertificate
totrue
and leave all other fields empty. If the distribution usesAliases
(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) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, setSSLSupportMethod
tosni-only
. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, setSSLSupportMethod
tovip
. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name isSslSupportMethod
. 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 forMinimumProtocolVersion
. For more information, see Security Policy in the Amazon CloudFront Developer Guide. + The location of the SSL/TLS certificate, (ACM) (recommended) or (IAM). You specify the location by setting a value in one of the following fields (not both): +ACMCertificateArn
(In CloudFormation, this field name isAcmCertificateArn
. Note the different capitalization.) +IAMCertificateId
(In CloudFormation, this field name isIamCertificateId
. 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, useViewerProtocolPolicy
in theCacheBehavior
orDefaultCacheBehavior
. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, useCustomOriginConfig
. For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide. - web_
acl_ strid - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a
. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.
- aliases List<String>
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- cache
Behaviors List<Property Map> - A complex type that contains zero or more
CacheBehavior
elements. - cnam
Es List<String> - Property cnamEs
- comment String
- A comment to describe the distribution. The comment cannot be longer than 128 characters.
- continuous
Deployment StringPolicy Id - The identifier of a continuous deployment policy. For more information, see
CreateContinuousDeploymentPolicy
. - custom
Error List<Property Map>Responses - A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- custom
Origin Property Map - Property customOrigin
- default
Cache Property MapBehavior - A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if request URLs don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior. - default
Root StringObject - The object that you want CloudFront to request from your origin (for example,
index.html
) when a viewer requests the root URL for your distribution (https://www.example.com
) instead of an object in your distribution (https://www.example.com/product-description.html
). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example,index.html
. Don't add a/
before the object name. If you don't want to specify a default root object when you create a distribution, include an emptyDefaultRootObject
element. To delete the default root object from an existing distribution, update the distribution configuration and include an emptyDefaultRootObject
element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. - enabled Boolean
- From this field, you can enable or disable the selected distribution.
- http
Version String - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is
http1.1
. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront. - ip
V6Enabled Boolean - If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true
. If you specifyfalse
, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERROR
and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes theIpAddress
parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Developer Guide. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. - logging Property Map
- A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide. A complex type that controls whether access logs are written for the distribution.
- origin
Groups Property Map - A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution.
- origins List<"AWS_KMS" | "EXTERNAL">
- A complex type that contains information about origins for this distribution.
- price
Class String - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify
PriceClass_All
, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other thanPriceClass_All
, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. - restrictions Property Map
- A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content.
- s3Origin Property Map
- Property s3Origin
- staging Boolean
- A Boolean that indicates whether this is a staging distribution. When this value is
true
, this is a staging distribution. When this value isfalse
, this is not a staging distribution. - viewer
Certificate Property Map - A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. 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 asd111111abcdef8.cloudfront.net
—setCloudFrontDefaultCertificate
totrue
and leave all other fields empty. If the distribution usesAliases
(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) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, setSSLSupportMethod
tosni-only
. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name isSslSupportMethod
. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, setSSLSupportMethod
tovip
. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name isSslSupportMethod
. 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 forMinimumProtocolVersion
. For more information, see Security Policy in the Amazon CloudFront Developer Guide