cloudfront/aws.sdk.kotlin.services.cloudfront.model/CacheBehavior/Builder

Builder

Properties

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:

cachePolicyId

var cachePolicyId: String?

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.

compress

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

defaultTtl

var ~~defaultTtl~~: Long?

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.

fieldLevelEncryptionId

var fieldLevelEncryptionId: String?

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.

forwardedValues

var ~~forwardedValues~~: 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.

functionAssociations

var functionAssociations: FunctionAssociations?

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.

lambdaFunctionAssociations

var lambdaFunctionAssociations: LambdaFunctionAssociations?

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

maxTtl

var ~~maxTtl~~: Long?

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.

minTtl

var ~~minTtl~~: Long?

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.

originRequestPolicyId

var originRequestPolicyId: String?

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.

pathPattern

var pathPattern: 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.

realtimeLogConfigArn

var realtimeLogConfigArn: String?

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.

responseHeadersPolicyId

var responseHeadersPolicyId: String?

The identifier for a response headers policy.

smoothStreaming

var smoothStreaming: 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, 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.

targetOriginId

var targetOriginId: String?

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

trustedKeyGroups

var trustedKeyGroups: TrustedKeyGroups?

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

trustedSigners

var trustedSigners: TrustedSigners?

We recommend using TrustedKeyGroups instead of TrustedSigners.

viewerProtocolPolicy

var viewerProtocolPolicy: 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. You can specify the following options: