Package software.amazon.awscdk.services.cloudfront

Class CfnDistribution.CacheBehaviorProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.CfnDistribution.CacheBehaviorProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDistribution.CacheBehaviorProperty>

Enclosing interface:

CfnDistribution.CacheBehaviorProperty

@Stability(Stable)
public static final class CfnDistribution.CacheBehaviorProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDistribution.CacheBehaviorProperty>

A builder for CfnDistribution.CacheBehaviorProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDistribution.CacheBehaviorProperty.Builder	allowedMethods(List<String> allowedMethods)	Sets the value of CfnDistribution.CacheBehaviorProperty.getAllowedMethods()
CfnDistribution.CacheBehaviorProperty	build()	Builds the configured instance.
CfnDistribution.CacheBehaviorProperty.Builder	cachedMethods(List<String> cachedMethods)	Sets the value of CfnDistribution.CacheBehaviorProperty.getCachedMethods()
CfnDistribution.CacheBehaviorProperty.Builder	cachePolicyId(String cachePolicyId)	Sets the value of CfnDistribution.CacheBehaviorProperty.getCachePolicyId()
CfnDistribution.CacheBehaviorProperty.Builder	compress(Boolean compress)	Sets the value of CfnDistribution.CacheBehaviorProperty.getCompress()
CfnDistribution.CacheBehaviorProperty.Builder	compress(IResolvable compress)	Sets the value of CfnDistribution.CacheBehaviorProperty.getCompress()
CfnDistribution.CacheBehaviorProperty.Builder	defaultTtl(Number defaultTtl)	Sets the value of CfnDistribution.CacheBehaviorProperty.getDefaultTtl()
CfnDistribution.CacheBehaviorProperty.Builder	fieldLevelEncryptionId(String fieldLevelEncryptionId)	Sets the value of CfnDistribution.CacheBehaviorProperty.getFieldLevelEncryptionId()
CfnDistribution.CacheBehaviorProperty.Builder	forwardedValues(IResolvable forwardedValues)	Sets the value of CfnDistribution.CacheBehaviorProperty.getForwardedValues()
CfnDistribution.CacheBehaviorProperty.Builder	forwardedValues(CfnDistribution.ForwardedValuesProperty forwardedValues)	Sets the value of CfnDistribution.CacheBehaviorProperty.getForwardedValues()
CfnDistribution.CacheBehaviorProperty.Builder	functionAssociations(List<? extends Object> functionAssociations)	Sets the value of CfnDistribution.CacheBehaviorProperty.getFunctionAssociations()
CfnDistribution.CacheBehaviorProperty.Builder	functionAssociations(IResolvable functionAssociations)	Sets the value of CfnDistribution.CacheBehaviorProperty.getFunctionAssociations()
CfnDistribution.CacheBehaviorProperty.Builder	lambdaFunctionAssociations(List<? extends Object> lambdaFunctionAssociations)	Sets the value of CfnDistribution.CacheBehaviorProperty.getLambdaFunctionAssociations()
CfnDistribution.CacheBehaviorProperty.Builder	lambdaFunctionAssociations(IResolvable lambdaFunctionAssociations)	Sets the value of CfnDistribution.CacheBehaviorProperty.getLambdaFunctionAssociations()
CfnDistribution.CacheBehaviorProperty.Builder	maxTtl(Number maxTtl)	Sets the value of CfnDistribution.CacheBehaviorProperty.getMaxTtl()
CfnDistribution.CacheBehaviorProperty.Builder	minTtl(Number minTtl)	Sets the value of CfnDistribution.CacheBehaviorProperty.getMinTtl()
CfnDistribution.CacheBehaviorProperty.Builder	originRequestPolicyId(String originRequestPolicyId)	Sets the value of CfnDistribution.CacheBehaviorProperty.getOriginRequestPolicyId()
CfnDistribution.CacheBehaviorProperty.Builder	pathPattern(String pathPattern)	Sets the value of CfnDistribution.CacheBehaviorProperty.getPathPattern()
CfnDistribution.CacheBehaviorProperty.Builder	realtimeLogConfigArn(String realtimeLogConfigArn)	Sets the value of CfnDistribution.CacheBehaviorProperty.getRealtimeLogConfigArn()
CfnDistribution.CacheBehaviorProperty.Builder	responseHeadersPolicyId(String responseHeadersPolicyId)	Sets the value of CfnDistribution.CacheBehaviorProperty.getResponseHeadersPolicyId()
CfnDistribution.CacheBehaviorProperty.Builder	smoothStreaming(Boolean smoothStreaming)	Sets the value of CfnDistribution.CacheBehaviorProperty.getSmoothStreaming()
CfnDistribution.CacheBehaviorProperty.Builder	smoothStreaming(IResolvable smoothStreaming)	Sets the value of CfnDistribution.CacheBehaviorProperty.getSmoothStreaming()
CfnDistribution.CacheBehaviorProperty.Builder	targetOriginId(String targetOriginId)	Sets the value of CfnDistribution.CacheBehaviorProperty.getTargetOriginId()
CfnDistribution.CacheBehaviorProperty.Builder	trustedKeyGroups(List<String> trustedKeyGroups)	Sets the value of CfnDistribution.CacheBehaviorProperty.getTrustedKeyGroups()
CfnDistribution.CacheBehaviorProperty.Builder	trustedSigners(List<String> trustedSigners)	Sets the value of CfnDistribution.CacheBehaviorProperty.getTrustedSigners()
CfnDistribution.CacheBehaviorProperty.Builder	viewerProtocolPolicy(String viewerProtocolPolicy)	Sets the value of CfnDistribution.CacheBehaviorProperty.getViewerProtocolPolicy()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

