software.amazon.awssdk.services.cloudfront.model

Interface CachePolicyConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CachePolicyConfig.Builder,CachePolicyConfig>, SdkBuilder<CachePolicyConfig.Builder,CachePolicyConfig>, SdkPojo

Enclosing class:

CachePolicyConfig

public static interface CachePolicyConfig.Builder
extends SdkPojo, CopyableBuilder<CachePolicyConfig.Builder,CachePolicyConfig>

Method Summary

Modifier and Type	Method and Description
CachePolicyConfig.Builder	comment(String comment) A comment to describe the cache policy.
CachePolicyConfig.Builder	defaultTTL(Long defaultTTL) The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated.
CachePolicyConfig.Builder	maxTTL(Long maxTTL) The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated.
CachePolicyConfig.Builder	minTTL(Long minTTL) The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated.
CachePolicyConfig.Builder	name(String name) A unique name to identify the cache policy.
default CachePolicyConfig.Builder	parametersInCacheKeyAndForwardedToOrigin(Consumer<ParametersInCacheKeyAndForwardedToOrigin.Builder> parametersInCacheKeyAndForwardedToOrigin) The HTTP headers, cookies, and URL query strings to include in the cache key.
CachePolicyConfig.Builder	parametersInCacheKeyAndForwardedToOrigin(ParametersInCacheKeyAndForwardedToOrigin parametersInCacheKeyAndForwardedToOrigin) The HTTP headers, cookies, and URL query strings to include in the cache key.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

comment

CachePolicyConfig.Builder comment(String comment)

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Parameters:

comment - A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CachePolicyConfig.Builder name(String name)

A unique name to identify the cache policy.

Parameters:

name - A unique name to identify the cache policy.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultTTL

CachePolicyConfig.Builder defaultTTL(Long defaultTTL)

The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.

Parameters:

defaultTTL - The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxTTL

CachePolicyConfig.Builder maxTTL(Long maxTTL)

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.

Parameters:

maxTTL - The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.

Returns:

Returns a reference to this object so that method calls can be chained together.

minTTL

CachePolicyConfig.Builder minTTL(Long minTTL)

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Parameters:

minTTL - The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

parametersInCacheKeyAndForwardedToOrigin

CachePolicyConfig.Builder parametersInCacheKeyAndForwardedToOrigin(ParametersInCacheKeyAndForwardedToOrigin parametersInCacheKeyAndForwardedToOrigin)

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Parameters:

parametersInCacheKeyAndForwardedToOrigin - The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

parametersInCacheKeyAndForwardedToOrigin

default CachePolicyConfig.Builder parametersInCacheKeyAndForwardedToOrigin(Consumer<ParametersInCacheKeyAndForwardedToOrigin.Builder> parametersInCacheKeyAndForwardedToOrigin)

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

This is a convenience that creates an instance of the ParametersInCacheKeyAndForwardedToOrigin.Builder avoiding the need to create one manually via ParametersInCacheKeyAndForwardedToOrigin.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parametersInCacheKeyAndForwardedToOrigin(ParametersInCacheKeyAndForwardedToOrigin).

Parameters:

parametersInCacheKeyAndForwardedToOrigin - a consumer that will call methods on ParametersInCacheKeyAndForwardedToOrigin.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

parametersInCacheKeyAndForwardedToOrigin(ParametersInCacheKeyAndForwardedToOrigin)