Package software.amazon.awscdk.services.cloudfront

Interface CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty.Jsii$Proxy

Enclosing class:

CfnResponseHeadersPolicy

@Stability(Stable)
public static interface CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty
extends software.amazon.jsii.JsiiSerializable

A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.

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.*;
 ServerTimingHeadersConfigProperty serverTimingHeadersConfigProperty = ServerTimingHeadersConfigProperty.builder()
         .enabled(false)
         // the properties below are optional
         .samplingRate(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty.Builder	A builder for CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty
static final class	CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty.Jsii$Proxy	An implementation for CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty.Builder	builder()
Object	getEnabled()	A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
default Number	getSamplingRate()	A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html#cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-enabled

getSamplingRate

@Stability(Stable)
@Nullable
default Number getSamplingRate()

A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to.

When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html#cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-samplingrate

builder

@Stability(Stable)
static CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty.Builder builder()

Returns:

a CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty.Builder of CfnResponseHeadersPolicy.ServerTimingHeadersConfigProperty