pathPattern

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder pathPattern(String pathPattern)

Sets the value of CfnDistribution.CacheBehaviorProperty.getPathPattern()

Parameters:

pathPattern - 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. This parameter is required.

You can optionally include a slash ( / ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide .

Returns:

this

targetOriginId

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder targetOriginId(String targetOriginId)

Sets the value of CfnDistribution.CacheBehaviorProperty.getTargetOriginId()

Parameters:

targetOriginId - The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior. This parameter is required.

Returns:

this

viewerProtocolPolicy

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder viewerProtocolPolicy(String viewerProtocolPolicy)

Sets the value of CfnDistribution.CacheBehaviorProperty.getViewerProtocolPolicy()

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 . This parameter is required. 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 .

Returns:

this

allowedMethods

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder allowedMethods(List<String> allowedMethods)

Sets the value of CfnDistribution.CacheBehaviorProperty.getAllowedMethods()

Parameters:

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

Returns:

this

cachedMethods

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder cachedMethods(List<String> cachedMethods)

Sets the value of CfnDistribution.CacheBehaviorProperty.getCachedMethods()

Parameters:

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

Returns:

this

cachePolicyId

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder cachePolicyId(String cachePolicyId)

Sets the value of CfnDistribution.CacheBehaviorProperty.getCachePolicyId()

Parameters:

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

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

Returns:

this

compress

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder compress(Boolean compress)

Sets the value of CfnDistribution.CacheBehaviorProperty.getCompress()

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:

this

compress

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder compress(IResolvable compress)

Sets the value of CfnDistribution.CacheBehaviorProperty.getCompress()

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:

this

defaultTtl

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder defaultTtl(Number defaultTtl)

Sets the value of CfnDistribution.CacheBehaviorProperty.getDefaultTtl()

Parameters:

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

Returns:

this

fieldLevelEncryptionId

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder fieldLevelEncryptionId(String fieldLevelEncryptionId)

Sets the value of CfnDistribution.CacheBehaviorProperty.getFieldLevelEncryptionId()

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 this cache behavior.

Returns:

this

forwardedValues

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder forwardedValues(IResolvable forwardedValues)

Sets the value of CfnDistribution.CacheBehaviorProperty.getForwardedValues()

Parameters:

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 .

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

Returns:

this

forwardedValues

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder forwardedValues(CfnDistribution.ForwardedValuesProperty forwardedValues)

Sets the value of CfnDistribution.CacheBehaviorProperty.getForwardedValues()

Parameters:

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 .

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

Returns:

this

functionAssociations

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder functionAssociations(IResolvable functionAssociations)

Sets the value of CfnDistribution.CacheBehaviorProperty.getFunctionAssociations()

Parameters:

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.

Returns:

this

functionAssociations

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder functionAssociations(List<? extends Object> functionAssociations)

Sets the value of CfnDistribution.CacheBehaviorProperty.getFunctionAssociations()

Parameters:

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.

Returns:

this

lambdaFunctionAssociations

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder lambdaFunctionAssociations(IResolvable lambdaFunctionAssociations)

Sets the value of CfnDistribution.CacheBehaviorProperty.getLambdaFunctionAssociations()

Parameters:

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

Returns:

this

lambdaFunctionAssociations

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder lambdaFunctionAssociations(List<? extends Object> lambdaFunctionAssociations)

Sets the value of CfnDistribution.CacheBehaviorProperty.getLambdaFunctionAssociations()

Parameters:

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

Returns:

this

maxTtl

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder maxTtl(Number maxTtl)

Sets the value of CfnDistribution.CacheBehaviorProperty.getMaxTtl()

Parameters:

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

Returns:

this

minTtl

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder minTtl(Number minTtl)

Sets the value of CfnDistribution.CacheBehaviorProperty.getMinTtl()

Parameters:

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

Returns:

this

originRequestPolicyId

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder originRequestPolicyId(String originRequestPolicyId)

Sets the value of CfnDistribution.CacheBehaviorProperty.getOriginRequestPolicyId()

Parameters:

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

Returns:

this

realtimeLogConfigArn

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder realtimeLogConfigArn(String realtimeLogConfigArn)

Sets the value of CfnDistribution.CacheBehaviorProperty.getRealtimeLogConfigArn()

Parameters:

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

Returns:

this

responseHeadersPolicyId

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder responseHeadersPolicyId(String responseHeadersPolicyId)

Sets the value of CfnDistribution.CacheBehaviorProperty.getResponseHeadersPolicyId()

Parameters:

responseHeadersPolicyId - The identifier for a response headers policy.

Returns:

this

smoothStreaming

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder smoothStreaming(Boolean smoothStreaming)

Sets the value of CfnDistribution.CacheBehaviorProperty.getSmoothStreaming()

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:

this

smoothStreaming

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder smoothStreaming(IResolvable smoothStreaming)

Sets the value of CfnDistribution.CacheBehaviorProperty.getSmoothStreaming()

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:

this

trustedKeyGroups

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder trustedKeyGroups(List<String> trustedKeyGroups)

Sets the value of CfnDistribution.CacheBehaviorProperty.getTrustedKeyGroups()

Parameters:

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

Returns:

this

trustedSigners

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty.Builder trustedSigners(List<String> trustedSigners)

Sets the value of CfnDistribution.CacheBehaviorProperty.getTrustedSigners()

Parameters:

trustedSigners -

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

Returns:

this

build

@Stability(Stable)
public CfnDistribution.CacheBehaviorProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDistribution.CacheBehaviorProperty>

Returns:

a new instance of CfnDistribution.CacheBehaviorProperty

Throws:

NullPointerException - if any required attribute was not provided