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

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

Properties

ServiceName string | Aws_CF_FunctionString required

The name for the container service.

Power string | Aws_CF_FunctionString required

The power specification for the container service.

Scale integer required

The scale specification for the container service.

min=1max=20
PublicDomainNames PublicDomainName[]

The public domain names to use with the container service, such as example.com and www.example.com.

uniqueItems=true
ContainerServiceDeployment object

Describes a container deployment configuration of an Amazon Lightsail container service.

2 nested properties
Containers Container[]

An object that describes the configuration for the containers of the deployment.

uniqueItems=true
PublicEndpoint object

Describes the settings of a public endpoint for an Amazon Lightsail container service.

3 nested properties
ContainerName string | Aws_CF_FunctionString

The name of the container for the endpoint.

ContainerPort integer

The port of the container to which traffic is forwarded to.

HealthCheckConfig object

Describes the health check configuration of an Amazon Lightsail container service.

6 nested properties
HealthyThreshold integer

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

IntervalSeconds integer

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

Path string | Aws_CF_FunctionString

The path on the container on which to perform the health check. The default value is /.

SuccessCodes string | Aws_CF_FunctionString

The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

TimeoutSeconds integer

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

UnhealthyThreshold integer

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

IsDisabled boolean

A Boolean value to indicate whether the container service is disabled.

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 -.

HealthCheckConfig object

Describes the health check configuration of an Amazon Lightsail container service.

HealthyThreshold integer

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

IntervalSeconds integer

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

Path string | Aws_CF_FunctionString

The path on the container on which to perform the health check. The default value is /.

SuccessCodes string | Aws_CF_FunctionString

The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

TimeoutSeconds integer

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

UnhealthyThreshold integer

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

PublicEndpoint object

Describes the settings of a public endpoint for an Amazon Lightsail container service.

ContainerName string | Aws_CF_FunctionString

The name of the container for the endpoint.

ContainerPort integer

The port of the container to which traffic is forwarded to.

HealthCheckConfig object

Describes the health check configuration of an Amazon Lightsail container service.

6 nested properties
HealthyThreshold integer

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

IntervalSeconds integer

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

Path string | Aws_CF_FunctionString

The path on the container on which to perform the health check. The default value is /.

SuccessCodes string | Aws_CF_FunctionString

The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

TimeoutSeconds integer

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

UnhealthyThreshold integer

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

EnvironmentVariable object
Variable string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString
PortInfo object
Port string | Aws_CF_FunctionString
Protocol string | Aws_CF_FunctionString
Container object

Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

ContainerName string | Aws_CF_FunctionString

The name of the container.

Command string[]

The launch command for the container.

uniqueItems=true
Environment EnvironmentVariable[]

The environment variables of the container.

uniqueItems=true
Image string | Aws_CF_FunctionString

The name of the image used for the container.

Ports PortInfo[]

The open firewall ports of the container.

uniqueItems=true
ContainerServiceDeployment object

Describes a container deployment configuration of an Amazon Lightsail container service.

Containers Container[]

An object that describes the configuration for the containers of the deployment.

uniqueItems=true
PublicEndpoint object

Describes the settings of a public endpoint for an Amazon Lightsail container service.

3 nested properties
ContainerName string | Aws_CF_FunctionString

The name of the container for the endpoint.

ContainerPort integer

The port of the container to which traffic is forwarded to.

HealthCheckConfig object

Describes the health check configuration of an Amazon Lightsail container service.

6 nested properties
HealthyThreshold integer

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

IntervalSeconds integer

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

Path string | Aws_CF_FunctionString

The path on the container on which to perform the health check. The default value is /.

SuccessCodes string | Aws_CF_FunctionString

The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

TimeoutSeconds integer

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

UnhealthyThreshold integer

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

PublicDomainName object

The public domain name to use with the container service, such as example.com and www.example.com.

CertificateName string | Aws_CF_FunctionString
DomainNames string[]

An object that describes the configuration for the containers of the deployment.

uniqueItems=true