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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#able_to_update_bundleBoolean

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)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_namesArray<String>

The alternate domain names of the distribution.

Returns:

  • (Array<String>)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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

#arnString

The Amazon Resource Name (ARN) of the distribution.

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_idString

The ID of the bundle currently applied to the distribution.

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_settingsTypes::CacheSettings

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



10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_behaviorsArray<Types::CacheBehaviorPerPath>

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

Returns:



10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_nameString

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

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_atTime

The timestamp when the distribution was created.

Returns:

  • (Time)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_behaviorTypes::CacheBehavior

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



10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_nameString

The domain name of the distribution.

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_typeString

The IP address type of the distribution.

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

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_enabledBoolean

Indicates whether the distribution is enabled.

Returns:

  • (Boolean)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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

#locationTypes::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.



10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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

#nameString

The name of the distribution.

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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

#originTypes::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:



10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_dnsString

The public DNS of the origin.

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_typeString

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

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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

#statusString

The status of the distribution.

Returns:

  • (String)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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_codeString

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)


10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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

#tagsArray<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:



10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10723

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