Class ContainerService

java.lang.Object
software.amazon.awssdk.services.lightsail.model.ContainerService
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContainerService.Builder,ContainerService>
@Generated("software.amazon.awssdk:codegen") public final class ContainerService extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContainerService.Builder,ContainerService>

Describes an Amazon Lightsail container service.

See Also:

  • Method Details

    • containerServiceName

      public final String containerServiceName()

      The name of the container service.

      Returns:
      The name of the container service.

    • arn

      public final String arn()

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

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

    • createdAt

      public final Instant createdAt()

      The timestamp when the container service was created.

      Returns:
      The timestamp when the container service was created.

    • location

      public final ResourceLocation location()

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

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

    • resourceType

      public final ResourceType resourceType()

      The Lightsail resource type of the container service.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The Lightsail resource type of the container service.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The Lightsail resource type of the container service.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The Lightsail resource type of the container service.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • power

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, power will return ContainerServicePowerName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from powerAsString().

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

      See Also:

    • powerAsString

      public final String powerAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, power will return ContainerServicePowerName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from powerAsString().

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

      See Also:

    • powerId

      public final String powerId()

      The ID of the power of the container service.

      Returns:
      The ID of the power of the container service.

    • state

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, state will return ContainerServiceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

      See Also:

    • stateAsString

      public final String stateAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, state will return ContainerServiceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

      See Also:

    • stateDetail

      public final 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.

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

    • scale

      public final Integer scale()

      The scale specification of the container service.

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

      Returns:
      The scale specification of the container service.

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

    • currentDeployment

      public final ContainerServiceDeployment currentDeployment()

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

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

    • nextDeployment

      public final 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.

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

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

    • isDisabled

      public final Boolean isDisabled()

      A Boolean value indicating whether the container service is disabled.

      Returns:
      A Boolean value indicating whether the container service is disabled.

    • principalArn

      public final 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.

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

    • privateDomainName

      public final 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.

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

    • hasPublicDomainNames

      public final boolean hasPublicDomainNames()
      For responses, this returns true if the service returned a value for the PublicDomainNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • publicDomainNames

      public final Map<String,List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPublicDomainNames() method.

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

    • url

      public final 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.

      Returns:
      The publicly accessible URL of the container service.

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

    • privateRegistryAccess

      public final 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.

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

    • toBuilder

      public ContainerService.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ContainerService.Builder,ContainerService>
      Returns:
      a builder for type T

    • builder

      public static ContainerService.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerService.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.