Package software.amazon.awscdk.services.cloudfront

Class CfnDistribution.CustomErrorResponseProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnDistribution.CustomErrorResponseProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDistribution.CustomErrorResponseProperty

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

An implementation for CfnDistribution.CustomErrorResponseProperty

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

CfnDistribution.CustomErrorResponseProperty.Builder, CfnDistribution.CustomErrorResponseProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDistribution.CustomErrorResponseProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDistribution.CustomErrorResponseProperty.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 Number	getErrorCachingMinTtl()	The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode .
final Number	getErrorCode()	The HTTP status code for which you want to specify a custom error page and/or a caching duration.
final Number	getResponseCode()	The HTTP status code that you want CloudFront to return to the viewer along with the custom error page.
final String	getResponsePagePath()	The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html .
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.CustomErrorResponseProperty.Builder builder)

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

Method Details

getErrorCode

public final Number getErrorCode()

Description copied from interface: CfnDistribution.CustomErrorResponseProperty

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

Specified by:

getErrorCode in interface CfnDistribution.CustomErrorResponseProperty

See Also:

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

getErrorCachingMinTtl

public final Number getErrorCachingMinTtl()

Description copied from interface: CfnDistribution.CustomErrorResponseProperty

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode .

When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .

Default: - 300

Specified by:

getErrorCachingMinTtl in interface CfnDistribution.CustomErrorResponseProperty

See Also:

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

getResponseCode

public final Number getResponseCode()

Description copied from interface: CfnDistribution.CustomErrorResponseProperty

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page.

There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

• Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200 , the response typically won't be intercepted.
• If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.
• You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .

Specified by:

getResponseCode in interface CfnDistribution.CustomErrorResponseProperty

See Also:

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

getResponsePagePath

public final String getResponsePagePath()

Description copied from interface: CfnDistribution.CustomErrorResponseProperty

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:.

• The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .
• The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

Specified by:

getResponsePagePath in interface CfnDistribution.CustomErrorResponseProperty

See Also:

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

$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