AWS Native v0.54.0, Mar 21 23

aws-native.lightsail.Container

Resource Type definition for AWS::Lightsail::Container

Create Container Resource

new Container(name: string, args: ContainerArgs, opts?: CustomResourceOptions);

@overload
def Container(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              container_service_deployment: Optional[ContainerServiceDeploymentArgs] = None,
              is_disabled: Optional[bool] = None,
              power: Optional[str] = None,
              public_domain_names: Optional[Sequence[ContainerPublicDomainNameArgs]] = None,
              scale: Optional[int] = None,
              service_name: Optional[str] = None,
              tags: Optional[Sequence[ContainerTagArgs]] = None)
@overload
def Container(resource_name: str,
              args: ContainerInitArgs,
              opts: Optional[ResourceOptions] = None)

func NewContainer(ctx *Context, name string, args ContainerArgs, opts ...ResourceOption) (*Container, error)

public Container(string name, ContainerArgs args, CustomResourceOptions? opts = null)

public Container(String name, ContainerArgs args)
public Container(String name, ContainerArgs args, CustomResourceOptions options)

type: aws-native:lightsail:Container
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ContainerInitArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Container Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Container resource accepts the following input properties:

Power string: The power specification for the container service.
Scale int: The scale specification for the container service.
ServiceName string: The name for the container service.
ContainerServiceDeployment Pulumi.AwsNative.Lightsail.Inputs.ContainerServiceDeploymentArgs: Describes a container deployment configuration of an Amazon Lightsail container service.
IsDisabled bool: A Boolean value to indicate whether the container service is disabled.
PublicDomainNames List<Pulumi.AwsNative.Lightsail.Inputs.ContainerPublicDomainNameArgs>: The public domain names to use with the container service, such as example.com and www.example.com.
Tags List<Pulumi.AwsNative.Lightsail.Inputs.ContainerTagArgs>: An array of key-value pairs to apply to this resource.

Power string: The power specification for the container service.
Scale int: The scale specification for the container service.
ServiceName string: The name for the container service.
ContainerServiceDeployment ContainerServiceDeploymentArgs: Describes a container deployment configuration of an Amazon Lightsail container service.
IsDisabled bool: A Boolean value to indicate whether the container service is disabled.
PublicDomainNames []ContainerPublicDomainNameArgs: The public domain names to use with the container service, such as example.com and www.example.com.
Tags []ContainerTagArgs: An array of key-value pairs to apply to this resource.

power String: The power specification for the container service.
scale Integer: The scale specification for the container service.
serviceName String: The name for the container service.
containerServiceDeployment ContainerServiceDeploymentArgs: Describes a container deployment configuration of an Amazon Lightsail container service.
isDisabled Boolean: A Boolean value to indicate whether the container service is disabled.
publicDomainNames List<ContainerPublicDomainNameArgs>: The public domain names to use with the container service, such as example.com and www.example.com.
tags List<ContainerTagArgs>: An array of key-value pairs to apply to this resource.

power string: The power specification for the container service.
scale number: The scale specification for the container service.
serviceName string: The name for the container service.
containerServiceDeployment ContainerServiceDeploymentArgs: Describes a container deployment configuration of an Amazon Lightsail container service.
isDisabled boolean: A Boolean value to indicate whether the container service is disabled.
publicDomainNames ContainerPublicDomainNameArgs[]: The public domain names to use with the container service, such as example.com and www.example.com.
tags ContainerTagArgs[]: An array of key-value pairs to apply to this resource.

power str: The power specification for the container service.
scale int: The scale specification for the container service.
service_name str: The name for the container service.
container_service_deployment ContainerServiceDeploymentArgs: Describes a container deployment configuration of an Amazon Lightsail container service.
is_disabled bool: A Boolean value to indicate whether the container service is disabled.
public_domain_names Sequence[ContainerPublicDomainNameArgs]: The public domain names to use with the container service, such as example.com and www.example.com.
tags Sequence[ContainerTagArgs]: An array of key-value pairs to apply to this resource.

power String: The power specification for the container service.
scale Number: The scale specification for the container service.
serviceName String: The name for the container service.
containerServiceDeployment Property Map: Describes a container deployment configuration of an Amazon Lightsail container service.
isDisabled Boolean: A Boolean value to indicate whether the container service is disabled.
publicDomainNames List<Property Map>: The public domain names to use with the container service, such as example.com and www.example.com.
tags List<Property Map>: An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Container resource produces the following output properties:

ContainerArn string
Id string: The provider-assigned unique ID for this managed resource.
Url string: The publicly accessible URL of the container service.

ContainerArn string
Id string: The provider-assigned unique ID for this managed resource.
Url string: The publicly accessible URL of the container service.

containerArn String
id String: The provider-assigned unique ID for this managed resource.
url String: The publicly accessible URL of the container service.

containerArn string
id string: The provider-assigned unique ID for this managed resource.
url string: The publicly accessible URL of the container service.

container_arn str
id str: The provider-assigned unique ID for this managed resource.
url str: The publicly accessible URL of the container service.

containerArn String
id String: The provider-assigned unique ID for this managed resource.
url String: The publicly accessible URL of the container service.

Supporting Types

Container

Command List<string>: The launch command for the container.
ContainerName string: The name of the container.
Environment List<Pulumi.AwsNative.Lightsail.Inputs.ContainerEnvironmentVariable>: The environment variables of the container.
Image string: The name of the image used for the container.
Ports List<Pulumi.AwsNative.Lightsail.Inputs.ContainerPortInfo>: The open firewall ports of the container.

