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

Class: Aws::Lightsail::Types::CreateDistributionRequest

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

Overview

Note:

When passing CreateDistributionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  distribution_name: "ResourceName", # required
  origin: { # required
    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
    protocol_policy: "http-only", # accepts http-only, https-only
  },
  default_cache_behavior: { # required
    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
    },
  ],
  bundle_id: "string", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_id ⇒ String

The bundle ID to use for the distribution.

A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

Returns:

  • (String) —

    The bundle ID to use for the distribution.

#cache_behavior_settings ⇒ Types::CacheSettings

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

Returns:

  • (Types::CacheSettings) —

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

#cache_behaviors ⇒ Array<Types::CacheBehaviorPerPath>

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

Returns:

#default_cache_behavior ⇒ Types::CacheBehavior

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

Returns:

  • (Types::CacheBehavior) —

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

#distribution_name ⇒ String

The name for the distribution.

Returns:

  • (String) —

    The name for the distribution.

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

  • (Types::InputOrigin) —

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

#tags ⇒ Array<Types::Tag>

The tag keys and optional values to add to the distribution during create.

Use the TagResource action to tag a resource after it\'s created.

Returns:

  • (Array<Types::Tag>) —

    The tag keys and optional values to add to the distribution during create.