We recommend new projects start with resources from the AWS provider.
aws-native.lightsail.Container
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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 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
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 string
- The power specification for the container service.
- Scale int
- The scale specification for the container service.
- Service
Name string - The name for the container service.
- Container
Service Pulumi.Deployment Aws Native. Lightsail. Inputs. Container Service Deployment - 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 Pulumi.Access Aws Native. Lightsail. Inputs. Container Private Registry Access - 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 List<Pulumi.Names Aws Native. Lightsail. Inputs. Container Public Domain Name> - The public domain names to use with the container service, such as example.com and www.example.com.
- List<Pulumi.
Aws Native. Inputs. Tag> - 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.
- Service
Name string - The name for the container service.
- Container
Service ContainerDeployment Service Deployment Args - 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 ContainerAccess Private Registry Access Args - 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 []ContainerNames Public Domain Name Args - The public domain names to use with the container service, such as example.com and www.example.com.
- Tag
Args - 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.
- service
Name String - The name for the container service.
- container
Service ContainerDeployment Service Deployment - Describes a container deployment configuration of an Amazon Lightsail container service.
- is
Disabled Boolean - A Boolean value to indicate whether the container service is disabled.
- private
Registry ContainerAccess Private Registry Access - 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 List<ContainerNames Public Domain Name> - The public domain names to use with the container service, such as example.com and www.example.com.
- List<Tag>
- 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.
- service
Name string - The name for the container service.
- container
Service ContainerDeployment Service Deployment - Describes a container deployment configuration of an Amazon Lightsail container service.
- is
Disabled boolean - A Boolean value to indicate whether the container service is disabled.
- private
Registry ContainerAccess Private Registry Access - 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 ContainerNames Public Domain Name[] - The public domain names to use with the container service, such as example.com and www.example.com.
- Tag[]
- 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_ Containerdeployment Service Deployment Args - 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_ Containeraccess Private Registry Access Args - 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_ Sequence[Containernames Public Domain Name Args] - The public domain names to use with the container service, such as example.com and www.example.com.
- Sequence[Tag
Args] - 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.
- service
Name String - The name for the container service.
- container
Service Property MapDeployment - Describes a container deployment configuration of an Amazon Lightsail container service.
- is
Disabled Boolean - A Boolean value to indicate whether the container service is disabled.
- private
Registry Property MapAccess - 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 List<Property Map>Names - The public domain names to use with the container service, such as example.com and www.example.com.
- 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:
- Container
Arn string - The Amazon Resource Name (ARN) of the container.
- Id string
- The provider-assigned unique ID for this managed resource.
- Principal
Arn string - The principal ARN of the container service.
- Url string
- The publicly accessible URL of the container service.
- Container
Arn string - The Amazon Resource Name (ARN) of the container.
- Id string
- The provider-assigned unique ID for this managed resource.
- Principal
Arn string - The principal ARN of the container service.
- Url string
- The publicly accessible URL of the container service.
- container
Arn String - The Amazon Resource Name (ARN) of the container.
- id String
- The provider-assigned unique ID for this managed resource.
- principal
Arn String - The principal ARN of the container service.
- url String
- The publicly accessible URL of the container service.
- container
Arn string - The Amazon Resource Name (ARN) of the container.
- id string
- The provider-assigned unique ID for this managed resource.
- principal
Arn 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.
- container
Arn String - The Amazon Resource Name (ARN) of the container.
- id String
- The provider-assigned unique ID for this managed resource.
- principal
Arn 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.
- Container
Name string - The name of the container.
- Environment
List<Pulumi.
Aws Native. Lightsail. Inputs. Container Environment Variable> - The environment variables of the container.
- Image string
- The name of the image used for the container.
- Ports
List<Pulumi.
Aws Native. Lightsail. Inputs. Container Port Info> - The open firewall ports of the container.
- Command []string
- The launch command for the container.
- Container
Name string - The name of the container.
- Environment
[]Container
Environment Variable - The environment variables of the container.
- Image string
- The name of the image used for the container.
- Ports
[]Container
Port Info - The open firewall ports of the container.
- command List<String>
- The launch command for the container.
- container
Name String - The name of the container.
- environment
List<Container
Environment Variable> - The environment variables of the container.
- image String
- The name of the image used for the container.
- ports
List<Container
Port Info> - The open firewall ports of the container.
- command string[]
- The launch command for the container.
- container
Name string - The name of the container.
- environment
Container
Environment Variable[] - The environment variables of the container.
- image string
- The name of the image used for the container.
- ports
Container
Port Info[] - 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[Container
Environment Variable] - The environment variables of the container.
- image str
- The name of the image used for the container.
- ports
Sequence[Container
Port Info] - The open firewall ports of the container.
- command List<String>
- The launch command for the container.
- container
Name 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
ContainerHealthCheckConfig, ContainerHealthCheckConfigArgs
- 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 string
- The path on the container on which to perform the health check. The default value is /.
- Success
Codes 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).
- 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.
- 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 string
- The path on the container on which to perform the health check. The default value is /.
- Success
Codes 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).
- 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.
- healthy
Threshold Integer - The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
- interval
Seconds 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 /.
- success
Codes 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).
- timeout
Seconds 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.
- unhealthy
Threshold Integer - The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.
- healthy
Threshold number - The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
- interval
Seconds 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 /.
- success
Codes 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).
- timeout
Seconds 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.
- unhealthy
Threshold 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.
- healthy
Threshold Number - The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
- interval
Seconds 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 /.
- success
Codes 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).
- timeout
Seconds 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.
- unhealthy
Threshold Number - The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.
ContainerPortInfo, ContainerPortInfoArgs
ContainerPrivateRegistryAccess, ContainerPrivateRegistryAccessArgs
- Ecr
Image Pulumi.Puller Role Aws Native. Lightsail. Inputs. Container Private Registry Access Ecr Image Puller Role Properties - 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 ContainerPuller Role Private Registry Access Ecr Image Puller Role Properties - 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 ContainerPuller Role Private Registry Access Ecr Image Puller Role Properties - 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 ContainerPuller Role Private Registry Access Ecr Image Puller Role Properties - 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_ Containerpuller_ role Private Registry Access Ecr Image Puller Role Properties - 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 Property MapPuller Role - 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
- Is
Active bool - A Boolean value that indicates whether to activate the role.
- Principal
Arn 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 string - The Amazon Resource Name (ARN) of the role, if it is activated.
- is
Active Boolean - A Boolean value that indicates whether to activate the role.
- principal
Arn String - The Amazon Resource Name (ARN) of the role, if it is activated.
- is
Active boolean - A Boolean value that indicates whether to activate the role.
- principal
Arn 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.
- is
Active Boolean - A Boolean value that indicates whether to activate the role.
- principal
Arn String - The Amazon Resource Name (ARN) of the role, if it is activated.
ContainerPublicDomainName, ContainerPublicDomainNameArgs
- Certificate
Name string - The name of the certificate for the public domains.
- Domain
Names List<string> - An object that describes the configuration for the containers of the deployment.
- Certificate
Name string - The name of the certificate for the public domains.
- Domain
Names []string - An object that describes the configuration for the containers of the deployment.
- certificate
Name String - The name of the certificate for the public domains.
- domain
Names List<String> - An object that describes the configuration for the containers of the deployment.
- certificate
Name string - The name of the certificate for the public domains.
- domain
Names 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.
- certificate
Name String - The name of the certificate for the public domains.
- domain
Names List<String> - An object that describes the configuration for the containers of the deployment.
ContainerPublicEndpoint, ContainerPublicEndpointArgs
- Container
Name string - The name of the container for the endpoint.
- Container
Port int - The port of the container to which traffic is forwarded to.
- Health
Check Pulumi.Config Aws Native. Lightsail. Inputs. Container Health Check Config - An object that describes the health check configuration of the container.
- Container
Name string - The name of the container for the endpoint.
- Container
Port int - The port of the container to which traffic is forwarded to.
- Health
Check ContainerConfig Health Check Config - An object that describes the health check configuration of the container.
- container
Name String - The name of the container for the endpoint.
- container
Port Integer - The port of the container to which traffic is forwarded to.
- health
Check ContainerConfig Health Check Config - An object that describes the health check configuration of the container.
- container
Name string - The name of the container for the endpoint.
- container
Port number - The port of the container to which traffic is forwarded to.
- health
Check ContainerConfig Health Check Config - 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_ Containerconfig Health Check Config - An object that describes the health check configuration of the container.
- container
Name String - The name of the container for the endpoint.
- container
Port Number - The port of the container to which traffic is forwarded to.
- health
Check Property MapConfig - An object that describes the health check configuration of the container.
ContainerServiceDeployment, ContainerServiceDeploymentArgs
- Containers
List<Pulumi.
Aws Native. Lightsail. Inputs. Container> - An object that describes the configuration for the containers of the deployment.
- Public
Endpoint Pulumi.Aws Native. Lightsail. Inputs. Container Public Endpoint - An object that describes the endpoint of the deployment.
- Containers
[]Container
Type - An object that describes the configuration for the containers of the deployment.
- Public
Endpoint ContainerPublic Endpoint - An object that describes the endpoint of the deployment.
- containers List<Container>
- An object that describes the configuration for the containers of the deployment.
- public
Endpoint ContainerPublic Endpoint - An object that describes the endpoint of the deployment.
- containers Container[]
- An object that describes the configuration for the containers of the deployment.
- public
Endpoint ContainerPublic Endpoint - 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 ContainerPublic Endpoint - 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.
- public
Endpoint Property Map - An object that describes the endpoint of the deployment.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.