public static interface CfnDistribution.CustomErrorResponseProperty
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cloudfront.*; CustomErrorResponseProperty customErrorResponseProperty = CustomErrorResponseProperty.builder() .errorCode(123) // the properties below are optional .errorCachingMinTtl(123) .responseCode(123) .responsePagePath("responsePagePath") .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnDistribution.CustomErrorResponseProperty.Builder
A builder for
CfnDistribution.CustomErrorResponseProperty |
static class |
CfnDistribution.CustomErrorResponseProperty.Jsii$Proxy
An implementation for
CfnDistribution.CustomErrorResponseProperty |
Modifier and Type | Method and Description |
---|---|
static CfnDistribution.CustomErrorResponseProperty.Builder |
builder() |
default java.lang.Number |
getErrorCachingMinTtl()
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in `ErrorCode` .
|
java.lang.Number |
getErrorCode()
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
|
default java.lang.Number |
getResponseCode()
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page.
|
default java.lang.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` .
|
java.lang.Number getErrorCode()
default java.lang.Number getErrorCachingMinTtl()
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 java.lang.Number getResponseCode()
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:
200
, the response typically won't be intercepted.400
or 500
as the ResponseCode
for all 4xx or 5xx errors.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
.
default java.lang.String getResponsePagePath()
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/*
.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.
static CfnDistribution.CustomErrorResponseProperty.Builder builder()