Package software.amazon.awscdk.services.lightsail

Class CfnDistribution.Builder

java.lang.Object

software.amazon.awscdk.services.lightsail.CfnDistribution.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDistribution>

Enclosing class:

CfnDistribution

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

A fluent builder for CfnDistribution.

Method Summary

Modifier and Type	Method	Description
CfnDistribution	build()
CfnDistribution.Builder	bundleId(String bundleId)	The ID of the bundle applied to the distribution.
CfnDistribution.Builder	cacheBehaviors(List<? extends Object> cacheBehaviors)	An array of objects that describe the per-path cache behavior of the distribution.
CfnDistribution.Builder	cacheBehaviors(IResolvable cacheBehaviors)	An array of objects that describe the per-path cache behavior of the distribution.
CfnDistribution.Builder	cacheBehaviorSettings(IResolvable cacheBehaviorSettings)	An object that describes the cache behavior settings of the distribution.
CfnDistribution.Builder	cacheBehaviorSettings(CfnDistribution.CacheSettingsProperty cacheBehaviorSettings)	An object that describes the cache behavior settings of the distribution.
CfnDistribution.Builder	certificateName(String certificateName)	The name of the SSL/TLS certificate attached to the distribution.
static CfnDistribution.Builder	create(software.constructs.Construct scope, String id)
CfnDistribution.Builder	defaultCacheBehavior(IResolvable defaultCacheBehavior)	An object that describes the default cache behavior of the distribution.
CfnDistribution.Builder	defaultCacheBehavior(CfnDistribution.CacheBehaviorProperty defaultCacheBehavior)	An object that describes the default cache behavior of the distribution.
CfnDistribution.Builder	distributionName(String distributionName)	The name of the distribution.
CfnDistribution.Builder	ipAddressType(String ipAddressType)	The IP address type of the distribution.
CfnDistribution.Builder	isEnabled(Boolean isEnabled)	A Boolean value indicating whether the distribution is enabled.
CfnDistribution.Builder	isEnabled(IResolvable isEnabled)	A Boolean value indicating whether the distribution is enabled.
CfnDistribution.Builder	origin(IResolvable origin)	An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
CfnDistribution.Builder	origin(CfnDistribution.InputOriginProperty origin)	An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
CfnDistribution.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnDistribution.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDistribution.Builder.

bundleId

@Stability(Stable)
public CfnDistribution.Builder bundleId(String bundleId)

The ID of the bundle applied to the distribution.

Parameters:

bundleId - The ID of the bundle applied to the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-bundleid

defaultCacheBehavior

@Stability(Stable)
public CfnDistribution.Builder defaultCacheBehavior(IResolvable defaultCacheBehavior)

An object that describes the default cache behavior of the distribution.

Parameters:

defaultCacheBehavior - An object that describes the default cache behavior of the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-defaultcachebehavior

defaultCacheBehavior

@Stability(Stable)
public CfnDistribution.Builder defaultCacheBehavior(CfnDistribution.CacheBehaviorProperty defaultCacheBehavior)

An object that describes the default cache behavior of the distribution.

Parameters:

defaultCacheBehavior - An object that describes the default cache behavior of the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-defaultcachebehavior

distributionName

@Stability(Stable)
public CfnDistribution.Builder distributionName(String distributionName)

The name of the distribution.

Parameters:

distributionName - The name of the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-distributionname

origin

@Stability(Stable)
public CfnDistribution.Builder origin(IResolvable origin)

An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

Parameters:

origin - An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-origin

origin

@Stability(Stable)
public CfnDistribution.Builder origin(CfnDistribution.InputOriginProperty origin)

An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

Parameters:

origin - An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-origin

cacheBehaviors

@Stability(Stable)
public CfnDistribution.Builder cacheBehaviors(IResolvable cacheBehaviors)

An array of objects that describe the per-path cache behavior of the distribution.

Parameters:

cacheBehaviors - An array of objects that describe the per-path cache behavior of the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-cachebehaviors

cacheBehaviors

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

An array of objects that describe the per-path cache behavior of the distribution.

Parameters:

cacheBehaviors - An array of objects that describe the per-path cache behavior of the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-cachebehaviors

cacheBehaviorSettings

@Stability(Stable)
public CfnDistribution.Builder cacheBehaviorSettings(IResolvable cacheBehaviorSettings)

An object that describes the cache behavior settings of the distribution.

Parameters:

cacheBehaviorSettings - An object that describes the cache behavior settings of the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-cachebehaviorsettings

cacheBehaviorSettings

@Stability(Stable)
public CfnDistribution.Builder cacheBehaviorSettings(CfnDistribution.CacheSettingsProperty cacheBehaviorSettings)

An object that describes the cache behavior settings of the distribution.

Parameters:

cacheBehaviorSettings - An object that describes the cache behavior settings of the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-cachebehaviorsettings

certificateName

@Stability(Stable)
public CfnDistribution.Builder certificateName(String certificateName)

The name of the SSL/TLS certificate attached to the distribution.

Parameters:

certificateName - The name of the SSL/TLS certificate attached to the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-certificatename

ipAddressType

@Stability(Stable)
public CfnDistribution.Builder ipAddressType(String ipAddressType)

The IP address type of the distribution.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

Parameters:

ipAddressType - The IP address type of the distribution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-ipaddresstype

isEnabled

@Stability(Stable)
public CfnDistribution.Builder isEnabled(Boolean isEnabled)

A Boolean value indicating whether the distribution is enabled.

Parameters:

isEnabled - A Boolean value indicating whether the distribution is enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-isenabled

isEnabled

@Stability(Stable)
public CfnDistribution.Builder isEnabled(IResolvable isEnabled)

A Boolean value indicating whether the distribution is enabled.

Parameters:

isEnabled - A Boolean value indicating whether the distribution is enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-isenabled

tags

@Stability(Stable)
public CfnDistribution.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag in the AWS CloudFormation User Guide .

The Value of Tags is optional for Lightsail resources.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-tags

build

@Stability(Stable)
public CfnDistribution build()

Specified by:

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

Returns:

a newly built instance of CfnDistribution.