Class CfnDistribution.DefaultCacheBehaviorProperty

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

Inheritance

System.Object

CfnDistribution.DefaultCacheBehaviorProperty

Implements

CfnDistribution.IDefaultCacheBehaviorProperty

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class DefaultCacheBehaviorProperty : Object, CfnDistribution.IDefaultCacheBehaviorProperty

Syntax (vb)

Public Class DefaultCacheBehaviorProperty
    Inherits Object
    Implements CfnDistribution.IDefaultCacheBehaviorProperty

Remarks

You must create exactly one default cache behavior.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;

var defaultCacheBehaviorProperty = new DefaultCacheBehaviorProperty {
    TargetOriginId = "targetOriginId",
    ViewerProtocolPolicy = "viewerProtocolPolicy",

    // the properties below are optional
    AllowedMethods = new [] { "allowedMethods" },
    CachedMethods = new [] { "cachedMethods" },
    CachePolicyId = "cachePolicyId",
    Compress = false,
    DefaultTtl = 123,
    FieldLevelEncryptionId = "fieldLevelEncryptionId",
    ForwardedValues = new ForwardedValuesProperty {
        QueryString = false,

        // the properties below are optional
        Cookies = new CookiesProperty {
            Forward = "forward",

            // the properties below are optional
            WhitelistedNames = new [] { "whitelistedNames" }
        },
        Headers = new [] { "headers" },
        QueryStringCacheKeys = new [] { "queryStringCacheKeys" }
    },
    FunctionAssociations = new [] { new FunctionAssociationProperty {
        EventType = "eventType",
        FunctionArn = "functionArn"
    } },
    GrpcConfig = new GrpcConfigProperty {
        Enabled = false
    },
    LambdaFunctionAssociations = new [] { new LambdaFunctionAssociationProperty {
        EventType = "eventType",
        IncludeBody = false,
        LambdaFunctionArn = "lambdaFunctionArn"
    } },
    MaxTtl = 123,
    MinTtl = 123,
    OriginRequestPolicyId = "originRequestPolicyId",
    RealtimeLogConfigArn = "realtimeLogConfigArn",
    ResponseHeadersPolicyId = "responseHeadersPolicyId",
    SmoothStreaming = false,
    TrustedKeyGroups = new [] { "trustedKeyGroups" },
    TrustedSigners = new [] { "trustedSigners" }
};

Synopsis

Constructors

DefaultCacheBehaviorProperty()

Properties

AllowedMethods	A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.
CachedMethods	A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods.
CachePolicyId	The unique identifier of the cache policy that is attached to the default cache behavior.
Compress	Whether you want CloudFront to automatically compress certain files for this cache behavior.
DefaultTtl	This field is deprecated.
FieldLevelEncryptionId	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.
ForwardedValues	This field is deprecated.
FunctionAssociations	A list of CloudFront functions that are associated with this cache behavior.
GrpcConfig	The gRPC configuration for your cache behavior.
LambdaFunctionAssociations	A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
MaxTtl	This field is deprecated.
MinTtl	This field is deprecated.
OriginRequestPolicyId	The unique identifier of the origin request policy that is attached to the default cache behavior.
RealtimeLogConfigArn	The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior.
ResponseHeadersPolicyId	The identifier for a response headers policy.
SmoothStreaming	Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.
TargetOriginId	The value of `ID` for the origin that you want CloudFront to route requests to when they use the default cache behavior.
TrustedKeyGroups	A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
TrustedSigners	We recommend using `TrustedKeyGroups` instead of `TrustedSigners` .
ViewerProtocolPolicy	The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern` .

Constructors

DefaultCacheBehaviorProperty()

public DefaultCacheBehaviorProperty()

Properties

AllowedMethods

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.

public string[] AllowedMethods { get; set; }

Property Value

System.String[]

Remarks

There are three choices:

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-allowedmethods

CachedMethods

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods.

public string[] CachedMethods { get; set; }

Property Value

System.String[]

Remarks

There are two choices:

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-cachedmethods

CachePolicyId

The unique identifier of the cache policy that is attached to the default cache behavior.

public string CachePolicyId { get; set; }

Property Value

System.String

Remarks

For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .

A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .

Default: - ""

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-cachepolicyid

Compress

Whether you want CloudFront to automatically compress certain files for this cache behavior.

public object Compress { get; set; }

Property Value

System.Object

Remarks

If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .

Default: - false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-compress

DefaultTtl

This field is deprecated.

public Nullable<double> DefaultTtl { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

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 as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .

Default: - 86400

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-defaultttl

FieldLevelEncryptionId

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.

public string FieldLevelEncryptionId { get; set; }

Property Value

System.String

Remarks

Default: - ""

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-fieldlevelencryptionid

ForwardedValues

This field is deprecated.

public object ForwardedValues { get; set; }

Property Value

System.Object

Remarks

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 a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .

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

FunctionAssociations

A list of CloudFront functions that are associated with this cache behavior.

public object FunctionAssociations { get; set; }

Property Value

System.Object

Remarks

Your functions must be published to the LIVE stage to associate them with a cache behavior.

GrpcConfig

The gRPC configuration for your cache behavior.

public object GrpcConfig { get; set; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-grpcconfig

LambdaFunctionAssociations

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

public object LambdaFunctionAssociations { get; set; }

Property Value

System.Object

Remarks

MaxTtl

This field is deprecated.

public Nullable<double> MaxTtl { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

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 as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .

Default: - 31536000

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-maxttl

MinTtl

This field is deprecated.

public Nullable<double> MinTtl { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

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 specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).

Default: - 0

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-minttl

OriginRequestPolicyId

The unique identifier of the origin request policy that is attached to the default cache behavior.

public string OriginRequestPolicyId { get; set; }

Property Value

System.String

Remarks

For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .

Default: - ""

RealtimeLogConfigArn

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior.

public string RealtimeLogConfigArn { get; set; }

Property Value

System.String

Remarks

For more information, see Real-time logs in the Amazon CloudFront Developer Guide .

Default: - ""

ResponseHeadersPolicyId

The identifier for a response headers policy.

public string ResponseHeadersPolicyId { get; set; }

Property Value

System.String

Remarks

Default: - ""

SmoothStreaming

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.

public object SmoothStreaming { get; set; }

Property Value

System.Object

Remarks

If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .

Default: - false

TargetOriginId

The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

public string TargetOriginId { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-targetoriginid

TrustedKeyGroups

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

public string[] TrustedKeyGroups { get; set; }

Property Value

System.String[]

Remarks

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 .

TrustedSigners

We recommend using TrustedKeyGroups instead of TrustedSigners .

public string[] TrustedSigners { get; set; }

Property Value

System.String[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-trustedsigners

ViewerProtocolPolicy

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern .

public string ViewerProtocolPolicy { get; set; }

Property Value

System.String

Remarks

You can specify the following options:

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&apos; 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 <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing Cache Expiration</a> in the <em>Amazon CloudFront Developer Guide</em> .

Implements

CfnDistribution.IDefaultCacheBehaviorProperty