createContainerService method

Future<CreateContainerServiceResult> createContainerService({ required ContainerServicePowerName power, required int scale, required String serviceName, ContainerServiceDeploymentRequest? deployment, Map<String, List<String>>? publicDomainNames, List<Tag>? tags, })

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.

May throw ServiceException. May throw InvalidInputException. May throw NotFoundException. May throw AccessDeniedException. May throw UnauthenticatedException.

Parameter power : 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 power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

Parameter scale : The scale specification for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Parameter serviceName : 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 https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) AWS region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

The following are the requirements for container service names:

• Must be unique within each AWS Region in your Lightsail account.
• Must contain 1 to 63 characters.
• Must contain only alphanumeric characters and hyphens.
• A hyphen (-) can separate words but cannot be at the start or end of the name.

Parameter 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.

Parameter publicDomainNames : The public domain names to use with 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. You can specify public domain names using a string to array map as shown in the example later on this page.

Parameter tags : The tag keys and optional values for the container service.

For more information about tags in Lightsail, see the Lightsail Dev Guide.

Implementation

Future<CreateContainerServiceResult> createContainerService({
  required ContainerServicePowerName power,
  required int scale,
  required String serviceName,
  ContainerServiceDeploymentRequest? deployment,
  Map<String, List<String>>? publicDomainNames,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(power, 'power');
  ArgumentError.checkNotNull(scale, 'scale');
  _s.validateNumRange(
    'scale',
    scale,
    1,
    20,
    isRequired: true,
  );
  ArgumentError.checkNotNull(serviceName, 'serviceName');
  _s.validateStringLength(
    'serviceName',
    serviceName,
    1,
    63,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Lightsail_20161128.CreateContainerService'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'power': power.toValue(),
      'scale': scale,
      'serviceName': serviceName,
      if (deployment != null) 'deployment': deployment,
      if (publicDomainNames != null) 'publicDomainNames': publicDomainNames,
      if (tags != null) 'tags': tags,
    },
  );

  return CreateContainerServiceResult.fromJson(jsonResponse.body);
}