software.amazon.awscdk.services.lightsail

Class CfnDistribution

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lightsail.CfnDistribution

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.655Z")
 @Stability(value=Stable)
public class CfnDistribution
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lightsail::Distribution`.

The AWS::Lightsail::Distribution resource specifies a content delivery network (CDN) distribution. You can create distributions only in the us-east-1 AWS Region.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance, static content hosted on a Lightsail bucket, or through a Lightsail load balancer.

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.lightsail.*;
 CfnDistribution cfnDistribution = CfnDistribution.Builder.create(this, "MyCfnDistribution")
         .bundleId("bundleId")
         .defaultCacheBehavior(CacheBehaviorProperty.builder()
                 .behavior("behavior")
                 .build())
         .distributionName("distributionName")
         .origin(InputOriginProperty.builder()
                 .name("name")
                 .protocolPolicy("protocolPolicy")
                 .regionName("regionName")
                 .build())
         // the properties below are optional
         .cacheBehaviors(List.of(CacheBehaviorPerPathProperty.builder()
                 .behavior("behavior")
                 .path("path")
                 .build()))
         .cacheBehaviorSettings(CacheSettingsProperty.builder()
                 .allowedHttpMethods("allowedHttpMethods")
                 .cachedHttpMethods("cachedHttpMethods")
                 .defaultTtl(123)
                 .forwardedCookies(CookieObjectProperty.builder()
                         .cookiesAllowList(List.of("cookiesAllowList"))
                         .option("option")
                         .build())
                 .forwardedHeaders(HeaderObjectProperty.builder()
                         .headersAllowList(List.of("headersAllowList"))
                         .option("option")
                         .build())
                 .forwardedQueryStrings(QueryStringObjectProperty.builder()
                         .option(false)
                         .queryStringsAllowList(List.of("queryStringsAllowList"))
                         .build())
                 .maximumTtl(123)
                 .minimumTtl(123)
                 .build())
         .certificateName("certificateName")
         .ipAddressType("ipAddressType")
         .isEnabled(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDistribution.Builder A fluent builder for CfnDistribution.
static interface	CfnDistribution.CacheBehaviorPerPathProperty `CacheBehaviorPerPath` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource.
static interface	CfnDistribution.CacheBehaviorProperty `CacheBehavior` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource.
static interface	CfnDistribution.CacheSettingsProperty `CacheSettings` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource.
static interface	CfnDistribution.CookieObjectProperty `CookieObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property.
static interface	CfnDistribution.HeaderObjectProperty `HeaderObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property.
static interface	CfnDistribution.InputOriginProperty `InputOrigin` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource.
static interface	CfnDistribution.QueryStringObjectProperty `QueryStringObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDistribution(software.constructs.Construct scope, String id, CfnDistributionProps props) Create a new `AWS::Lightsail::Distribution`.
protected	CfnDistribution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDistribution(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IResolvable	getAttrAbleToUpdateBundle() Indicates whether you can update the distribution’s current bundle to another bundle.
String	getAttrDistributionArn() The Amazon Resource Name (ARN) of the distribution.
String	getAttrStatus() The status of the distribution.
String	getBundleId() The ID of the bundle applied to the distribution.
Object	getCacheBehaviors() An array of objects that describe the per-path cache behavior of the distribution.
Object	getCacheBehaviorSettings() An object that describes the cache behavior settings of the distribution.
String	getCertificateName() The name of the SSL/TLS certificate attached to the distribution.
protected Map<String,Object>	getCfnProperties()
Object	getDefaultCacheBehavior() An object that describes the default cache behavior of the distribution.
String	getDistributionName() The name of the distribution.
String	getIpAddressType() The IP address type of the distribution.
Object	getIsEnabled() A Boolean value indicating whether the distribution is enabled.
Object	getOrigin() An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBundleId(String value) The ID of the bundle applied to the distribution.
void	setCacheBehaviors(IResolvable value) An array of objects that describe the per-path cache behavior of the distribution.
void	setCacheBehaviors(List<Object> value) An array of objects that describe the per-path cache behavior of the distribution.
void	setCacheBehaviorSettings(CfnDistribution.CacheSettingsProperty value) An object that describes the cache behavior settings of the distribution.
void	setCacheBehaviorSettings(IResolvable value) An object that describes the cache behavior settings of the distribution.
void	setCertificateName(String value) The name of the SSL/TLS certificate attached to the distribution.
void	setDefaultCacheBehavior(CfnDistribution.CacheBehaviorProperty value) An object that describes the default cache behavior of the distribution.
void	setDefaultCacheBehavior(IResolvable value) An object that describes the default cache behavior of the distribution.
void	setDistributionName(String value) The name of the distribution.
void	setIpAddressType(String value) The IP address type of the distribution.
void	setIsEnabled(Boolean value) A Boolean value indicating whether the distribution is enabled.
void	setIsEnabled(IResolvable value) A Boolean value indicating whether the distribution is enabled.
void	setOrigin(CfnDistribution.InputOriginProperty value) An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
void	setOrigin(IResolvable value) An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDistribution

protected CfnDistribution(software.amazon.jsii.JsiiObjectRef objRef)

CfnDistribution

protected CfnDistribution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDistribution

@Stability(value=Stable)
public CfnDistribution(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnDistributionProps props)

Create a new `AWS::Lightsail::Distribution`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAbleToUpdateBundle

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrAbleToUpdateBundle()

Indicates whether you can update the distribution’s current bundle to another bundle.

getAttrDistributionArn

@Stability(value=Stable)
 @NotNull
public String getAttrDistributionArn()

The Amazon Resource Name (ARN) of the distribution.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The status of the distribution.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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.

getBundleId

@Stability(value=Stable)
 @NotNull
public String getBundleId()

The ID of the bundle applied to the distribution.

setBundleId

@Stability(value=Stable)
public void setBundleId(@NotNull
                                                 String value)

The ID of the bundle applied to the distribution.

getDefaultCacheBehavior

@Stability(value=Stable)
 @NotNull
public Object getDefaultCacheBehavior()

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

setDefaultCacheBehavior

@Stability(value=Stable)
public void setDefaultCacheBehavior(@NotNull
                                                             CfnDistribution.CacheBehaviorProperty value)

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

setDefaultCacheBehavior

@Stability(value=Stable)
public void setDefaultCacheBehavior(@NotNull
                                                             IResolvable value)

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

getDistributionName

@Stability(value=Stable)
 @NotNull
public String getDistributionName()

The name of the distribution.

setDistributionName

@Stability(value=Stable)
public void setDistributionName(@NotNull
                                                         String value)

The name of the distribution.

getOrigin

@Stability(value=Stable)
 @NotNull
public Object getOrigin()

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.

setOrigin

@Stability(value=Stable)
public void setOrigin(@NotNull
                                               CfnDistribution.InputOriginProperty value)

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.

setOrigin

@Stability(value=Stable)
public void setOrigin(@NotNull
                                               IResolvable value)

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.

getCacheBehaviors

@Stability(value=Stable)
 @Nullable
public Object getCacheBehaviors()

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

setCacheBehaviors

@Stability(value=Stable)
public void setCacheBehaviors(@Nullable
                                                       IResolvable value)

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

setCacheBehaviors

@Stability(value=Stable)
public void setCacheBehaviors(@Nullable
                                                       List<Object> value)

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

getCacheBehaviorSettings

@Stability(value=Stable)
 @Nullable
public Object getCacheBehaviorSettings()

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

setCacheBehaviorSettings

@Stability(value=Stable)
public void setCacheBehaviorSettings(@Nullable
                                                              CfnDistribution.CacheSettingsProperty value)

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

setCacheBehaviorSettings

@Stability(value=Stable)
public void setCacheBehaviorSettings(@Nullable
                                                              IResolvable value)

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

getCertificateName

@Stability(value=Stable)
 @Nullable
public String getCertificateName()

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

setCertificateName

@Stability(value=Stable)
public void setCertificateName(@Nullable
                                                        String value)

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

getIpAddressType

@Stability(value=Stable)
 @Nullable
public String getIpAddressType()

The IP address type of the distribution.

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

setIpAddressType

@Stability(value=Stable)
public void setIpAddressType(@Nullable
                                                      String value)

The IP address type of the distribution.

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

getIsEnabled

@Stability(value=Stable)
 @Nullable
public Object getIsEnabled()

A Boolean value indicating whether the distribution is enabled.

setIsEnabled

@Stability(value=Stable)
public void setIsEnabled(@Nullable
                                                  Boolean value)

A Boolean value indicating whether the distribution is enabled.

setIsEnabled

@Stability(value=Stable)
public void setIsEnabled(@Nullable
                                                  IResolvable value)

A Boolean value indicating whether the distribution is enabled.