Class CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDistributionPropsMixin.DefaultCacheBehaviorProperty>
- Enclosing interface:
CfnDistributionPropsMixin.DefaultCacheBehaviorProperty
CfnDistributionPropsMixin.DefaultCacheBehaviorProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallowedMethods(List<String> allowedMethods) build()Builds the configured instance.cachedMethods(List<String> cachedMethods) cachePolicyId(String cachePolicyId) cachePolicyId(ICachePolicyRef cachePolicyId) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getCompress()compress(IResolvable compress) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getCompress()defaultTtl(Number defaultTtl) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getDefaultTtl()fieldLevelEncryptionId(String fieldLevelEncryptionId) forwardedValues(CfnDistributionPropsMixin.ForwardedValuesProperty forwardedValues) forwardedValues(IResolvable forwardedValues) functionAssociations(List<? extends Object> functionAssociations) functionAssociations(IResolvable functionAssociations) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getGrpcConfig()grpcConfig(IResolvable grpcConfig) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getGrpcConfig()lambdaFunctionAssociations(List<? extends Object> lambdaFunctionAssociations) lambdaFunctionAssociations(IResolvable lambdaFunctionAssociations) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getMaxTtl()Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getMinTtl()originRequestPolicyId(String originRequestPolicyId) originRequestPolicyId(IOriginRequestPolicyRef originRequestPolicyId) realtimeLogConfigArn(String realtimeLogConfigArn) realtimeLogConfigArn(IRealtimeLogConfigRef realtimeLogConfigArn) responseHeadersPolicyId(String responseHeadersPolicyId) responseHeadersPolicyId(IResponseHeadersPolicyRef responseHeadersPolicyId) smoothStreaming(Boolean smoothStreaming) smoothStreaming(IResolvable smoothStreaming) targetOriginId(String targetOriginId) targetOriginId(ILoadBalancerRef targetOriginId) trustedKeyGroups(List<? extends Object> trustedKeyGroups) trustedSigners(List<String> trustedSigners) viewerProtocolPolicy(String viewerProtocolPolicy)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowedMethods
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder allowedMethods(List<String> allowedMethods) - 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
GETandHEADrequests. - CloudFront forwards only
GET,HEAD, andOPTIONSrequests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.
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.
- CloudFront forwards only
- Returns:
this
-
cachedMethods
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder cachedMethods(List<String> cachedMethods) - 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
GETandHEADrequests. - CloudFront caches responses to
GET,HEAD, andOPTIONSrequests.
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.
- CloudFront caches responses to
- Returns:
this
-
cachePolicyId
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder cachePolicyId(String cachePolicyId) - Parameters:
cachePolicyId- 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
DefaultCacheBehaviormust include either aCachePolicyIdorForwardedValues. We recommend that you use aCachePolicyId.- Returns:
this
-
cachePolicyId
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder cachePolicyId(ICachePolicyRef cachePolicyId) - Parameters:
cachePolicyId- 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
DefaultCacheBehaviormust include either aCachePolicyIdorForwardedValues. We recommend that you use aCachePolicyId.- Returns:
this
-
compress
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder compress(Boolean compress) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getCompress()- Parameters:
compress- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specifytrue; if not, specifyfalse. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .- Returns:
this
-
compress
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder compress(IResolvable compress) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getCompress()- Parameters:
compress- Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specifytrue; if not, specifyfalse. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .- Returns:
this
-
defaultTtl
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder defaultTtl(Number defaultTtl) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getDefaultTtl()- Parameters:
defaultTtl-
You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide .This field only supports standard distributions.
This field is deprecated. We recommend that you use the
DefaultTTLfield 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, andExpiresto 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 CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder fieldLevelEncryptionId(String fieldLevelEncryptionId) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getFieldLevelEncryptionId()- Parameters:
fieldLevelEncryptionId- The value ofIDfor the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.- Returns:
this
-
forwardedValues
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder forwardedValues(IResolvable forwardedValues) - 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
DefaultCacheBehaviormust include either aCachePolicyIdorForwardedValues. We recommend that you use aCachePolicyId.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
- Returns:
this
-
forwardedValues
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder forwardedValues(CfnDistributionPropsMixin.ForwardedValuesProperty forwardedValues) - 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
DefaultCacheBehaviormust include either aCachePolicyIdorForwardedValues. We recommend that you use aCachePolicyId.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
- Returns:
this
-
functionAssociations
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder functionAssociations(IResolvable functionAssociations) - Parameters:
functionAssociations- A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to theLIVEstage to associate them with a cache behavior.- Returns:
this
-
functionAssociations
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder functionAssociations(List<? extends Object> functionAssociations) - Parameters:
functionAssociations- A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to theLIVEstage to associate them with a cache behavior.- Returns:
this
-
grpcConfig
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder grpcConfig(IResolvable grpcConfig) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getGrpcConfig()- Parameters:
grpcConfig- The gRPC configuration for your cache behavior.- Returns:
this
-
grpcConfig
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder grpcConfig(CfnDistributionPropsMixin.GrpcConfigProperty grpcConfig) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getGrpcConfig()- Parameters:
grpcConfig- The gRPC configuration for your cache behavior.- Returns:
this
-
lambdaFunctionAssociations
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder lambdaFunctionAssociations(IResolvable lambdaFunctionAssociations) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.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 CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder lambdaFunctionAssociations(List<? extends Object> lambdaFunctionAssociations) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.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 CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder maxTtl(Number maxTtl) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getMaxTtl()- Parameters:
maxTtl-
You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide .This field only supports standard distributions.
This field is deprecated. We recommend that you use the
MaxTTLfield 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, andExpiresto 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 CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder minTtl(Number minTtl) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getMinTtl()- Parameters:
minTtl-
You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide .This field only supports standard distributions.
This field is deprecated. We recommend that you use the
MinTTLfield 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
0forMinTTLif you configure CloudFront to forward all headers to your origin (underHeaders, if you specify1forQuantityand*forName).- Returns:
this
-
originRequestPolicyId
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder originRequestPolicyId(String originRequestPolicyId) - Parameters:
originRequestPolicyId- 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 .- Returns:
this
-
originRequestPolicyId
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder originRequestPolicyId(IOriginRequestPolicyRef originRequestPolicyId) - Parameters:
originRequestPolicyId- 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 .- Returns:
this
-
realtimeLogConfigArn
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder realtimeLogConfigArn(String realtimeLogConfigArn) - 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
-
realtimeLogConfigArn
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder realtimeLogConfigArn(IRealtimeLogConfigRef realtimeLogConfigArn) - 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 CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder responseHeadersPolicyId(String responseHeadersPolicyId) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getResponseHeadersPolicyId()- Parameters:
responseHeadersPolicyId- The identifier for a response headers policy.- Returns:
this
-
responseHeadersPolicyId
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder responseHeadersPolicyId(IResponseHeadersPolicyRef responseHeadersPolicyId) Sets the value ofCfnDistributionPropsMixin.DefaultCacheBehaviorProperty.getResponseHeadersPolicyId()- Parameters:
responseHeadersPolicyId- The identifier for a response headers policy.- Returns:
this
-
smoothStreaming
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder smoothStreaming(Boolean smoothStreaming) - Parameters:
smoothStreaming-
You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide .This field only supports standard distributions.
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, specifyfalse. If you specifytrueforSmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern.- Returns:
this
-
smoothStreaming
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder smoothStreaming(IResolvable smoothStreaming) - Parameters:
smoothStreaming-
You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide .This field only supports standard distributions.
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, specifyfalse. If you specifytrueforSmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern.- Returns:
this
-
targetOriginId
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder targetOriginId(String targetOriginId) - Parameters:
targetOriginId- The value ofIDfor the origin that you want CloudFront to route requests to when they use the default cache behavior.- Returns:
this
-
targetOriginId
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder targetOriginId(ILoadBalancerRef targetOriginId) - Parameters:
targetOriginId- The value ofIDfor the origin that you want CloudFront to route requests to when they use the default cache behavior.- Returns:
this
-
trustedKeyGroups
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder trustedKeyGroups(List<? extends Object> trustedKeyGroups) - 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 CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder trustedSigners(List<String> trustedSigners) - Parameters:
trustedSigners-We recommend using
TrustedKeyGroupsinstead ofTrustedSigners.This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide .
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 .
- Returns:
this
-
viewerProtocolPolicy
@Stability(Stable) public CfnDistributionPropsMixin.DefaultCacheBehaviorProperty.Builder viewerProtocolPolicy(String viewerProtocolPolicy) - Parameters:
viewerProtocolPolicy- The protocol that viewers can use to access the files in the origin specified byTargetOriginIdwhen a request matches the path pattern inPathPattern. 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
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDistributionPropsMixin.DefaultCacheBehaviorProperty>- Returns:
- a new instance of
CfnDistributionPropsMixin.DefaultCacheBehaviorProperty - Throws:
NullPointerException- if any required attribute was not provided
-