Class UpdateExpressGatewayServiceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ecs.model.EcsRequest
software.amazon.awssdk.services.ecs.model.UpdateExpressGatewayServiceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateExpressGatewayServiceRequest.Builder,UpdateExpressGatewayServiceRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateExpressGatewayServiceRequest extends EcsRequest implements ToCopyableBuilder<UpdateExpressGatewayServiceRequest.Builder,UpdateExpressGatewayServiceRequest>

  • Method Details

    • serviceArn

      public final String serviceArn()

      The Amazon Resource Name (ARN) of the Express service to update.

      Returns:
      The Amazon Resource Name (ARN) of the Express service to update.

    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the task execution role for the Express service.

      Returns:
      The Amazon Resource Name (ARN) of the task execution role for the Express service.

    • healthCheckPath

      public final String healthCheckPath()

      The path on the container for Application Load Balancer health checks.

      Returns:
      The path on the container for Application Load Balancer health checks.

    • primaryContainer

      public final ExpressGatewayContainer primaryContainer()

      The primary container configuration for the Express service.

      Returns:
      The primary container configuration for the Express service.

    • taskRoleArn

      public final String taskRoleArn()

      The Amazon Resource Name (ARN) of the IAM role for containers in this task.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role for containers in this task.

    • networkConfiguration

      public final ExpressGatewayServiceNetworkConfiguration networkConfiguration()

      The network configuration for the Express service tasks. By default, the network configuration for an Express service uses the default VPC.

      Returns:
      The network configuration for the Express service tasks. By default, the network configuration for an Express service uses the default VPC.

    • cpu

      public final String cpu()

      The number of CPU units used by the task.

      Returns:
      The number of CPU units used by the task.

    • memory

      public final String memory()

      The amount of memory (in MiB) used by the task.

      Returns:
      The amount of memory (in MiB) used by the task.

    • cpuArchitecture

      public final ExpressCpuArchitecture cpuArchitecture()

      The CPU architecture that the tasks in the Express service run on. Amazon ECS applies this value to the task definition revision that it registers for the service. If you don't specify a value, the service keeps the architecture that it currently runs on.

      Valid values:

      • X86_64 - The x86 64-bit architecture.

      • ARM64 - The 64-bit ARM architecture.

      Changing the architecture starts a new deployment that replaces the running tasks. Make sure that the container image that the service uses supports the architecture that you choose. The operating system family for an Express service is always LINUX.

      You can't specify cpuArchitecture when you also specify taskDefinitionArn, because this value applies only to a task definition that Amazon ECS registers on your behalf.

      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 the Express service run on. Amazon ECS applies this value to the task definition revision that it registers for the service. If you don't specify a value, the service keeps the architecture that it currently runs on.

      Valid values:

      • X86_64 - The x86 64-bit architecture.

      • ARM64 - The 64-bit ARM architecture.

      Changing the architecture starts a new deployment that replaces the running tasks. Make sure that the container image that the service uses supports the architecture that you choose. The operating system family for an Express service is always LINUX.

      You can't specify cpuArchitecture when you also specify taskDefinitionArn, because this value applies only to a task definition that Amazon ECS registers on your behalf.

      See Also:

    • cpuArchitectureAsString

      public final String cpuArchitectureAsString()

      The CPU architecture that the tasks in the Express service run on. Amazon ECS applies this value to the task definition revision that it registers for the service. If you don't specify a value, the service keeps the architecture that it currently runs on.

      Valid values:

      • X86_64 - The x86 64-bit architecture.

      • ARM64 - The 64-bit ARM architecture.

      Changing the architecture starts a new deployment that replaces the running tasks. Make sure that the container image that the service uses supports the architecture that you choose. The operating system family for an Express service is always LINUX.

      You can't specify cpuArchitecture when you also specify taskDefinitionArn, because this value applies only to a task definition that Amazon ECS registers on your behalf.

      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 the Express service run on. Amazon ECS applies this value to the task definition revision that it registers for the service. If you don't specify a value, the service keeps the architecture that it currently runs on.

      Valid values:

      • X86_64 - The x86 64-bit architecture.

      • ARM64 - The 64-bit ARM architecture.

      Changing the architecture starts a new deployment that replaces the running tasks. Make sure that the container image that the service uses supports the architecture that you choose. The operating system family for an Express service is always LINUX.

      You can't specify cpuArchitecture when you also specify taskDefinitionArn, because this value applies only to a task definition that Amazon ECS registers on your behalf.

      See Also:

    • scalingTarget

      public final ExpressGatewayScalingTarget scalingTarget()

      The auto-scaling configuration for the Express service.

      Returns:
      The auto-scaling configuration for the Express service.

    • taskDefinitionArn

      public final String taskDefinitionArn()

      The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.

      The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility.

      If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, memory, or cpuArchitecture.

      Returns:
      The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.

      The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility.

      If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, memory, or cpuArchitecture.

    • toBuilder

      public UpdateExpressGatewayServiceRequest.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<UpdateExpressGatewayServiceRequest.Builder,UpdateExpressGatewayServiceRequest>
      Specified by:
      toBuilder in class EcsRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateExpressGatewayServiceRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.