Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-lightsail-distribution.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Lightsail::Distribution. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git

Properties

DistributionName string | Aws_CF_FunctionString required

The name for the distribution.

BundleId string | Aws_CF_FunctionString required

The bundle ID to use for the distribution.

DefaultCacheBehavior object required

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

1 nested properties
Behavior string | Aws_CF_FunctionString

The cache behavior of the distribution.

Origin object required

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

3 nested properties
Name string | Aws_CF_FunctionString

The name of the origin resource.

ProtocolPolicy string | Aws_CF_FunctionString

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

RegionName string | Aws_CF_FunctionString

The AWS Region name of the origin resource.

IpAddressType string | Aws_CF_FunctionString

The IP address type for the distribution.

CacheBehaviors CacheBehaviorPerPath[]

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

uniqueItems=true
CacheBehaviorSettings object

Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.

8 nested properties
AllowedHTTPMethods string | Aws_CF_FunctionString

The HTTP methods that are processed and forwarded to the distribution's origin.

CachedHTTPMethods string | Aws_CF_FunctionString

The HTTP method responses that are cached by your distribution.

DefaultTTL integer

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.

format=int64
MaximumTTL integer

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.

format=int64
MinimumTTL integer

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.

format=int64
ForwardedCookies object

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

2 nested properties
CookiesAllowList string[]

The specific cookies to forward to your distribution's origin.

uniqueItems=true
Option string | Aws_CF_FunctionString

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.

ForwardedHeaders object

Describes the request headers that a Lightsail distribution bases caching on.

2 nested properties
HeadersAllowList string[]

The specific headers to forward to your distribution's origin.

uniqueItems=true
Option string | Aws_CF_FunctionString

The headers that you want your distribution to forward to your origin and base caching on.

ForwardedQueryStrings object

Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

2 nested properties
QueryStringsAllowList string[]

The specific query strings that the distribution forwards to the origin.

uniqueItems=true
Option boolean

Indicates whether the distribution forwards and caches based on query strings.

IsEnabled boolean

Indicates whether the distribution is enabled.

CertificateName string | Aws_CF_FunctionString

The certificate attached to the Distribution.

Tags Tag[]

An array of key-value pairs to apply to this resource.

uniqueItems=true

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

CacheBehaviorPerPath object

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

Behavior string | Aws_CF_FunctionString

The cache behavior for the specified path.

Path string | Aws_CF_FunctionString

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.

CookieObject object

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

CookiesAllowList string[]

The specific cookies to forward to your distribution's origin.

uniqueItems=true
Option string | Aws_CF_FunctionString

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.

HeaderObject object

Describes the request headers that a Lightsail distribution bases caching on.

HeadersAllowList string[]

The specific headers to forward to your distribution's origin.

uniqueItems=true
Option string | Aws_CF_FunctionString

The headers that you want your distribution to forward to your origin and base caching on.

QueryStringObject object

Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

QueryStringsAllowList string[]

The specific query strings that the distribution forwards to the origin.

uniqueItems=true
Option boolean

Indicates whether the distribution forwards and caches based on query strings.

CacheSettings object

Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.

AllowedHTTPMethods string | Aws_CF_FunctionString

The HTTP methods that are processed and forwarded to the distribution's origin.

CachedHTTPMethods string | Aws_CF_FunctionString

The HTTP method responses that are cached by your distribution.

DefaultTTL integer

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.

format=int64
MaximumTTL integer

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.

format=int64
MinimumTTL integer

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.

format=int64
ForwardedCookies object

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

2 nested properties
CookiesAllowList string[]

The specific cookies to forward to your distribution's origin.

uniqueItems=true
Option string | Aws_CF_FunctionString

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.

ForwardedHeaders object

Describes the request headers that a Lightsail distribution bases caching on.

2 nested properties
HeadersAllowList string[]

The specific headers to forward to your distribution's origin.

uniqueItems=true
Option string | Aws_CF_FunctionString

The headers that you want your distribution to forward to your origin and base caching on.

ForwardedQueryStrings object

Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

2 nested properties
QueryStringsAllowList string[]

The specific query strings that the distribution forwards to the origin.

uniqueItems=true
Option boolean

Indicates whether the distribution forwards and caches based on query strings.

CacheBehavior object

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

Behavior string | Aws_CF_FunctionString

The cache behavior of the distribution.

InputOrigin object

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

Name string | Aws_CF_FunctionString

The name of the origin resource.

ProtocolPolicy string | Aws_CF_FunctionString

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

RegionName string | Aws_CF_FunctionString

The AWS Region name of the origin resource.