ContainerService - Amazon Lightsail
ContentsSee Also

ContainerService

Describes an Amazon Lightsail container service.

Contents

arn

The Amazon Resource Name (ARN) of the container service.

Type: String

Pattern: .*\S.*

Required: No

containerServiceName

The name of the container service.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$

Required: No

createdAt

The timestamp when the container service was created.

Type: Timestamp

Required: No

currentDeployment

An object that describes the current container deployment of the container service.

Type: ContainerServiceDeployment object

Required: No

isDisabled

A Boolean value indicating whether the container service is disabled.

Type: Boolean

Required: No

location

An object that describes the location of the container service, such as the AWS Region and Availability Zone.

Type: ResourceLocation object

Required: No

nextDeployment

An object that describes the next deployment of the container service.

This value is null when there is no deployment in a pending state.

Type: ContainerServiceDeployment object

Required: No

power

The power specification of the container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

Type: String

Valid Values: nano | micro | small | medium | large | xlarge

Required: No

powerId

The ID of the power of the container service.

Type: String

Required: No

principalArn

The principal ARN of the container service.

The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.

Type: String

Required: No

privateDomainName

The private domain name of the container service.

The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.

Type: String

Required: No

privateRegistryAccess

An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

Type: PrivateRegistryAccess object

Required: No

publicDomainNames

The public domain name of the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don't specify public domain names, then you can use the default domain of the container service.

Important

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.

Type: String to array of strings map

Required: No

resourceType

The Lightsail resource type of the container service.

Type: String

Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket

Required: No

scale

The scale specification of the container service.

The scale specifies the allocated compute nodes of the container service.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 20.

Required: No

state

The current state of the container service.

The following container service states are possible:

  • PENDING - The container service is being created.

  • READY - The container service is running but it does not have an active container deployment.

  • DEPLOYING - The container service is launching a container deployment.

  • RUNNING - The container service is running and it has an active container deployment.

  • UPDATING - The container service capacity or its custom domains are being updated.

  • DELETING - The container service is being deleted.

  • DISABLED - The container service is disabled, and its active deployment and containers, if any, are shut down.

Type: String

Valid Values: PENDING | READY | RUNNING | UPDATING | DELETING | DISABLED | DEPLOYING

Required: No

stateDetail

An object that describes the current state of the container service.

Note

The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

Type: ContainerServiceStateDetail object

Required: No

tags

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Type: Array of Tag objects

Required: No

url

The publicly accessible URL of the container service.

If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: