software.amazon.awscdk.services.cloudfront

Class CfnDistribution.CustomErrorResponseProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnDistribution.CustomErrorResponseProperty

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

A builder for CfnDistribution.CustomErrorResponseProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDistribution.CustomErrorResponseProperty	build() Builds the configured instance.
CfnDistribution.CustomErrorResponseProperty.Builder	errorCachingMinTtl(Number errorCachingMinTtl) Sets the value of CfnDistribution.CustomErrorResponseProperty.getErrorCachingMinTtl()
CfnDistribution.CustomErrorResponseProperty.Builder	errorCode(Number errorCode) Sets the value of CfnDistribution.CustomErrorResponseProperty.getErrorCode()
CfnDistribution.CustomErrorResponseProperty.Builder	responseCode(Number responseCode) Sets the value of CfnDistribution.CustomErrorResponseProperty.getResponseCode()
CfnDistribution.CustomErrorResponseProperty.Builder	responsePagePath(String responsePagePath) Sets the value of CfnDistribution.CustomErrorResponseProperty.getResponsePagePath()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

errorCode

@Stability(value=Stable)
public CfnDistribution.CustomErrorResponseProperty.Builder errorCode(Number errorCode)

Sets the value of CfnDistribution.CustomErrorResponseProperty.getErrorCode()

Parameters:

errorCode - The HTTP status code for which you want to specify a custom error page and/or a caching duration. This parameter is required.

Returns:

this

errorCachingMinTtl

@Stability(value=Stable)
public CfnDistribution.CustomErrorResponseProperty.Builder errorCachingMinTtl(Number errorCachingMinTtl)

Sets the value of CfnDistribution.CustomErrorResponseProperty.getErrorCachingMinTtl()

Parameters:

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

Returns:

this

responseCode

@Stability(value=Stable)
public CfnDistribution.CustomErrorResponseProperty.Builder responseCode(Number responseCode)

Sets the value of CfnDistribution.CustomErrorResponseProperty.getResponseCode()

Parameters:

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

Returns:

this

responsePagePath

@Stability(value=Stable)
public CfnDistribution.CustomErrorResponseProperty.Builder responsePagePath(String responsePagePath)

Sets the value of CfnDistribution.CustomErrorResponseProperty.getResponsePagePath()

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public CfnDistribution.CustomErrorResponseProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDistribution.CustomErrorResponseProperty

Throws:

NullPointerException - if any required attribute was not provided