Package software.amazon.awscdk.services.cloudfront

Interface CfnDistribution.OriginShieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistribution.OriginShieldProperty.Jsii$Proxy

Enclosing class:

CfnDistribution

@Stability(Stable)
public static interface CfnDistribution.OriginShieldProperty
extends software.amazon.jsii.JsiiSerializable

CloudFront Origin Shield.

Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield 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.*;
 OriginShieldProperty originShieldProperty = OriginShieldProperty.builder()
         .enabled(false)
         .originShieldRegion("originShieldRegion")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDistribution.OriginShieldProperty.Builder	builder()
default Object	getEnabled()	A flag that specifies whether Origin Shield is enabled.
default String	getOriginShieldRegion()	The AWS Region for Origin Shield.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

A flag that specifies whether Origin Shield is enabled.

When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.

See Also:

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

getOriginShieldRegion

@Stability(Stable)
@Nullable
default String getOriginShieldRegion()

The AWS Region for Origin Shield.

Specify the AWS Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .

When you enable CloudFront Origin Shield, you must specify the AWS Region for Origin Shield. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the AWS Region for Origin Shield in the Amazon CloudFront Developer Guide .

See Also:

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

builder

@Stability(Stable)
static CfnDistribution.OriginShieldProperty.Builder builder()

Returns:

a CfnDistribution.OriginShieldProperty.Builder of CfnDistribution.OriginShieldProperty