Package software.amazon.awscdk.services.lightsail

Interface CfnDistributionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistributionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:41.593Z")
@Stability(Stable)
public interface CfnDistributionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDistribution.

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.*;
 CfnDistributionProps cfnDistributionProps = CfnDistributionProps.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDistributionProps.Builder	A builder for CfnDistributionProps
static final class	CfnDistributionProps.Jsii$Proxy	An implementation for CfnDistributionProps

Method Summary

Modifier and Type	Method	Description
static CfnDistributionProps.Builder	builder()
String	getBundleId()	The ID of the bundle applied to the distribution.
default Object	getCacheBehaviors()	An array of objects that describe the per-path cache behavior of the distribution.
default Object	getCacheBehaviorSettings()	An object that describes the cache behavior settings of the distribution.
default String	getCertificateName()	The name of the SSL/TLS certificate attached to the distribution.
Object	getDefaultCacheBehavior()	An object that describes the default cache behavior of the distribution.
String	getDistributionName()	The name of the distribution.
default String	getIpAddressType()	The IP address type of the distribution.
default 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.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBundleId

@Stability(Stable)
@NotNull
String getBundleId()

The ID of the bundle applied to the distribution.

See Also:

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

getDefaultCacheBehavior

@Stability(Stable)
@NotNull
Object getDefaultCacheBehavior()

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

Returns union: either IResolvable or CfnDistribution.CacheBehaviorProperty

See Also:

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

getDistributionName

@Stability(Stable)
@NotNull
String getDistributionName()

The name of the distribution.

See Also:

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

getOrigin

@Stability(Stable)
@NotNull
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.

Returns union: either IResolvable or CfnDistribution.InputOriginProperty

See Also:

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

getCacheBehaviors

@Stability(Stable)
@Nullable
default Object getCacheBehaviors()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDistribution.CacheBehaviorPerPathProperty>

See Also:

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

getCacheBehaviorSettings

@Stability(Stable)
@Nullable
default Object getCacheBehaviorSettings()

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

Returns union: either IResolvable or CfnDistribution.CacheSettingsProperty

See Also:

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

getCertificateName

@Stability(Stable)
@Nullable
default String getCertificateName()

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

See Also:

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

getIpAddressType

@Stability(Stable)
@Nullable
default String getIpAddressType()

The IP address type of the distribution.

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

See Also:

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

getIsEnabled

@Stability(Stable)
@Nullable
default Object getIsEnabled()

A Boolean value indicating whether the distribution is enabled.

Returns union: either Boolean or IResolvable

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

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

builder

@Stability(Stable)
static CfnDistributionProps.Builder builder()

Returns:

a CfnDistributionProps.Builder of CfnDistributionProps