You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::LightsailDistribution

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#able_to_update_bundle ⇒ 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.

Returns:

  • (Boolean) —

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

#alternative_domain_names ⇒ Array<String>

The alternate domain names of the distribution.

Returns:

  • (Array<String>) —

    The alternate domain names of the distribution.

#arn ⇒ String

The Amazon Resource Name (ARN) of the distribution.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the distribution.

#bundle_id ⇒ String

The ID of the bundle currently applied to the distribution.

Returns:

  • (String) —

    The ID of the bundle currently applied to the distribution.

#cache_behavior_settings ⇒ Types::CacheSettings

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

Returns:

  • (Types::CacheSettings) —

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

#cache_behaviors ⇒ Array<Types::CacheBehaviorPerPath>

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

Returns:

#certificate_name ⇒ String

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

Returns:

  • (String) —

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

#created_at ⇒ Time

The timestamp when the distribution was created.

Returns:

  • (Time) —

    The timestamp when the distribution was created.

#default_cache_behavior ⇒ Types::CacheBehavior

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

Returns:

  • (Types::CacheBehavior) —

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

#domain_name ⇒ String

The domain name of the distribution.

Returns:

  • (String) —

    The domain name of the distribution.

#is_enabled ⇒ Boolean

Indicates whether the distribution is enabled.

Returns:

  • (Boolean) —

    Indicates whether the distribution is enabled.

#location ⇒ Types::ResourceLocation

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.

Returns:

  • (Types::ResourceLocation) —

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

#name ⇒ String

The name of the distribution.

Returns:

  • (String) —

    The name of the distribution.

#origin ⇒ Types::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.

Returns:

  • (Types::Origin) —

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

#origin_public_dns ⇒ String

The public DNS of the origin.

Returns:

  • (String) —

    The public DNS of the origin.

#resource_type ⇒ String

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

Possible values:

  • ContainerService
  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc
  • LoadBalancer
  • LoadBalancerTlsCertificate
  • Disk
  • DiskSnapshot
  • RelationalDatabase
  • RelationalDatabaseSnapshot
  • ExportSnapshotRecord
  • CloudFormationStackRecord
  • Alarm
  • ContactMethod
  • Distribution
  • Certificate

Returns:

  • (String) —

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

#status ⇒ String

The status of the distribution.

Returns:

  • (String) —

    The status of the distribution.

#support_code ⇒ 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.

Returns:

  • (String) —

    The support code.

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

    The tag keys and optional values for the resource.