Interface CreateContainerServiceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateContainerServiceRequest.Builder,CreateContainerServiceRequest>, LightsailRequest.Builder, SdkBuilder<CreateContainerServiceRequest.Builder,CreateContainerServiceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateContainerServiceRequest

public static interface CreateContainerServiceRequest.Builder extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<CreateContainerServiceRequest.Builder,CreateContainerServiceRequest>
  • Method Details

    • 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) Amazon Web Services 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 Amazon Web Services 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.

      Parameters:
      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) Amazon Web Services 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 Amazon Web Services 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      The tag keys and optional values to add to the container service during create.

      Use the TagResource action to tag a resource after it's created.

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

      Parameters:
      tags - The tag keys and optional values to add to the container service during create.

      Use the TagResource action to tag a resource after it's created.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      The tag keys and optional values to add to the container service during create.

      Use the TagResource action to tag a resource after it's created.

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

      Parameters:
      tags - The tag keys and optional values to add to the container service during create.

      Use the TagResource action to tag a resource after it's created.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      The tag keys and optional values to add to the container service during create.

      Use the TagResource action to tag a resource after it's created.

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

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • publicDomainNames

      CreateContainerServiceRequest.Builder publicDomainNames(Map<String,? extends Collection<String>> 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 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.

      You can specify public domain names using a string to array map as shown in the example later on this page.

      Parameters:
      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 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.

      You can specify public domain names using a string to array map as shown in the example later on this page.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      This is a convenience method that creates an instance of the ContainerServiceDeploymentRequest.Builder avoiding the need to create one manually via ContainerServiceDeploymentRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deployment(ContainerServiceDeploymentRequest).

      Parameters:
      deployment - a consumer that will call methods on ContainerServiceDeploymentRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • privateRegistryAccess

      CreateContainerServiceRequest.Builder privateRegistryAccess(PrivateRegistryAccessRequest 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • privateRegistryAccess

      default CreateContainerServiceRequest.Builder privateRegistryAccess(Consumer<PrivateRegistryAccessRequest.Builder> 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.

      This is a convenience method that creates an instance of the PrivateRegistryAccessRequest.Builder avoiding the need to create one manually via PrivateRegistryAccessRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to privateRegistryAccess(PrivateRegistryAccessRequest).

      Parameters:
      privateRegistryAccess - a consumer that will call methods on PrivateRegistryAccessRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateContainerServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.