LightsailDistribution - Amazon Lightsail

LightsailDistribution

Describes an Amazon Lightsail content delivery network (CDN) distribution.

Contents

ableToUpdateBundle

Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.

Use the UpdateDistributionBundle action to change your distribution's bundle.

Type: Boolean

Required: No

alternativeDomainNames

The alternate domain names of the distribution.

Type: Array of strings

Required: No

arn

The Amazon Resource Name (ARN) of the distribution.

Type: String

Pattern: .*\S.*

Required: No

bundleId

The ID of the bundle currently applied to the distribution.

Type: String

Required: No

cacheBehaviors

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

Type: Array of CacheBehaviorPerPath objects

Required: No

cacheBehaviorSettings

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

Type: CacheSettings object

Required: No

certificateName

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

Type: String

Pattern: \w[\w\-]*\w

Required: No

createdAt

The timestamp when the distribution was created.

Type: Timestamp

Required: No

defaultCacheBehavior

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

Type: CacheBehavior object

Required: No

domainName

The domain name of the distribution.

Type: String

Required: No

ipAddressType

The IP address type of the distribution.

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

Type: String

Valid Values: dualstack | ipv4

Required: No

isEnabled

Indicates whether the distribution is enabled.

Type: Boolean

Required: No

location

An object that describes the location of the distribution, such as the AWS Region and Availability Zone.

Note

Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

Type: ResourceLocation object

Required: No

name

The name of the distribution.

Type: String

Pattern: \w[\w\-]*\w

Required: No

origin

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

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

Type: Origin object

Required: No

originPublicDNS

The public DNS of the origin.

Type: String

Required: No

resourceType

The Lightsail resource type (e.g., Distribution).

Type: String

Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket

Required: No

status

The status of the distribution.

Type: String

Required: No

supportCode

The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.

Type: String

Required: No

tags

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Type: Array of Tag objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: