Class ECSExpressGatewayService

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

Represents an Express service, which provides a simplified way to deploy containerized web applications on Amazon ECS with managed Amazon Web Services infrastructure. An Express service automatically provisions and manages Application Load Balancers, target groups, security groups, and auto-scaling policies.

Express services use a service revision architecture where each service can have multiple active configurations, enabling blue-green deployments and gradual rollouts. The service maintains a list of active configurations and manages the lifecycle of the underlying Amazon Web Services resources.

See Also:

  • Method Details

    • cluster

      public final String cluster()

      The short name or full ARN of the cluster that hosts the Express service.

      Returns:
      The short name or full ARN of the cluster that hosts the Express service.

    • serviceName

      public final String serviceName()

      The name of the Express service.

      Returns:
      The name of the Express service.

    • serviceArn

      public final String serviceArn()

      The ARN that identifies the Express service.

      Returns:
      The ARN that identifies the Express service.

    • infrastructureRoleArn

      public final String infrastructureRoleArn()

      The ARN of the infrastructure role that manages Amazon Web Services resources for the Express service.

      Returns:
      The ARN of the infrastructure role that manages Amazon Web Services resources for the Express service.

    • status

      public final ExpressGatewayServiceStatus status()

      The current status of the Express service.

      Returns:
      The current status of the Express service.

    • currentDeployment

      public final String currentDeployment()

      The current deployment configuration for the Express service.

      Returns:
      The current deployment configuration for the Express service.

    • hasActiveConfigurations

      public final boolean hasActiveConfigurations()
      For responses, this returns true if the service returned a value for the ActiveConfigurations 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.

    • activeConfigurations

      public final List<ExpressGatewayServiceConfiguration> activeConfigurations()

      The list of active service configurations for the Express 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 hasActiveConfigurations() method.

      Returns:
      The list of active service configurations for the Express service.

    • 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 metadata applied to the Express 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 hasTags() method.

      Returns:
      The metadata applied to the Express service.

    • createdAt

      public final Instant createdAt()

      The Unix timestamp for when the Express service was created.

      Returns:
      The Unix timestamp for when the Express service was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp for when the Express service was last updated.

      Returns:
      The Unix timestamp for when the Express service was last updated.

    • toBuilder

      public ECSExpressGatewayService.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<ECSExpressGatewayService.Builder,ECSExpressGatewayService>
      Returns:
      a builder for type T

    • builder

      public static ECSExpressGatewayService.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ECSExpressGatewayService.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.