Package software.amazon.awscdk.cfnpropertymixins.services.cloudfront

Class CfnDistributionPropsMixin.OriginProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudfront.CfnDistributionPropsMixin.OriginProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnDistributionPropsMixin.OriginProperty

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

A builder for CfnDistributionPropsMixin.OriginProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

connectionAttempts

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

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder connectionTimeout(Number connectionTimeout)

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder customOriginConfig(IResolvable customOriginConfig)

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder customOriginConfig(CfnDistributionPropsMixin.CustomOriginConfigProperty customOriginConfig)

Sets the value of CfnDistributionPropsMixin.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

domainName

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

Sets the value of CfnDistributionPropsMixin.OriginProperty.getDomainName()

Parameters:

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

Returns:

this

domainName

@Stability(Stable)
public CfnDistributionPropsMixin.OriginProperty.Builder domainName(IDomainNameRef domainName)

Sets the value of CfnDistributionPropsMixin.OriginProperty.getDomainName()

Parameters:

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

Returns:

this

id

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

Sets the value of CfnDistributionPropsMixin.OriginProperty.getId()

Parameters:

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

Returns:

this

id

@Stability(Stable)
public CfnDistributionPropsMixin.OriginProperty.Builder id(ILoadBalancerRef id)

Sets the value of CfnDistributionPropsMixin.OriginProperty.getId()

Parameters:

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

Returns:

this

originAccessControlId

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

Sets the value of CfnDistributionPropsMixin.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

originAccessControlId

@Stability(Stable)
public CfnDistributionPropsMixin.OriginProperty.Builder originAccessControlId(IOriginAccessControlRef originAccessControlId)

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder originCustomHeaders(IResolvable originCustomHeaders)

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder originCustomHeaders(List<? extends Object> originCustomHeaders)

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder originPath(String originPath)

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder originShield(IResolvable originShield)

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder originShield(CfnDistributionPropsMixin.OriginShieldProperty originShield)

Sets the value of CfnDistributionPropsMixin.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

responseCompletionTimeout

@Stability(Stable)
public CfnDistributionPropsMixin.OriginProperty.Builder responseCompletionTimeout(Number responseCompletionTimeout)

Sets the value of CfnDistributionPropsMixin.OriginProperty.getResponseCompletionTimeout()

Parameters:

responseCompletionTimeout - The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.

The value for ResponseCompletionTimeout must be equal to or greater than the value for OriginReadTimeout . If you don't set a value for ResponseCompletionTimeout , CloudFront doesn't enforce a maximum value.

For more information, see Response completion timeout in the Amazon CloudFront Developer Guide .

Returns:

this

s3OriginConfig

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

Sets the value of CfnDistributionPropsMixin.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 CfnDistributionPropsMixin.OriginProperty.Builder s3OriginConfig(CfnDistributionPropsMixin.S3OriginConfigProperty s3OriginConfig)

Sets the value of CfnDistributionPropsMixin.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

vpcOriginConfig

@Stability(Stable)
public CfnDistributionPropsMixin.OriginProperty.Builder vpcOriginConfig(IResolvable vpcOriginConfig)

Sets the value of CfnDistributionPropsMixin.OriginProperty.getVpcOriginConfig()

Parameters:

vpcOriginConfig - The VPC origin configuration.

Returns:

this

vpcOriginConfig

@Stability(Stable)
public CfnDistributionPropsMixin.OriginProperty.Builder vpcOriginConfig(CfnDistributionPropsMixin.VpcOriginConfigProperty vpcOriginConfig)

Sets the value of CfnDistributionPropsMixin.OriginProperty.getVpcOriginConfig()

Parameters:

vpcOriginConfig - The VPC origin configuration.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDistributionPropsMixin.OriginProperty

Throws:

NullPointerException - if any required attribute was not provided