DefaultCacheBehaviorArgs

data class DefaultCacheBehaviorArgs(val allowedMethods: Output<List<String>>? = null, val cachePolicyId: Output<String>? = null, val cachedMethods: Output<List<String>>? = null, val compress: Output<Boolean>? = null, val defaultTTL: Output<Int>? = null, val fieldLevelEncryptionId: Output<String>? = null, val forwardedValues: Output<ForwardedValuesArgs>? = null, val functionAssociations: Output<List<FunctionAssociationArgs>>? = null, val lambdaFunctionAssociations: Output<List<LambdaFunctionAssociationArgs>>? = null, val maxTTL: Output<Int>? = null, val minTTL: Output<Int>? = null, val originRequestPolicyId: Output<String>? = null, val realtimeLogConfigArn: Output<String>? = null, val responseHeadersPolicyId: Output<String>? = null, val smoothStreaming: Output<Boolean>? = null, val targetOriginId: Output<String>? = null, val trustedKeyGroups: Output<List<String>>? = null, val trustedSigners: Output<List<String>>? = null, val viewerProtocolPolicy: Output<String>? = null) : ConvertibleToJava<DefaultCacheBehaviorArgs>

Definition of DefaultCacheBehavior

Constructors

Link copied to clipboard
constructor(allowedMethods: Output<List<String>>? = null, cachePolicyId: Output<String>? = null, cachedMethods: Output<List<String>>? = null, compress: Output<Boolean>? = null, defaultTTL: Output<Int>? = null, fieldLevelEncryptionId: Output<String>? = null, forwardedValues: Output<ForwardedValuesArgs>? = null, functionAssociations: Output<List<FunctionAssociationArgs>>? = null, lambdaFunctionAssociations: Output<List<LambdaFunctionAssociationArgs>>? = null, maxTTL: Output<Int>? = null, minTTL: Output<Int>? = null, originRequestPolicyId: Output<String>? = null, realtimeLogConfigArn: Output<String>? = null, responseHeadersPolicyId: Output<String>? = null, smoothStreaming: Output<Boolean>? = null, targetOriginId: Output<String>? = null, trustedKeyGroups: Output<List<String>>? = null, trustedSigners: Output<List<String>>? = null, viewerProtocolPolicy: Output<String>? = null)

Properties

Link copied to clipboard
val allowedMethods: Output<List<String>>? = null

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only `GET` and `HEAD` requests. + CloudFront forwards only `GET`, `HEAD`, and `OPTIONS` requests. + CloudFront forwards `GET, HEAD, OPTIONS, PUT, PATCH, POST`, and `DELETE` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

Link copied to clipboard
val cachedMethods: Output<List<String>>? = null

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to `GET` and `HEAD` requests. + CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

Link copied to clipboard
val cachePolicyId: Output<String>? = null

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

Link copied to clipboard
val compress: Output<Boolean>? = null

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.

Link copied to clipboard
val defaultTTL: Output<Int>? = null

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 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.

Link copied to clipboard
val fieldLevelEncryptionId: Output<String>? = null

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.

Link copied to clipboard

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 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. 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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
val maxTTL: Output<Int>? = null

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 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.

Link copied to clipboard
val minTTL: Output<Int>? = null

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 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`).

Link copied to clipboard
val originRequestPolicyId: Output<String>? = null

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.

Link copied to clipboard
val realtimeLogConfigArn: Output<String>? = null

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.

Link copied to clipboard
val responseHeadersPolicyId: Output<String>? = null

The identifier for a response headers policy.

Link copied to clipboard
val smoothStreaming: Output<Boolean>? = null

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify `true`; if not, specify `false`. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`.

Link copied to clipboard
val targetOriginId: Output<String>? = null

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

Link copied to clipboard
val trustedKeyGroups: Output<List<String>>? = null

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.

Link copied to clipboard
val trustedSigners: Output<List<String>>? = null

We recommend using `TrustedKeyGroups` instead of `TrustedSigners`. 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.

Link copied to clipboard
val viewerProtocolPolicy: Output<String>? = null

The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`. You can specify the following options: + `allow-all`: Viewers can use HTTP or HTTPS. + `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront 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.

Functions

Link copied to clipboard
open override fun toJava(): DefaultCacheBehaviorArgs