software.amazon.awssdk.services.cloudfront.model

Interface DefaultCacheBehavior.Builder

All Superinterfaces:

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

Enclosing class:

DefaultCacheBehavior

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

Method Summary

Modifier and Type	Method and Description
DefaultCacheBehavior.Builder	allowedMethods(AllowedMethods allowedMethods) Sets the value of the AllowedMethods property for this object.
default DefaultCacheBehavior.Builder	allowedMethods(Consumer<AllowedMethods.Builder> allowedMethods) Sets the value of the AllowedMethods property for this object.
DefaultCacheBehavior.Builder	compress(Boolean compress) Whether you want CloudFront to automatically compress certain files for this cache behavior.
DefaultCacheBehavior.Builder	defaultTTL(Long defaultTTL) 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.
DefaultCacheBehavior.Builder	fieldLevelEncryptionId(String fieldLevelEncryptionId) The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.
default DefaultCacheBehavior.Builder	forwardedValues(Consumer<ForwardedValues.Builder> forwardedValues) A complex type that specifies how CloudFront handles query strings and cookies.
DefaultCacheBehavior.Builder	forwardedValues(ForwardedValues forwardedValues) A complex type that specifies how CloudFront handles query strings and cookies.
default DefaultCacheBehavior.Builder	lambdaFunctionAssociations(Consumer<LambdaFunctionAssociations.Builder> lambdaFunctionAssociations) A complex type that contains zero or more Lambda function associations for a cache behavior.
DefaultCacheBehavior.Builder	lambdaFunctionAssociations(LambdaFunctionAssociations lambdaFunctionAssociations) A complex type that contains zero or more Lambda function associations for a cache behavior.
DefaultCacheBehavior.Builder	maxTTL(Long maxTTL) Sets the value of the MaxTTL property for this object.
DefaultCacheBehavior.Builder	minTTL(Long minTTL) 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.
DefaultCacheBehavior.Builder	smoothStreaming(Boolean 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.
DefaultCacheBehavior.Builder	targetOriginId(String targetOriginId) The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.
default DefaultCacheBehavior.Builder	trustedSigners(Consumer<TrustedSigners.Builder> trustedSigners) A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
DefaultCacheBehavior.Builder	trustedSigners(TrustedSigners trustedSigners) A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
DefaultCacheBehavior.Builder	viewerProtocolPolicy(String 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.
DefaultCacheBehavior.Builder	viewerProtocolPolicy(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.

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

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

targetOriginId

DefaultCacheBehavior.Builder targetOriginId(String targetOriginId)

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

Parameters:

targetOriginId - The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

Returns:

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

forwardedValues

DefaultCacheBehavior.Builder forwardedValues(ForwardedValues forwardedValues)

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

Parameters:

forwardedValues - A complex type that specifies how CloudFront handles query strings and cookies.

Returns:

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

forwardedValues

default DefaultCacheBehavior.Builder forwardedValues(Consumer<ForwardedValues.Builder> forwardedValues)

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

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

Parameters:

forwardedValues - a consumer that will call methods on ForwardedValues.Builder

Returns:

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

See Also:

forwardedValues(ForwardedValues)

trustedSigners

DefaultCacheBehavior.Builder trustedSigners(TrustedSigners trustedSigners)

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

Parameters:

trustedSigners - A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

Returns:

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

trustedSigners

default DefaultCacheBehavior.Builder trustedSigners(Consumer<TrustedSigners.Builder> trustedSigners)

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

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

Parameters:

trustedSigners - a consumer that will call methods on TrustedSigners.Builder

Returns:

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

See Also:

trustedSigners(TrustedSigners)

viewerProtocolPolicy

DefaultCacheBehavior.Builder viewerProtocolPolicy(String 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:

• 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Parameters:

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:

• 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Returns:

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

See Also:

ViewerProtocolPolicy, ViewerProtocolPolicy

viewerProtocolPolicy

DefaultCacheBehavior.Builder viewerProtocolPolicy(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:

• 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Parameters:

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:

• 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Returns:

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

See Also:

ViewerProtocolPolicy, ViewerProtocolPolicy

minTTL

DefaultCacheBehavior.Builder minTTL(Long minTTL)

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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

Parameters:

minTTL - 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

Returns:

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

allowedMethods

DefaultCacheBehavior.Builder allowedMethods(AllowedMethods allowedMethods)

Sets the value of the AllowedMethods property for this object.

Parameters:

allowedMethods - The new value for the AllowedMethods property for this object.

Returns:

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

allowedMethods

default DefaultCacheBehavior.Builder allowedMethods(Consumer<AllowedMethods.Builder> allowedMethods)

Sets the value of the AllowedMethods property for this object. This is a convenience that creates an instance of the AllowedMethods.Builder avoiding the need to create one manually via AllowedMethods.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to allowedMethods(AllowedMethods).

Parameters:

allowedMethods - a consumer that will call methods on AllowedMethods.Builder

Returns:

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

See Also:

allowedMethods(AllowedMethods)

smoothStreaming

DefaultCacheBehavior.Builder smoothStreaming(Boolean 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. 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.

Parameters:

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

Returns:

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

defaultTTL

DefaultCacheBehavior.Builder defaultTTL(Long defaultTTL)

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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Parameters:

defaultTTL - 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Returns:

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

maxTTL

DefaultCacheBehavior.Builder maxTTL(Long maxTTL)

Sets the value of the MaxTTL property for this object.

Parameters:

maxTTL - The new value for the MaxTTL property for this object.

Returns:

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

compress

DefaultCacheBehavior.Builder compress(Boolean compress)

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.

Parameters:

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

Returns:

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

lambdaFunctionAssociations

DefaultCacheBehavior.Builder lambdaFunctionAssociations(LambdaFunctionAssociations lambdaFunctionAssociations)

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

Parameters:

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

Returns:

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

lambdaFunctionAssociations

default DefaultCacheBehavior.Builder lambdaFunctionAssociations(Consumer<LambdaFunctionAssociations.Builder> lambdaFunctionAssociations)

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

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

Parameters:

lambdaFunctionAssociations - a consumer that will call methods on LambdaFunctionAssociations.Builder

Returns:

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

See Also:

lambdaFunctionAssociations(LambdaFunctionAssociations)

fieldLevelEncryptionId

DefaultCacheBehavior.Builder fieldLevelEncryptionId(String fieldLevelEncryptionId)

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

Parameters:

fieldLevelEncryptionId - The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

Returns:

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