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

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::LightsailDistribution

Defined in:

gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #alternative_domain_names ⇒ Array<String>

  The alternate domain names of the distribution.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the distribution.

• #bundle_id ⇒ 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.

• #cache_behaviors ⇒ Array<Types::CacheBehaviorPerPath>

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

• #certificate_name ⇒ String

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

• #created_at ⇒ Time

  The timestamp when the distribution was created.

• #default_cache_behavior ⇒ Types::CacheBehavior

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

• #domain_name ⇒ String

  The domain name of the distribution.

• #ip_address_type ⇒ String

  The IP address type of the distribution.

• #is_enabled ⇒ Boolean

  Indicates whether the distribution is enabled.

• #location ⇒ Types::ResourceLocation

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

• #name ⇒ String

  The name of the distribution.

• #origin ⇒ Types::Origin

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

• #origin_public_dns ⇒ String

  The public DNS of the origin.

• #resource_type ⇒ String

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

• #status ⇒ String

  The status of the distribution.

• #support_code ⇒ String

  The support code.

• #tags ⇒ Array<Types::Tag>

  The tag keys and optional values for the resource.

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)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#alternative_domain_names ⇒ Array<String>

The alternate domain names of the distribution.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the distribution.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#bundle_id ⇒ String

The ID of the bundle currently applied to the distribution.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cache_behavior_settings ⇒ Types::CacheSettings

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

Returns:

• (Types::CacheSettings)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cache_behaviors ⇒ Array<Types::CacheBehaviorPerPath>

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

Returns:

• (Array<Types::CacheBehaviorPerPath>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the distribution was created.

Returns:

• (Time)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_cache_behavior ⇒ Types::CacheBehavior

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

Returns:

• (Types::CacheBehavior)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The domain name of the distribution.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

The IP address type of the distribution.

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#is_enabled ⇒ Boolean

Indicates whether the distribution is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Types::ResourceLocation)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the distribution.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Types::Origin)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#origin_public_dns ⇒ String

The public DNS of the origin.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the distribution.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10977

class LightsailDistribution < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :alternative_domain_names,
  :status,
  :is_enabled,
  :domain_name,
  :bundle_id,
  :certificate_name,
  :origin,
  :origin_public_dns,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :able_to_update_bundle,
  :ip_address_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end