Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lightsail
  5. Container

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lightsail.Container

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::Lightsail::Container

Create Container Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Container(name: string, args: ContainerArgs, opts?: CustomResourceOptions);
@overload
def Container(resource_name: str,
              args: ContainerInitArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Container(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              power: Optional[str] = None,
              scale: Optional[int] = None,
              service_name: Optional[str] = None,
              container_service_deployment: Optional[ContainerServiceDeploymentArgs] = None,
              is_disabled: Optional[bool] = None,
              private_registry_access: Optional[ContainerPrivateRegistryAccessArgs] = None,
              public_domain_names: Optional[Sequence[ContainerPublicDomainNameArgs]] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ContainerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ContainerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ContainerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Container resource accepts the following input properties:

Power This property is required. string
The power specification for the container service.
Scale This property is required. int
The scale specification for the container service.
ServiceName This property is required. string
The name for the container service.
ContainerServiceDeployment Pulumi.AwsNative.Lightsail.Inputs.ContainerServiceDeployment
Describes a container deployment configuration of an Amazon Lightsail container service.
IsDisabled bool
A Boolean value to indicate whether the container service is disabled.
PrivateRegistryAccess Pulumi.AwsNative.Lightsail.Inputs.ContainerPrivateRegistryAccess
A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
PublicDomainNames List<Pulumi.AwsNative.Lightsail.Inputs.ContainerPublicDomainName>
The public domain names to use with the container service, such as example.com and www.example.com.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
Power This property is required. string
The power specification for the container service.
Scale This property is required. int
The scale specification for the container service.
ServiceName This property is required. 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.
PrivateRegistryAccess ContainerPrivateRegistryAccessArgs
A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
PublicDomainNames []ContainerPublicDomainNameArgs
The public domain names to use with the container service, such as example.com and www.example.com.
Tags TagArgs
An array of key-value pairs to apply to this resource.
power This property is required. String
The power specification for the container service.
scale This property is required. Integer
The scale specification for the container service.
serviceName This property is required. String
The name for the container service.
containerServiceDeployment ContainerServiceDeployment
Describes a container deployment configuration of an Amazon Lightsail container service.
isDisabled Boolean
A Boolean value to indicate whether the container service is disabled.
privateRegistryAccess ContainerPrivateRegistryAccess
A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
publicDomainNames List<ContainerPublicDomainName>
The public domain names to use with the container service, such as example.com and www.example.com.
tags List<Tag>
An array of key-value pairs to apply to this resource.
power This property is required. string
The power specification for the container service.
scale This property is required. number
The scale specification for the container service.
serviceName This property is required. string
The name for the container service.
containerServiceDeployment ContainerServiceDeployment
Describes a container deployment configuration of an Amazon Lightsail container service.
isDisabled boolean
A Boolean value to indicate whether the container service is disabled.
privateRegistryAccess ContainerPrivateRegistryAccess
A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
publicDomainNames ContainerPublicDomainName[]
The public domain names to use with the container service, such as example.com and www.example.com.
tags Tag[]
An array of key-value pairs to apply to this resource.
power This property is required. str
The power specification for the container service.
scale This property is required. int
The scale specification for the container service.
service_name This property is required. 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.
private_registry_access ContainerPrivateRegistryAccessArgs
A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
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[TagArgs]
An array of key-value pairs to apply to this resource.
power This property is required. String
The power specification for the container service.
scale This property is required. Number
The scale specification for the container service.
serviceName This property is required. 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.
privateRegistryAccess Property Map
A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
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
The Amazon Resource Name (ARN) of the container.
Id string
The provider-assigned unique ID for this managed resource.
PrincipalArn string
The principal ARN of the container service.
Url string
The publicly accessible URL of the container service.
ContainerArn string
The Amazon Resource Name (ARN) of the container.
Id string
The provider-assigned unique ID for this managed resource.
PrincipalArn string
The principal ARN of the container service.
Url string
The publicly accessible URL of the container service.
containerArn String
The Amazon Resource Name (ARN) of the container.
id String
The provider-assigned unique ID for this managed resource.
principalArn String
The principal ARN of the container service.
url String
The publicly accessible URL of the container service.
containerArn string
The Amazon Resource Name (ARN) of the container.
id string
The provider-assigned unique ID for this managed resource.
principalArn string
The principal ARN of the container service.
url string
The publicly accessible URL of the container service.
container_arn str
The Amazon Resource Name (ARN) of the container.
id str
The provider-assigned unique ID for this managed resource.
principal_arn str
The principal ARN of the container service.
url str
The publicly accessible URL of the container service.
containerArn String
The Amazon Resource Name (ARN) of the container.
id String
The provider-assigned unique ID for this managed resource.
principalArn String
The principal ARN of the container service.
url String
The publicly accessible URL of the container service.

Supporting Types

Container
, ContainerArgs

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
, ContainerEnvironmentVariableArgs

Value string
The environment variable value.
Variable string
The environment variable key.
Value string
The environment variable value.
Variable string
The environment variable key.
value String
The environment variable value.
variable String
The environment variable key.
value string
The environment variable value.
variable string
The environment variable key.
value str
The environment variable value.
variable str
The environment variable key.
value String
The environment variable value.
variable String
The environment variable key.

ContainerHealthCheckConfig
, ContainerHealthCheckConfigArgs

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
, ContainerPortInfoArgs

Port string
The open firewall ports of the container.
Protocol string

The protocol name for the open ports.

Allowed values : HTTP | HTTPS | TCP | UDP

Port string
The open firewall ports of the container.
Protocol string

The protocol name for the open ports.

Allowed values : HTTP | HTTPS | TCP | UDP

port String
The open firewall ports of the container.
protocol String

The protocol name for the open ports.

Allowed values : HTTP | HTTPS | TCP | UDP

port string
The open firewall ports of the container.
protocol string

The protocol name for the open ports.

Allowed values : HTTP | HTTPS | TCP | UDP

port str
The open firewall ports of the container.
protocol str

The protocol name for the open ports.

Allowed values : HTTP | HTTPS | TCP | UDP

port String
The open firewall ports of the container.
protocol String

The protocol name for the open ports.

Allowed values : HTTP | HTTPS | TCP | UDP

ContainerPrivateRegistryAccess
, ContainerPrivateRegistryAccessArgs

EcrImagePullerRole Pulumi.AwsNative.Lightsail.Inputs.ContainerPrivateRegistryAccessEcrImagePullerRoleProperties
An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.
EcrImagePullerRole ContainerPrivateRegistryAccessEcrImagePullerRoleProperties
An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.
ecrImagePullerRole ContainerPrivateRegistryAccessEcrImagePullerRoleProperties
An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.
ecrImagePullerRole ContainerPrivateRegistryAccessEcrImagePullerRoleProperties
An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.
ecr_image_puller_role ContainerPrivateRegistryAccessEcrImagePullerRoleProperties
An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.
ecrImagePullerRole Property Map
An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

ContainerPrivateRegistryAccessEcrImagePullerRoleProperties
, ContainerPrivateRegistryAccessEcrImagePullerRolePropertiesArgs

IsActive bool
A Boolean value that indicates whether to activate the role.
PrincipalArn string
The Amazon Resource Name (ARN) of the role, if it is activated.
IsActive bool
A Boolean value that indicates whether to activate the role.
PrincipalArn string
The Amazon Resource Name (ARN) of the role, if it is activated.
isActive Boolean
A Boolean value that indicates whether to activate the role.
principalArn String
The Amazon Resource Name (ARN) of the role, if it is activated.
isActive boolean
A Boolean value that indicates whether to activate the role.
principalArn string
The Amazon Resource Name (ARN) of the role, if it is activated.
is_active bool
A Boolean value that indicates whether to activate the role.
principal_arn str
The Amazon Resource Name (ARN) of the role, if it is activated.
isActive Boolean
A Boolean value that indicates whether to activate the role.
principalArn String
The Amazon Resource Name (ARN) of the role, if it is activated.

ContainerPublicDomainName
, ContainerPublicDomainNameArgs

CertificateName string
The name of the certificate for the public domains.
DomainNames List<string>
An object that describes the configuration for the containers of the deployment.
CertificateName string
The name of the certificate for the public domains.
DomainNames []string
An object that describes the configuration for the containers of the deployment.
certificateName String
The name of the certificate for the public domains.
domainNames List<String>
An object that describes the configuration for the containers of the deployment.
certificateName string
The name of the certificate for the public domains.
domainNames string[]
An object that describes the configuration for the containers of the deployment.
certificate_name str
The name of the certificate for the public domains.
domain_names Sequence[str]
An object that describes the configuration for the containers of the deployment.
certificateName String
The name of the certificate for the public domains.
domainNames List<String>
An object that describes the configuration for the containers of the deployment.

ContainerPublicEndpoint
, ContainerPublicEndpointArgs

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
, ContainerServiceDeploymentArgs

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.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native