Interface UpdateExpressGatewayServiceRequest.Builder

  • Method Details

    • serviceArn

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

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

      UpdateExpressGatewayServiceRequest.Builder executionRoleArn(String executionRoleArn)

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

      Parameters:
      executionRoleArn - The Amazon Resource Name (ARN) of the task execution role for the Express service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • healthCheckPath

      UpdateExpressGatewayServiceRequest.Builder healthCheckPath(String healthCheckPath)

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

      Parameters:
      healthCheckPath - The path on the container for Application Load Balancer health checks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • primaryContainer

      The primary container configuration for the Express service.

      Parameters:
      primaryContainer - The primary container configuration for the Express service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • primaryContainer

      The primary container configuration for the Express service.

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

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

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

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

      Parameters:
      taskRoleArn - The Amazon Resource Name (ARN) of the IAM role for containers in this task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • networkConfiguration

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

      Parameters:
      networkConfiguration - The network configuration for the Express service tasks. By default, the network configuration for an Express service uses the default VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • networkConfiguration

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

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

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

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

      The number of CPU units used by the task.

      Parameters:
      cpu - The number of CPU units used by the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • memory

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

      Parameters:
      memory - The amount of memory (in MiB) used by the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • cpuArchitecture

      UpdateExpressGatewayServiceRequest.Builder cpuArchitecture(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

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

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

      The auto-scaling configuration for the Express service.

      Parameters:
      scalingTarget - The auto-scaling configuration for the Express service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scalingTarget

      The auto-scaling configuration for the Express service.

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

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

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

      UpdateExpressGatewayServiceRequest.Builder taskDefinitionArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.