Class ExpressGatewayServiceConfiguration

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

Represents a specific configuration revision of an Express service, containing all the settings and parameters for that revision.

See Also:

  • Method Details

    • serviceRevisionArn

      public final String serviceRevisionArn()

      The ARN of the service revision.

      Returns:
      The ARN of the service revision.

    • executionRoleArn

      public final String executionRoleArn()

      The ARN of the task execution role for the service revision.

      Returns:
      The ARN of the task execution role for the service revision.

    • taskRoleArn

      public final String taskRoleArn()

      The ARN of the task role for the service revision.

      Returns:
      The ARN of the task role for the service revision.

    • taskDefinitionArn

      public final String taskDefinitionArn()

      The ARN of the task definition used by this service revision. This is present for all Express services and reflects the task definition in use, whether managed by Amazon ECS or provided by the customer.

      Returns:
      The ARN of the task definition used by this service revision. This is present for all Express services and reflects the task definition in use, whether managed by Amazon ECS or provided by the customer.

    • cpu

      public final String cpu()

      The CPU allocation for tasks in this service revision.

      Returns:
      The CPU allocation for tasks in this service revision.

    • memory

      public final String memory()

      The memory allocation for tasks in this service revision.

      Returns:
      The memory allocation for tasks in this service revision.

    • cpuArchitecture

      public final ExpressCpuArchitecture cpuArchitecture()

      The CPU architecture that the tasks in this service revision run on. This is the architecture from the task definition that the service revision uses, so it reflects the default or the previously configured architecture when the request that created the revision didn't specify one.

      Valid values:

      • X86_64 - The x86 64-bit architecture.

      • ARM64 - The 64-bit ARM architecture.

      This value isn't returned when the task definition for the service revision doesn't specify a runtime platform. Because the architecture comes from each service revision's own task definition, revisions of the same service can report different architectures.

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

      Returns:
      The CPU architecture that the tasks in this service revision run on. This is the architecture from the task definition that the service revision uses, so it reflects the default or the previously configured architecture when the request that created the revision didn't specify one.

      Valid values:

      • X86_64 - The x86 64-bit architecture.

      • ARM64 - The 64-bit ARM architecture.

      This value isn't returned when the task definition for the service revision doesn't specify a runtime platform. Because the architecture comes from each service revision's own task definition, revisions of the same service can report different architectures.

      See Also:

    • cpuArchitectureAsString

      public final String cpuArchitectureAsString()

      The CPU architecture that the tasks in this service revision run on. This is the architecture from the task definition that the service revision uses, so it reflects the default or the previously configured architecture when the request that created the revision didn't specify one.

      Valid values:

      • X86_64 - The x86 64-bit architecture.

      • ARM64 - The 64-bit ARM architecture.

      This value isn't returned when the task definition for the service revision doesn't specify a runtime platform. Because the architecture comes from each service revision's own task definition, revisions of the same service can report different architectures.

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

      Returns:
      The CPU architecture that the tasks in this service revision run on. This is the architecture from the task definition that the service revision uses, so it reflects the default or the previously configured architecture when the request that created the revision didn't specify one.

      Valid values:

      • X86_64 - The x86 64-bit architecture.

      • ARM64 - The 64-bit ARM architecture.

      This value isn't returned when the task definition for the service revision doesn't specify a runtime platform. Because the architecture comes from each service revision's own task definition, revisions of the same service can report different architectures.

      See Also:

    • networkConfiguration

      public final ExpressGatewayServiceNetworkConfiguration networkConfiguration()

      The network configuration for tasks in this service revision.

      Returns:
      The network configuration for tasks in this service revision.

    • healthCheckPath

      public final String healthCheckPath()

      The health check path for this service revision.

      Returns:
      The health check path for this service revision.

    • primaryContainer

      public final ExpressGatewayContainer primaryContainer()

      The primary container configuration for this service revision.

      Returns:
      The primary container configuration for this service revision.

    • scalingTarget

      public final ExpressGatewayScalingTarget scalingTarget()

      The auto-scaling configuration for this service revision.

      Returns:
      The auto-scaling configuration for this service revision.

    • hasIngressPaths

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

    • ingressPaths

      public final List<IngressPathSummary> ingressPaths()

      The entry point into this service revision.

      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 hasIngressPaths() method.

      Returns:
      The entry point into this service revision.

    • createdAt

      public final Instant createdAt()

      The Unix timestamp for when this service revision was created.

      Returns:
      The Unix timestamp for when this service revision was created.

    • toBuilder

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

    • builder

      public static ExpressGatewayServiceConfiguration.Builder builder()

    • serializableBuilderClass

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