Package software.amazon.awscdk.cfnpropertymixins.services.lightsail

Class CfnDistributionPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.lightsail.CfnDistributionPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:01.101Z")
@Stability(Stable)
public class CfnDistributionPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.lightsail.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDistributionPropsMixin cfnDistributionPropsMixin = CfnDistributionPropsMixin.Builder.create(CfnDistributionMixinProps.builder()
         .bundleId("bundleId")
         .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")
         .defaultCacheBehavior(CacheBehaviorProperty.builder()
                 .behavior("behavior")
                 .build())
         .distributionName("distributionName")
         .ipAddressType("ipAddressType")
         .isEnabled(false)
         .origin(InputOriginProperty.builder()
                 .name("name")
                 .protocolPolicy("protocolPolicy")
                 .regionName("regionName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDistributionPropsMixin.Builder	A fluent builder for CfnDistributionPropsMixin.
static interface	CfnDistributionPropsMixin.CacheBehaviorPerPathProperty	CacheBehaviorPerPath is a property of the AWS::Lightsail::Distribution resource.
static interface	CfnDistributionPropsMixin.CacheBehaviorProperty	CacheBehavior is a property of the AWS::Lightsail::Distribution resource.
static interface	CfnDistributionPropsMixin.CacheSettingsProperty	CacheSettings is a property of the AWS::Lightsail::Distribution resource.
static interface	CfnDistributionPropsMixin.CookieObjectProperty	CookieObject is a property of the CacheSettings property.
static interface	CfnDistributionPropsMixin.HeaderObjectProperty	HeaderObject is a property of the CacheSettings property.
static interface	CfnDistributionPropsMixin.InputOriginProperty	InputOrigin is a property of the AWS::Lightsail::Distribution resource.
static interface	CfnDistributionPropsMixin.QueryStringObjectProperty	QueryStringObject is a property of the CacheSettings property.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDistributionPropsMixin(CfnDistributionMixinProps props)	Create a mixin to apply properties to AWS::Lightsail::Distribution.
	CfnDistributionPropsMixin(CfnDistributionMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Lightsail::Distribution.
protected	CfnDistributionPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDistributionPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDistributionMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDistributionPropsMixin

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

CfnDistributionPropsMixin

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

CfnDistributionPropsMixin

@Stability(Stable)
public CfnDistributionPropsMixin(@NotNull
 CfnDistributionMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Lightsail::Distribution.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDistributionPropsMixin

@Stability(Stable)
public CfnDistributionPropsMixin(@NotNull
 CfnDistributionMixinProps props)

Create a mixin to apply properties to AWS::Lightsail::Distribution.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDistributionMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()