Package software.amazon.awssdk.services.lightsail.model

Interface ContainerService.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ContainerService.Builder,ContainerService>, SdkBuilder<ContainerService.Builder,ContainerService>, SdkPojo
Enclosing class:
ContainerService
public static interface ContainerService.Builder extends SdkPojo, CopyableBuilder<ContainerService.Builder,ContainerService>

  • Method Details

    • containerServiceName

      ContainerService.Builder containerServiceName(String containerServiceName)

      The name of the container service.

      Parameters:
      containerServiceName - The name of the container service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      ContainerService.Builder arn(String arn)

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

      Parameters:
      arn - The Amazon Resource Name (ARN) of the container service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      ContainerService.Builder createdAt(Instant createdAt)

      The timestamp when the container service was created.

      Parameters:
      createdAt - The timestamp when the container service was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      ContainerService.Builder location(ResourceLocation location)

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

      Parameters:
      location - An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      default ContainerService.Builder location(Consumer<ResourceLocation.Builder> location)

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

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

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

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

    • resourceType

      ContainerService.Builder resourceType(String resourceType)

      The Lightsail resource type of the container service.

      Parameters:
      resourceType - The Lightsail resource type of the container service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      ContainerService.Builder resourceType(ResourceType resourceType)

      The Lightsail resource type of the container service.

      Parameters:
      resourceType - The Lightsail resource type of the container service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      ContainerService.Builder tags(Collection<Tag> tags)

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

      Parameters:
      tags - The tag keys and optional values for the resource. 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

      ContainerService.Builder tags(Tag... tags)

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

      Parameters:
      tags - The tag keys and optional values for the resource. 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

      ContainerService.Builder tags(Consumer<Tag.Builder>... tags)

      The tag keys and optional values for the resource. 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:

    • power

      ContainerService.Builder power(String 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.

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

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

    • power

      ContainerService.Builder power(ContainerServicePowerName 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.

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

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

    • powerId

      ContainerService.Builder powerId(String powerId)

      The ID of the power of the container service.

      Parameters:
      powerId - The ID of the power of the container service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      ContainerService.Builder state(String 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.

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

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

    • state

      ContainerService.Builder state(ContainerServiceState 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.

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

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

    • stateDetail

      ContainerService.Builder stateDetail(ContainerServiceStateDetail stateDetail)

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

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

      Parameters:
      stateDetail - An object that describes the current state of the container service.

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

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

    • stateDetail

      default ContainerService.Builder stateDetail(Consumer<ContainerServiceStateDetail.Builder> stateDetail)

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

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

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

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

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

    • scale

      ContainerService.Builder scale(Integer scale)

      The scale specification of the container service.

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

      Parameters:
      scale - The scale specification of the container service.

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

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

    • currentDeployment

      ContainerService.Builder currentDeployment(ContainerServiceDeployment currentDeployment)

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

      Parameters:
      currentDeployment - An object that describes the current container deployment of the container service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • currentDeployment

      default ContainerService.Builder currentDeployment(Consumer<ContainerServiceDeployment.Builder> currentDeployment)

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

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

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

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

    • nextDeployment

      ContainerService.Builder nextDeployment(ContainerServiceDeployment 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.

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

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

    • nextDeployment

      default ContainerService.Builder nextDeployment(Consumer<ContainerServiceDeployment.Builder> 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.

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

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

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

    • isDisabled

      ContainerService.Builder isDisabled(Boolean isDisabled)

      A Boolean value indicating whether the container service is disabled.

      Parameters:
      isDisabled - A Boolean value indicating whether the container service is disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • principalArn

      ContainerService.Builder principalArn(String principalArn)

      The principal ARN of the container service.

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

      Parameters:
      principalArn - The principal ARN of the container service.

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

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

    • privateDomainName

      ContainerService.Builder privateDomainName(String 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.

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

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

    • publicDomainNames

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

      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.

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

      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.

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

    • url

      ContainerService.Builder url(String url)

      The publicly accessible URL of the container service.

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

      Parameters:
      url - The publicly accessible URL of the container service.

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

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

    • privateRegistryAccess

      ContainerService.Builder privateRegistryAccess(PrivateRegistryAccess 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.

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

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

    • privateRegistryAccess

      default ContainerService.Builder privateRegistryAccess(Consumer<PrivateRegistryAccess.Builder> 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.

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

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

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