Package software.amazon.awscdk.services.cloudfront

Class CfnDistribution.OriginProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnDistribution.OriginProperty

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

A builder for CfnDistribution.OriginProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDistribution.OriginProperty	build()	Builds the configured instance.
CfnDistribution.OriginProperty.Builder	connectionAttempts(Number connectionAttempts)	Sets the value of CfnDistribution.OriginProperty.getConnectionAttempts()
CfnDistribution.OriginProperty.Builder	connectionTimeout(Number connectionTimeout)	Sets the value of CfnDistribution.OriginProperty.getConnectionTimeout()
CfnDistribution.OriginProperty.Builder	customOriginConfig(IResolvable customOriginConfig)	Sets the value of CfnDistribution.OriginProperty.getCustomOriginConfig()
CfnDistribution.OriginProperty.Builder	customOriginConfig(CfnDistribution.CustomOriginConfigProperty customOriginConfig)	Sets the value of CfnDistribution.OriginProperty.getCustomOriginConfig()
CfnDistribution.OriginProperty.Builder	domainName(String domainName)	Sets the value of CfnDistribution.OriginProperty.getDomainName()
CfnDistribution.OriginProperty.Builder	id(String id)	Sets the value of CfnDistribution.OriginProperty.getId()
CfnDistribution.OriginProperty.Builder	originAccessControlId(String originAccessControlId)	Sets the value of CfnDistribution.OriginProperty.getOriginAccessControlId()
CfnDistribution.OriginProperty.Builder	originCustomHeaders(List<? extends Object> originCustomHeaders)	Sets the value of CfnDistribution.OriginProperty.getOriginCustomHeaders()
CfnDistribution.OriginProperty.Builder	originCustomHeaders(IResolvable originCustomHeaders)	Sets the value of CfnDistribution.OriginProperty.getOriginCustomHeaders()
CfnDistribution.OriginProperty.Builder	originPath(String originPath)	Sets the value of CfnDistribution.OriginProperty.getOriginPath()
CfnDistribution.OriginProperty.Builder	originShield(IResolvable originShield)	Sets the value of CfnDistribution.OriginProperty.getOriginShield()
CfnDistribution.OriginProperty.Builder	originShield(CfnDistribution.OriginShieldProperty originShield)	Sets the value of CfnDistribution.OriginProperty.getOriginShield()
CfnDistribution.OriginProperty.Builder	s3OriginConfig(IResolvable s3OriginConfig)	Sets the value of CfnDistribution.OriginProperty.getS3OriginConfig()
CfnDistribution.OriginProperty.Builder	s3OriginConfig(CfnDistribution.S3OriginConfigProperty s3OriginConfig)	Sets the value of CfnDistribution.OriginProperty.getS3OriginConfig()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

domainName

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder domainName(String domainName)

Sets the value of CfnDistribution.OriginProperty.getDomainName()

Parameters:

domainName - The domain name for the origin. This parameter is required. For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .

Returns:

this

id

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder id(String id)

Sets the value of CfnDistribution.OriginProperty.getId()

Parameters:

id - A unique identifier for the origin. This value must be unique within the distribution. This parameter is required. Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .

Returns:

this

connectionAttempts

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder connectionAttempts(Number connectionAttempts)

Sets the value of CfnDistribution.OriginProperty.getConnectionAttempts()

Parameters:

connectionAttempts - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.

For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .

For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .

Returns:

this

connectionTimeout

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder connectionTimeout(Number connectionTimeout)

Sets the value of CfnDistribution.OriginProperty.getConnectionTimeout()

Parameters:

connectionTimeout - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.

For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .

Returns:

this

customOriginConfig

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder customOriginConfig(CfnDistribution.CustomOriginConfigProperty customOriginConfig)

Sets the value of CfnDistribution.OriginProperty.getCustomOriginConfig()

Parameters:

customOriginConfig - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.

Returns:

this

customOriginConfig

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder customOriginConfig(IResolvable customOriginConfig)

Sets the value of CfnDistribution.OriginProperty.getCustomOriginConfig()

Parameters:

customOriginConfig - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.

Returns:

this

originAccessControlId

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder originAccessControlId(String originAccessControlId)

Sets the value of CfnDistribution.OriginProperty.getOriginAccessControlId()

Parameters:

originAccessControlId - The unique identifier of an origin access control for this origin. For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .

Returns:

this

originCustomHeaders

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder originCustomHeaders(IResolvable originCustomHeaders)

Sets the value of CfnDistribution.OriginProperty.getOriginCustomHeaders()

Parameters:

originCustomHeaders - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .

Returns:

this

originCustomHeaders

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder originCustomHeaders(List<? extends Object> originCustomHeaders)

Sets the value of CfnDistribution.OriginProperty.getOriginCustomHeaders()

Parameters:

originCustomHeaders - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .

Returns:

this

originPath

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder originPath(String originPath)

Sets the value of CfnDistribution.OriginProperty.getOriginPath()

Parameters:

originPath - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see Origin Path in the Amazon CloudFront Developer Guide .

Returns:

this

originShield

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder originShield(IResolvable originShield)

Sets the value of CfnDistribution.OriginProperty.getOriginShield()

Parameters:

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

Returns:

this

originShield

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder originShield(CfnDistribution.OriginShieldProperty originShield)

Sets the value of CfnDistribution.OriginProperty.getOriginShield()

Parameters:

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

Returns:

this

s3OriginConfig

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder s3OriginConfig(CfnDistribution.S3OriginConfigProperty s3OriginConfig)

Sets the value of CfnDistribution.OriginProperty.getS3OriginConfig()

Parameters:

s3OriginConfig - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.

Returns:

this

s3OriginConfig

@Stability(Stable)
public CfnDistribution.OriginProperty.Builder s3OriginConfig(IResolvable s3OriginConfig)

Sets the value of CfnDistribution.OriginProperty.getS3OriginConfig()

Parameters:

s3OriginConfig - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.

Returns:

this

build

@Stability(Stable)
public CfnDistribution.OriginProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDistribution.OriginProperty

Throws:

NullPointerException - if any required attribute was not provided