aws_lightsail_distribution

able_to_update_bundle

Type: BOOLEAN
Provider name: ableToUpdateBundle
Description: 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.

account_id

Type: STRING

alternative_domain_names

Type: UNORDERED_LIST_STRING
Provider name: alternativeDomainNames
Description: The alternate domain names of the distribution.

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the distribution.

bundle_id

Type: STRING
Provider name: bundleId
Description: The ID of the bundle currently applied to the distribution.

cache_behavior_settings

Type: STRUCT
Provider name: cacheBehaviorSettings
Description: An object that describes the cache behavior settings of the distribution.

• allowed_http_methods
  Type: STRING
  Provider name: allowedHTTPMethods
  Description: The HTTP methods that are processed and forwarded to the distribution’s origin. You can specify the following options:
  • GET,HEAD - The distribution forwards the GET and HEAD methods.
  • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.
  • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.
  If you specify the third option, you might need to restrict access to your distribution’s origin so users can’t perform operations that you don’t want them to. For example, you might not want users to have permission to delete objects from your origin.
  
• cached_http_methods
  Type: STRING
  Provider name: cachedHTTPMethods
  Description: The HTTP method responses that are cached by your distribution. You can specify the following options:
  • GET,HEAD - The distribution caches responses to the GET and HEAD methods.
  • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.
• default_ttl
  Type: INT64
  Provider name: defaultTTL
  Description: The default amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the content has been updated. The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
  
• forwarded_cookies
  Type: STRUCT
  Provider name: forwardedCookies
  Description: An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
  
  • cookies_allow_list
    Type: UNORDERED_LIST_STRING
    Provider name: cookiesAllowList
    Description: The specific cookies to forward to your distribution’s origin.
    
  • option
    Type: STRING
    Provider name: option
    Description: Specifies which cookies to forward to the distribution’s origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
    
• forwarded_headers
  Type: STRUCT
  Provider name: forwardedHeaders
  Description: An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
  
  • headers_allow_list
    Type: UNORDERED_LIST_STRING
    Provider name: headersAllowList
    Description: The specific headers to forward to your distribution’s origin.
    
  • option
    Type: STRING
    Provider name: option
    Description: The headers that you want your distribution to forward to your origin and base caching on. You can configure your distribution to do one of the following:
    • all - Forward all headers to your origin.
    • none - Forward only the default headers.
    • allow-list - Forward only the headers you specify using the headersAllowList parameter.
• forwarded_query_strings
  Type: STRUCT
  Provider name: forwardedQueryStrings
  Description: An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
  
  • option
    Type: BOOLEAN
    Provider name: option
    Description: Indicates whether the distribution forwards and caches based on query strings.
    
  • query_strings_allow_list
    Type: UNORDERED_LIST_STRING
    Provider name: queryStringsAllowList
    Description: The specific query strings that the distribution forwards to the origin. Your distribution will cache content based on the specified query strings. If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
    
• maximum_ttl
  Type: INT64
  Provider name: maximumTTL
  Description: The maximum amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the object has been updated. The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
  
• minimum_ttl
  Type: INT64
  Provider name: minimumTTL
  Description: The minimum amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the object has been updated. A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
  

cache_behaviors

Type: UNORDERED_LIST_STRUCT
Provider name: cacheBehaviors
Description: An array of objects that describe the per-path cache behavior of the distribution.

• behavior
  Type: STRING
  Provider name: behavior
  Description: The cache behavior for the specified path. You can specify one of the following per-path cache behaviors:
  • cache - This behavior caches the specified path.
  • dont-cache - This behavior doesn’t cache the specified path.
• path
  Type: STRING
  Provider name: path
  Description: The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/), and file types (.html, jpg, js). Directories and file paths are case-sensitive. Examples:
  • Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
  • Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
  • Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/.html
  • Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/.jpg var/www/html/images/.png var/www/html/images/.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/

certificate_name

Type: STRING
Provider name: certificateName
Description: The name of the SSL/TLS certificate attached to the distribution, if any.

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The timestamp when the distribution was created.

default_cache_behavior

Type: STRUCT
Provider name: defaultCacheBehavior
Description: An object that describes the default cache behavior of the distribution.

• behavior
  Type: STRING
  Provider name: behavior
  Description: The cache behavior of the distribution. The following cache behaviors can be specified:
  • cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn’t change depending on who views it, or for websites that don’t use cookies, headers, or query strings to personalize content.
  • dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution’s CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.

domain_name

Type: STRING
Provider name: domainName
Description: The domain name of the distribution.

ip_address_type

Type: STRING
Provider name: ipAddressType
Description: The IP address type of the distribution. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

is_enabled

Type: BOOLEAN
Provider name: isEnabled
Description: Indicates whether the distribution is enabled.

location

Type: STRUCT
Provider name: location
Description: 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.

• availability_zone
  Type: STRING
  Provider name: availabilityZone
  Description: The Availability Zone. Follows the format us-east-2a (case-sensitive).
  
• region_name
  Type: STRING
  Provider name: regionName
  Description: The Amazon Web Services Region name.
  

name

Type: STRING
Provider name: name
Description: The name of the distribution.

origin

Type: STRUCT
Provider name: origin
Description: 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.

• name
  Type: STRING
  Provider name: name
  Description: The name of the origin resource.
  
• protocol_policy
  Type: STRING
  Provider name: protocolPolicy
  Description: The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
  
• region_name
  Type: STRING
  Provider name: regionName
  Description: The AWS Region name of the origin resource.
  
• resource_type
  Type: STRING
  Provider name: resourceType
  Description: The resource type of the origin resource (Instance).
  
• response_timeout
  Type: INT32
  Provider name: responseTimeout
  Description: The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
  

origin_public_dns

Type: STRING
Provider name: originPublicDNS
Description: The public DNS of the origin.

resource_type

Type: STRING
Provider name: resourceType
Description: The Lightsail resource type (Distribution).

status

Type: STRING
Provider name: status
Description: The status of the distribution.

support_code

Type: STRING
Provider name: supportCode
Description: 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.

tags

Type: UNORDERED_LIST_STRING

viewer_minimum_tls_protocol_version

Type: STRING
Provider name: viewerMinimumTlsProtocolVersion
Description: The minimum TLS protocol version that the distribution can use to communicate with viewers.