Class: Aws::Lightsail::Types::UpdateDistributionRequest

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

Overview

Note:

When making an API call, you may pass UpdateDistributionRequest data as a hash:

{
  distribution_name: "ResourceName", # required
  origin: {
    name: "ResourceName",
    region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1
    protocol_policy: "http-only", # accepts http-only, https-only
  },
  default_cache_behavior: {
    behavior: "dont-cache", # accepts dont-cache, cache
  },
  cache_behavior_settings: {
    default_ttl: 1,
    minimum_ttl: 1,
    maximum_ttl: 1,
    allowed_http_methods: "NonEmptyString",
    cached_http_methods: "NonEmptyString",
    forwarded_cookies: {
      option: "none", # accepts none, allow-list, all
      cookies_allow_list: ["string"],
    },
    forwarded_headers: {
      option: "none", # accepts none, allow-list, all
      headers_allow_list: ["Accept"], # accepts Accept, Accept-Charset, Accept-Datetime, Accept-Encoding, Accept-Language, Authorization, CloudFront-Forwarded-Proto, CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer, CloudFront-Is-SmartTV-Viewer, CloudFront-Is-Tablet-Viewer, CloudFront-Viewer-Country, Host, Origin, Referer
    },
    forwarded_query_strings: {
      option: false,
      query_strings_allow_list: ["string"],
    },
  },
  cache_behaviors: [
    {
      path: "string",
      behavior: "dont-cache", # accepts dont-cache, cache
    },
  ],
  is_enabled: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_behavior_settingsTypes::CacheSettings

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

The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.



14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14895

class UpdateDistributionRequest < Struct.new(
  :distribution_name,
  :origin,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :is_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#cache_behaviorsArray<Types::CacheBehaviorPerPath>

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

Returns:



14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14895

class UpdateDistributionRequest < Struct.new(
  :distribution_name,
  :origin,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :is_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#default_cache_behaviorTypes::CacheBehavior

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



14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14895

class UpdateDistributionRequest < Struct.new(
  :distribution_name,
  :origin,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :is_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_nameString

The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.

Returns:

  • (String)


14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14895

class UpdateDistributionRequest < Struct.new(
  :distribution_name,
  :origin,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :is_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#is_enabledBoolean

Indicates whether to enable the distribution.

Returns:

  • (Boolean)


14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14895

class UpdateDistributionRequest < Struct.new(
  :distribution_name,
  :origin,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :is_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#originTypes::InputOrigin

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

The distribution pulls, caches, and serves content from the origin.

Returns:



14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14895

class UpdateDistributionRequest < Struct.new(
  :distribution_name,
  :origin,
  :default_cache_behavior,
  :cache_behavior_settings,
  :cache_behaviors,
  :is_enabled)
  SENSITIVE = []
  include Aws::Structure
end