Package software.amazon.awscdk.services.cloudfront

Class CfnDistribution.CacheBehaviorProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudfront.CfnDistribution.CacheBehaviorProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDistribution.CacheBehaviorProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDistribution.CacheBehaviorProperty

@Stability(Stable)
@Internal
public static final class CfnDistribution.CacheBehaviorProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDistribution.CacheBehaviorProperty

An implementation for CfnDistribution.CacheBehaviorProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudfront.CfnDistribution.CacheBehaviorProperty

CfnDistribution.CacheBehaviorProperty.Builder, CfnDistribution.CacheBehaviorProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDistribution.CacheBehaviorProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDistribution.CacheBehaviorProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getAllowedMethods()	A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.
final List<String>	getCachedMethods()	A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods.
final String	getCachePolicyId()	The unique identifier of the cache policy that is attached to this cache behavior.
final Object	getCompress()	Whether you want CloudFront to automatically compress certain files for this cache behavior.
final Number	getDefaultTtl()	This field is deprecated.
final String	getFieldLevelEncryptionId()	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.
final Object	getForwardedValues()	This field is deprecated.
final Object	getFunctionAssociations()	A list of CloudFront functions that are associated with this cache behavior.
final Object	getLambdaFunctionAssociations()	A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
final Number	getMaxTtl()	This field is deprecated.
final Number	getMinTtl()	This field is deprecated.
final String	getOriginRequestPolicyId()	The unique identifier of the origin request policy that is attached to this cache behavior.
final String	getPathPattern()	The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to.
final String	getRealtimeLogConfigArn()	The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior.
final String	getResponseHeadersPolicyId()	The identifier for a response headers policy.
final Object	getSmoothStreaming()	Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.
final String	getTargetOriginId()	The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
final List<String>	getTrustedKeyGroups()	A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
final List<String>	getTrustedSigners()
final String	getViewerProtocolPolicy()	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 .
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDistribution.CacheBehaviorProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDistribution.CacheBehaviorProperty.Builder.

Method Details

getPathPattern

public final String getPathPattern()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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.

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 .

Specified by:

getPathPattern in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-pathpattern

getTargetOriginId

public final String getTargetOriginId()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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

Specified by:

getTargetOriginId in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-targetoriginid

getViewerProtocolPolicy

public final String getViewerProtocolPolicy()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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

Specified by:

getViewerProtocolPolicy in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-viewerprotocolpolicy

getAllowedMethods

public final List<String> getAllowedMethods()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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.

Specified by:

getAllowedMethods in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-allowedmethods

getCachedMethods

public final List<String> getCachedMethods()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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.

Specified by:

getCachedMethods in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-cachedmethods

getCachePolicyId

public final String getCachePolicyId()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Specified by:

getCachePolicyId in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-cachepolicyid

getCompress

public final Object getCompress()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Default: - false

Specified by:

getCompress in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-compress

getDefaultTtl

public final Number getDefaultTtl()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Default: - 86400

Specified by:

getDefaultTtl in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-defaultttl

getFieldLevelEncryptionId

public final String getFieldLevelEncryptionId()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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.

Default: - ""

Specified by:

getFieldLevelEncryptionId in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-fieldlevelencryptionid

getForwardedValues

public final Object getForwardedValues()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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.

Specified by:

getForwardedValues in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-forwardedvalues

getFunctionAssociations

public final Object getFunctionAssociations()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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.

Specified by:

getFunctionAssociations in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-functionassociations

getLambdaFunctionAssociations

public final Object getLambdaFunctionAssociations()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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

Specified by:

getLambdaFunctionAssociations in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-lambdafunctionassociations

getMaxTtl

public final Number getMaxTtl()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Default: - 31536000

Specified by:

getMaxTtl in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-maxttl

getMinTtl

public final Number getMinTtl()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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

Default: - 0

Specified by:

getMinTtl in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-minttl

getOriginRequestPolicyId

public final String getOriginRequestPolicyId()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Specified by:

getOriginRequestPolicyId in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-originrequestpolicyid

getRealtimeLogConfigArn

public final String getRealtimeLogConfigArn()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Specified by:

getRealtimeLogConfigArn in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-realtimelogconfigarn

getResponseHeadersPolicyId

public final String getResponseHeadersPolicyId()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

The identifier for a response headers policy.

Specified by:

getResponseHeadersPolicyId in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-responseheaderspolicyid

getSmoothStreaming

public final Object getSmoothStreaming()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Default: - false

Specified by:

getSmoothStreaming in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-smoothstreaming

getTrustedKeyGroups

public final List<String> getTrustedKeyGroups()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Specified by:

getTrustedKeyGroups in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-trustedkeygroups

getTrustedSigners

public final List<String> getTrustedSigners()

Description copied from interface: CfnDistribution.CacheBehaviorProperty

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 .

Specified by:

getTrustedSigners in interface CfnDistribution.CacheBehaviorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-trustedsigners

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object