Command []string: The launch command for the container.
ContainerName string: The name of the container.
Environment []ContainerEnvironmentVariable: The environment variables of the container.
Image string: The name of the image used for the container.
Ports []ContainerPortInfo: The open firewall ports of the container.

command List<String>: The launch command for the container.
containerName String: The name of the container.
environment List<ContainerEnvironmentVariable>: The environment variables of the container.
image String: The name of the image used for the container.
ports List<ContainerPortInfo>: The open firewall ports of the container.

command string[]: The launch command for the container.
containerName string: The name of the container.
environment ContainerEnvironmentVariable[]: The environment variables of the container.
image string: The name of the image used for the container.
ports ContainerPortInfo[]: The open firewall ports of the container.

command Sequence[str]: The launch command for the container.
container_name str: The name of the container.
environment Sequence[ContainerEnvironmentVariable]: The environment variables of the container.
image str: The name of the image used for the container.
ports Sequence[ContainerPortInfo]: The open firewall ports of the container.

command List<String>: The launch command for the container.
containerName String: The name of the container.
environment List<Property Map>: The environment variables of the container.
image String: The name of the image used for the container.
ports List<Property Map>: The open firewall ports of the container.

ContainerEnvironmentVariable

Value string
Variable string

Value string
Variable string

value String
variable String

value string
variable string

value str
variable str

value String
variable String

ContainerHealthCheckConfig

HealthyThreshold int: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
IntervalSeconds int: 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: The path on the container on which to perform the health check. The default value is /.
SuccessCodes string: 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 int: 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 int: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

HealthyThreshold int: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
IntervalSeconds int: 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: The path on the container on which to perform the health check. The default value is /.
SuccessCodes string: 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 int: 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 int: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

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: The path on the container on which to perform the health check. The default value is /.
successCodes String: 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.

healthyThreshold number: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
intervalSeconds number: 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: The path on the container on which to perform the health check. The default value is /.
successCodes string: 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 number: 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 number: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

healthy_threshold int: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
interval_seconds int: 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 str: The path on the container on which to perform the health check. The default value is /.
success_codes str: 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).
timeout_seconds int: 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.
unhealthy_threshold int: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

healthyThreshold Number: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
intervalSeconds Number: 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: The path on the container on which to perform the health check. The default value is /.
successCodes String: 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 Number: 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 Number: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

ContainerPortInfo

Port string
Protocol string

Port string
Protocol string

port String
protocol String

port string
protocol string

port str
protocol str

port String
protocol String

ContainerPublicDomainName

CertificateName string
DomainNames List<string>: An object that describes the configuration for the containers of the deployment.

CertificateName string
DomainNames []string: An object that describes the configuration for the containers of the deployment.

certificateName String
domainNames List<String>: An object that describes the configuration for the containers of the deployment.

certificateName string
domainNames string[]: An object that describes the configuration for the containers of the deployment.

certificate_name str
domain_names Sequence[str]: An object that describes the configuration for the containers of the deployment.

certificateName String
domainNames List<String>: An object that describes the configuration for the containers of the deployment.

ContainerPublicEndpoint

ContainerName string: The name of the container for the endpoint.
ContainerPort int: The port of the container to which traffic is forwarded to.
HealthCheckConfig Pulumi.AwsNative.Lightsail.Inputs.ContainerHealthCheckConfig: An object that describes the health check configuration of the container.

ContainerName string: The name of the container for the endpoint.
ContainerPort int: The port of the container to which traffic is forwarded to.
HealthCheckConfig ContainerHealthCheckConfig: An object that describes the health check configuration of the container.

containerName String: The name of the container for the endpoint.
containerPort Integer: The port of the container to which traffic is forwarded to.
healthCheckConfig ContainerHealthCheckConfig: An object that describes the health check configuration of the container.

containerName string: The name of the container for the endpoint.
containerPort number: The port of the container to which traffic is forwarded to.
healthCheckConfig ContainerHealthCheckConfig: An object that describes the health check configuration of the container.

container_name str: The name of the container for the endpoint.
container_port int: The port of the container to which traffic is forwarded to.
health_check_config ContainerHealthCheckConfig: An object that describes the health check configuration of the container.

containerName String: The name of the container for the endpoint.
containerPort Number: The port of the container to which traffic is forwarded to.
healthCheckConfig Property Map: An object that describes the health check configuration of the container.

ContainerServiceDeployment

Containers List<Pulumi.AwsNative.Lightsail.Inputs.Container>: An object that describes the configuration for the containers of the deployment.
PublicEndpoint Pulumi.AwsNative.Lightsail.Inputs.ContainerPublicEndpoint: An object that describes the endpoint of the deployment.

Containers []ContainerType: An object that describes the configuration for the containers of the deployment.
PublicEndpoint ContainerPublicEndpoint: An object that describes the endpoint of the deployment.

containers List<Container>: An object that describes the configuration for the containers of the deployment.
publicEndpoint ContainerPublicEndpoint: An object that describes the endpoint of the deployment.

containers Container[]: An object that describes the configuration for the containers of the deployment.
publicEndpoint ContainerPublicEndpoint: An object that describes the endpoint of the deployment.

containers Sequence[Container]: An object that describes the configuration for the containers of the deployment.
public_endpoint ContainerPublicEndpoint: An object that describes the endpoint of the deployment.

containers List<Property Map>: An object that describes the configuration for the containers of the deployment.
publicEndpoint Property Map: An object that describes the endpoint of the deployment.

ContainerTag

Key string: 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: 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 -.

Key string: 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: 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 -.

key String: 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: 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 -.

key string: 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: 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 -.

key str: 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 str: 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 -.

key String: 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: 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 -.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0