CfnDistribution

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.lightsail.CfnDistribution

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.856Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDistribution(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IResolvable`	`getAttrAbleToUpdateBundle()` Indicates whether you can update the distribution’s current bundle to another bundle.
`java.lang.String`	`getAttrDistributionArn()` The Amazon Resource Name (ARN) of the distribution.
`java.lang.String`	`getAttrStatus()` The status of the distribution.
`java.lang.String`	`getBundleId()` The ID of the bundle applied to the distribution.
`java.lang.Object`	`getCacheBehaviors()` An array of objects that describe the per-path cache behavior of the distribution.
`java.lang.Object`	`getCacheBehaviorSettings()` An object that describes the cache behavior settings of the distribution.
`java.lang.String`	`getCertificateName()` The name of the SSL/TLS certificate attached to the distribution.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getDefaultCacheBehavior()` An object that describes the default cache behavior of the distribution.
`java.lang.String`	`getDistributionName()` The name of the distribution.
`java.lang.String`	`getIpAddressType()` The IP address type of the distribution.
`java.lang.Object`	`getIsEnabled()` A Boolean value indicating whether the distribution is enabled.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setBundleId(java.lang.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(java.util.List<java.lang.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(java.lang.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(java.lang.String value)` The name of the distribution.
`void`	`setIpAddressType(java.lang.String value)` The IP address type of the distribution.
`void`	`setIsEnabled(java.lang.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.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnDistribution(Construct scope,
                       java.lang.String id,
                       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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrAbleToUpdateBundle
```
public IResolvable getAttrAbleToUpdateBundle()
```
    Indicates whether you can update the distribution’s current bundle to another bundle.
  - getAttrDistributionArn
```
public java.lang.String getAttrDistributionArn()
```
    The Amazon Resource Name (ARN) of the distribution.
  - getAttrStatus
```
public java.lang.String getAttrStatus()
```
    The status of the distribution.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
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
```
public java.lang.String getBundleId()
```
    The ID of the bundle applied to the distribution.
  - setBundleId
```
public void setBundleId(java.lang.String value)
```
    The ID of the bundle applied to the distribution.
  - getDefaultCacheBehavior
```
public java.lang.Object getDefaultCacheBehavior()
```
    An object that describes the default cache behavior of the distribution.
  - setDefaultCacheBehavior
```
public void setDefaultCacheBehavior(IResolvable value)
```
    An object that describes the default cache behavior of the distribution.
  - setDefaultCacheBehavior
```
public void setDefaultCacheBehavior(CfnDistribution.CacheBehaviorProperty value)
```
    An object that describes the default cache behavior of the distribution.
  - getDistributionName
```
public java.lang.String getDistributionName()
```
    The name of the distribution.
  - setDistributionName
```
public void setDistributionName(java.lang.String value)
```
    The name of the distribution.
  - getOrigin
```
public java.lang.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
```
public void setOrigin(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.
  - setOrigin
```
public void setOrigin(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.
  - getCacheBehaviors
```
public java.lang.Object getCacheBehaviors()
```
    An array of objects that describe the per-path cache behavior of the distribution.
  - setCacheBehaviors
```
public void setCacheBehaviors(IResolvable value)
```
    An array of objects that describe the per-path cache behavior of the distribution.
  - setCacheBehaviors
```
public void setCacheBehaviors(java.util.List<java.lang.Object> value)
```
    An array of objects that describe the per-path cache behavior of the distribution.
  - getCacheBehaviorSettings
```
public java.lang.Object getCacheBehaviorSettings()
```
    An object that describes the cache behavior settings of the distribution.
  - setCacheBehaviorSettings
```
public void setCacheBehaviorSettings(IResolvable value)
```
    An object that describes the cache behavior settings of the distribution.
  - setCacheBehaviorSettings
```
public void setCacheBehaviorSettings(CfnDistribution.CacheSettingsProperty value)
```
    An object that describes the cache behavior settings of the distribution.
  - getCertificateName
```
public java.lang.String getCertificateName()
```
    The name of the SSL/TLS certificate attached to the distribution.
  - setCertificateName
```
public void setCertificateName(java.lang.String value)
```
    The name of the SSL/TLS certificate attached to the distribution.
  - getIpAddressType
```
public java.lang.String getIpAddressType()
```
    The IP address type of the distribution.
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
  - setIpAddressType
```
public void setIpAddressType(java.lang.String value)
```
    The IP address type of the distribution.
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
  - getIsEnabled
```
public java.lang.Object getIsEnabled()
```
    A Boolean value indicating whether the distribution is enabled.
  - setIsEnabled
```
public void setIsEnabled(java.lang.Boolean value)
```
    A Boolean value indicating whether the distribution is enabled.
  - setIsEnabled
```
public void setIsEnabled(IResolvable value)
```
    A Boolean value indicating whether the distribution is enabled.

Class CfnDistribution

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDistribution

CfnDistribution

CfnDistribution

Method Detail

inspect

renderProperties

getAttrAbleToUpdateBundle

getAttrDistributionArn

getAttrStatus

getCfnProperties

getTags

getBundleId

setBundleId

getDefaultCacheBehavior

setDefaultCacheBehavior

setDefaultCacheBehavior

getDistributionName

setDistributionName

getOrigin

setOrigin

setOrigin

getCacheBehaviors

setCacheBehaviors

setCacheBehaviors

getCacheBehaviorSettings

setCacheBehaviorSettings

setCacheBehaviorSettings

getCertificateName

setCertificateName

getIpAddressType

setIpAddressType

getIsEnabled

setIsEnabled

setIsEnabled