software.amazon.awscdk.services.cloudfront

Class ErrorResponse.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.ErrorResponse.Builder

Enclosing interface:

ErrorResponse

public static final class ErrorResponse.Builder
extends java.lang.Object

A builder for ErrorResponse

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ErrorResponse	build() Builds the configured instance.
ErrorResponse.Builder	httpStatus(java.lang.Number httpStatus) Sets the value of ErrorResponse.getHttpStatus()
ErrorResponse.Builder	responseHttpStatus(java.lang.Number responseHttpStatus) Sets the value of ErrorResponse.getResponseHttpStatus()
ErrorResponse.Builder	responsePagePath(java.lang.String responsePagePath) Sets the value of ErrorResponse.getResponsePagePath()
ErrorResponse.Builder	ttl(Duration ttl) Sets the value of ErrorResponse.getTtl()

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

httpStatus

public ErrorResponse.Builder httpStatus(java.lang.Number httpStatus)

Sets the value of ErrorResponse.getHttpStatus()

Parameters:

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

responseHttpStatus

public ErrorResponse.Builder responseHttpStatus(java.lang.Number responseHttpStatus)

Sets the value of ErrorResponse.getResponseHttpStatus()

Parameters:

responseHttpStatus - The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. If you specify a value for responseHttpStatus, you must also specify a value for responsePagePath.

Returns:

this

responsePagePath

public ErrorResponse.Builder responsePagePath(java.lang.String responsePagePath)

Sets the value of ErrorResponse.getResponsePagePath()

Parameters:

responsePagePath - The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the `httpStatus`, for example, /4xx-errors/403-forbidden.html.

Returns:

this

ttl

public ErrorResponse.Builder ttl(Duration ttl)

Sets the value of ErrorResponse.getTtl()

Parameters:

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

Returns:

this

build

public ErrorResponse build()

Builds the configured instance.

Returns:

a new instance of ErrorResponse

Throws:

java.lang.NullPointerException - if any required attribute was not provided