Skip to content

LightsailDistribution

Source code in docs_src/capo_lightsail/types/lightsail_distribution.py
class LightsailDistribution(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the distribution.</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the distribution.</p>"""
    support_code: NotRequired["capo_lightsail.types.string.string"]
    """<p>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.</p>"""
    created_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The timestamp when the distribution was created.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.</p> <note> <p>Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the <code>us-east-1</code> Region.</p> </note>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The Lightsail resource type (<code>Distribution</code>).</p>"""
    alternative_domain_names: NotRequired["capo_lightsail.types.string_list.StringList"]
    """<p>The alternate domain names of the distribution.</p>"""
    status: NotRequired["capo_lightsail.types.string.string"]
    """<p>The status of the distribution.</p>"""
    is_enabled: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>Indicates whether the distribution is enabled.</p>"""
    domain_name: NotRequired["capo_lightsail.types.string.string"]
    """<p>The domain name of the distribution.</p>"""
    bundle_id: NotRequired["capo_lightsail.types.string.string"]
    """<p>The ID of the bundle currently applied to the distribution.</p>"""
    certificate_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the SSL/TLS certificate attached to the distribution, if any.</p>"""
    origin: NotRequired["capo_lightsail.types.origin.Origin"]
    """<p>An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.</p> <p>The distribution pulls, caches, and serves content from the origin.</p>"""
    origin_public_dns: NotRequired["capo_lightsail.types.string.string"]
    """<p>The public DNS of the origin.</p>"""
    default_cache_behavior: NotRequired[
        "capo_lightsail.types.cache_behavior.CacheBehavior"
    ]
    """<p>An object that describes the default cache behavior of the distribution.</p>"""
    cache_behavior_settings: NotRequired[
        "capo_lightsail.types.cache_settings.CacheSettings"
    ]
    """<p>An object that describes the cache behavior settings of the distribution.</p>"""
    cache_behaviors: NotRequired[
        "capo_lightsail.types.cache_behavior_list.CacheBehaviorList"
    ]
    """<p>An array of objects that describe the per-path cache behavior of the distribution.</p>"""
    able_to_update_bundle: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>Indicates whether the bundle that is currently applied to your distribution, specified using the <code>distributionName</code> parameter, can be changed to another bundle.</p> <p>Use the <code>UpdateDistributionBundle</code> action to change your distribution's bundle.</p>"""
    ip_address_type: NotRequired["capo_lightsail.types.ip_address_type.IpAddressType"]
    """<p>The IP address type of the distribution.</p> <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for IPv4 and IPv6.</p>"""
    tags: NotRequired["capo_lightsail.types.tag_list.TagList"]
    """<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>"""
    viewer_minimum_tls_protocol_version: NotRequired[
        "capo_lightsail.types.string.string"
    ]
    """<p>The minimum TLS protocol version that the distribution can use to communicate with viewers.</p>"""
    default_root_object: NotRequired["capo_lightsail.types.string.string"]
    """<p>The object (for example, <code>index.html</code>) that the distribution returns when a viewer requests the root URL of the distribution (<code>/</code>) instead of a specific object.</p>"""
    custom_error_responses: NotRequired[
        "capo_lightsail.types.distribution_custom_error_response_list.DistributionCustomErrorResponseList"
    ]
    """<p>An array of objects that describe the custom error responses configured for the distribution.</p>"""

able_to_update_bundle instance-attribute

able_to_update_bundle: NotRequired[boolean]

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.

alternative_domain_names instance-attribute

alternative_domain_names: NotRequired[StringList]

The alternate domain names of the distribution.

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the distribution.

bundle_id instance-attribute

bundle_id: NotRequired[string]

The ID of the bundle currently applied to the distribution.

cache_behavior_settings instance-attribute

cache_behavior_settings: NotRequired[CacheSettings]

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

cache_behaviors instance-attribute

cache_behaviors: NotRequired[CacheBehaviorList]

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

certificate_name instance-attribute

certificate_name: NotRequired[ResourceName]

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

created_at instance-attribute

created_at: NotRequired[IsoDate]

The timestamp when the distribution was created.

custom_error_responses instance-attribute

custom_error_responses: NotRequired[DistributionCustomErrorResponseList]

An array of objects that describe the custom error responses configured for the distribution.

default_cache_behavior instance-attribute

default_cache_behavior: NotRequired[CacheBehavior]

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

default_root_object instance-attribute

default_root_object: NotRequired[string]

The object (for example, index.html) that the distribution returns when a viewer requests the root URL of the distribution (/) instead of a specific object.

domain_name instance-attribute

domain_name: NotRequired[string]

The domain name of the distribution.

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type of the distribution.

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

is_enabled instance-attribute

is_enabled: NotRequired[boolean]

Indicates whether the distribution is enabled.

location instance-attribute

location: NotRequired[ResourceLocation]

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

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

name instance-attribute

name: NotRequired[ResourceName]

The name of the distribution.

origin instance-attribute

origin: NotRequired[Origin]

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.

origin_public_dns instance-attribute

origin_public_dns: NotRequired[string]

The public DNS of the origin.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The Lightsail resource type (Distribution).

status instance-attribute

status: NotRequired[string]

The status of the distribution.

support_code instance-attribute

support_code: NotRequired[string]

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.

tags instance-attribute

tags: NotRequired[TagList]

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

viewer_minimum_tls_protocol_version instance-attribute

viewer_minimum_tls_protocol_version: NotRequired[string]

The minimum TLS protocol version that the distribution can use to communicate with viewers.