Create Container Service
lightsail_create_container_service | R Documentation |
Creates an Amazon Lightsail container service¶
Description¶
Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
Usage¶
lightsail_create_container_service(serviceName, power, scale, tags,
publicDomainNames, deployment, privateRegistryAccess)
Arguments¶
serviceName |
[required] The name for the container service. The name that you specify for your container service will make up
part of its default domain. The default domain of a container service is
typically The following are the requirements for container service names:
|
power |
[required] The power specification for the container service. The power specifies the amount of memory, vCPUs, and base monthly
cost of each node of the container service. The Use the |
scale |
[required] The scale specification for the container service. The scale specifies the allocated compute nodes of the container
service. The |
tags |
The tag keys and optional values to add to the container service during create. Use the For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. |
publicDomainNames |
The public domain names to use with the container service, such
as 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. You must create and validate an SSL/TLS certificate before you can
use public domain names with your container service. Use the
You can specify public domain names using a string to array map as shown in the example later on this page. |
deployment |
An object that describes a deployment for the container service. A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration. |
privateRegistryAccess |
An object to describe 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. |
Value¶
A list with the following syntax:
list(
containerService = list(
containerServiceName = "string",
arn = "string",
createdAt = as.POSIXct(
"2015-01-01"
),
location = list(
availabilityZone = "string",
regionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1"
),
resourceType = "ContainerService"|"Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|"Bucket",
tags = list(
list(
key = "string",
value = "string"
)
),
power = "nano"|"micro"|"small"|"medium"|"large"|"xlarge",
powerId = "string",
state = "PENDING"|"READY"|"RUNNING"|"UPDATING"|"DELETING"|"DISABLED"|"DEPLOYING",
stateDetail = list(
code = "CREATING_SYSTEM_RESOURCES"|"CREATING_NETWORK_INFRASTRUCTURE"|"PROVISIONING_CERTIFICATE"|"PROVISIONING_SERVICE"|"CREATING_DEPLOYMENT"|"EVALUATING_HEALTH_CHECK"|"ACTIVATING_DEPLOYMENT"|"CERTIFICATE_LIMIT_EXCEEDED"|"UNKNOWN_ERROR",
message = "string"
),
scale = 123,
currentDeployment = list(
version = 123,
state = "ACTIVATING"|"ACTIVE"|"INACTIVE"|"FAILED",
containers = list(
list(
image = "string",
command = list(
"string"
),
environment = list(
"string"
),
ports = list(
"HTTP"|"HTTPS"|"TCP"|"UDP"
)
)
),
publicEndpoint = list(
containerName = "string",
containerPort = 123,
healthCheck = list(
healthyThreshold = 123,
unhealthyThreshold = 123,
timeoutSeconds = 123,
intervalSeconds = 123,
path = "string",
successCodes = "string"
)
),
createdAt = as.POSIXct(
"2015-01-01"
)
),
nextDeployment = list(
version = 123,
state = "ACTIVATING"|"ACTIVE"|"INACTIVE"|"FAILED",
containers = list(
list(
image = "string",
command = list(
"string"
),
environment = list(
"string"
),
ports = list(
"HTTP"|"HTTPS"|"TCP"|"UDP"
)
)
),
publicEndpoint = list(
containerName = "string",
containerPort = 123,
healthCheck = list(
healthyThreshold = 123,
unhealthyThreshold = 123,
timeoutSeconds = 123,
intervalSeconds = 123,
path = "string",
successCodes = "string"
)
),
createdAt = as.POSIXct(
"2015-01-01"
)
),
isDisabled = TRUE|FALSE,
principalArn = "string",
privateDomainName = "string",
publicDomainNames = list(
list(
"string"
)
),
url = "string",
privateRegistryAccess = list(
ecrImagePullerRole = list(
isActive = TRUE|FALSE,
principalArn = "string"
)
)
)
)
Request syntax¶
svc$create_container_service(
serviceName = "string",
power = "nano"|"micro"|"small"|"medium"|"large"|"xlarge",
scale = 123,
tags = list(
list(
key = "string",
value = "string"
)
),
publicDomainNames = list(
list(
"string"
)
),
deployment = list(
containers = list(
list(
image = "string",
command = list(
"string"
),
environment = list(
"string"
),
ports = list(
"HTTP"|"HTTPS"|"TCP"|"UDP"
)
)
),
publicEndpoint = list(
containerName = "string",
containerPort = 123,
healthCheck = list(
healthyThreshold = 123,
unhealthyThreshold = 123,
timeoutSeconds = 123,
intervalSeconds = 123,
path = "string",
successCodes = "string"
)
)
),
privateRegistryAccess = list(
ecrImagePullerRole = list(
isActive = TRUE|FALSE
)
)
)