Documentation

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

See: newLightsailDistribution smart constructor.

Create a value of LightsailDistribution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:LightsailDistribution', lightsailDistribution_status - The status of the distribution.

$sel:origin:LightsailDistribution', lightsailDistribution_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.

$sel:certificateName:LightsailDistribution', lightsailDistribution_certificateName - The name of the SSL/TLS certificate attached to the distribution, if any.

$sel:resourceType:LightsailDistribution', lightsailDistribution_resourceType - The Lightsail resource type (e.g., Distribution).

$sel:arn:LightsailDistribution', lightsailDistribution_arn - The Amazon Resource Name (ARN) of the distribution.

$sel:createdAt:LightsailDistribution', lightsailDistribution_createdAt - The timestamp when the distribution was created.

$sel:location:LightsailDistribution', lightsailDistribution_location - An object that describes the location of the distribution, such as the AWS Region and Availability Zone.

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.

$sel:cacheBehaviorSettings:LightsailDistribution', lightsailDistribution_cacheBehaviorSettings - An object that describes the cache behavior settings of the distribution.

$sel:alternativeDomainNames:LightsailDistribution', lightsailDistribution_alternativeDomainNames - The alternate domain names of the distribution.

$sel:bundleId:LightsailDistribution', lightsailDistribution_bundleId - The ID of the bundle currently applied to the distribution.

$sel:ableToUpdateBundle:LightsailDistribution', lightsailDistribution_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.

$sel:originPublicDNS:LightsailDistribution', lightsailDistribution_originPublicDNS - The public DNS of the origin.

$sel:domainName:LightsailDistribution', lightsailDistribution_domainName - The domain name of the distribution.

$sel:name:LightsailDistribution', lightsailDistribution_name - The name of the distribution.

$sel:ipAddressType:LightsailDistribution', lightsailDistribution_ipAddressType - The IP address type of the distribution.

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

$sel:isEnabled:LightsailDistribution', lightsailDistribution_isEnabled - Indicates whether the distribution is enabled.

$sel:supportCode:LightsailDistribution', lightsailDistribution_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.

$sel:defaultCacheBehavior:LightsailDistribution', lightsailDistribution_defaultCacheBehavior - An object that describes the default cache behavior of the distribution.

$sel:cacheBehaviors:LightsailDistribution', lightsailDistribution_cacheBehaviors - An array of objects that describe the per-path cache behavior of the distribution.

$sel:tags:LightsailDistribution', lightsailDistribution_tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

The status of the distribution.

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.

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

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

The Amazon Resource Name (ARN) of the distribution.

The timestamp when the distribution was created.

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

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.

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

The alternate domain names of the distribution.

The ID of the bundle currently applied to the distribution.

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.

The public DNS of the origin.

The domain name of the distribution.

The name of the distribution.

The IP address type of the distribution.

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

Indicates whether the distribution is enabled.

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.

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

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

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