Interface UpdateExpressGatewayServiceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateExpressGatewayServiceRequest.Builder,UpdateExpressGatewayServiceRequest>, EcsRequest.Builder, SdkBuilder<UpdateExpressGatewayServiceRequest.Builder,UpdateExpressGatewayServiceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateExpressGatewayServiceRequest

@Mutable
@NotThreadSafe
public static interface UpdateExpressGatewayServiceRequest.Builder
extends EcsRequest.Builder, SdkPojo, CopyableBuilder<UpdateExpressGatewayServiceRequest.Builder,UpdateExpressGatewayServiceRequest>

Method Summary

Modifier and Type	Method	Description
UpdateExpressGatewayServiceRequest.Builder	cpu(String cpu)	The number of CPU units used by the task.
UpdateExpressGatewayServiceRequest.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the task execution role for the Express service.
UpdateExpressGatewayServiceRequest.Builder	healthCheckPath(String healthCheckPath)	The path on the container for Application Load Balancer health checks.
UpdateExpressGatewayServiceRequest.Builder	memory(String memory)	The amount of memory (in MiB) used by the task.
default UpdateExpressGatewayServiceRequest.Builder	networkConfiguration(Consumer<ExpressGatewayServiceNetworkConfiguration.Builder> networkConfiguration)	The network configuration for the Express service tasks.
UpdateExpressGatewayServiceRequest.Builder	networkConfiguration(ExpressGatewayServiceNetworkConfiguration networkConfiguration)	The network configuration for the Express service tasks.
UpdateExpressGatewayServiceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateExpressGatewayServiceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateExpressGatewayServiceRequest.Builder	primaryContainer(Consumer<ExpressGatewayContainer.Builder> primaryContainer)	The primary container configuration for the Express service.
UpdateExpressGatewayServiceRequest.Builder	primaryContainer(ExpressGatewayContainer primaryContainer)	The primary container configuration for the Express service.
default UpdateExpressGatewayServiceRequest.Builder	scalingTarget(Consumer<ExpressGatewayScalingTarget.Builder> scalingTarget)	The auto-scaling configuration for the Express service.
UpdateExpressGatewayServiceRequest.Builder	scalingTarget(ExpressGatewayScalingTarget scalingTarget)	The auto-scaling configuration for the Express service.
UpdateExpressGatewayServiceRequest.Builder	serviceArn(String serviceArn)	The Amazon Resource Name (ARN) of the Express service to update.
UpdateExpressGatewayServiceRequest.Builder	taskDefinitionArn(String taskDefinitionArn)	The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service.
UpdateExpressGatewayServiceRequest.Builder	taskRoleArn(String taskRoleArn)	The Amazon Resource Name (ARN) of the IAM role for containers in this task.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

serviceArn

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

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

default UpdateExpressGatewayServiceRequest.Builder primaryContainer(Consumer<ExpressGatewayContainer.Builder> 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:

• primaryContainer(ExpressGatewayContainer)

taskRoleArn

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

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

default UpdateExpressGatewayServiceRequest.Builder networkConfiguration(Consumer<ExpressGatewayServiceNetworkConfiguration.Builder> 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:

• networkConfiguration(ExpressGatewayServiceNetworkConfiguration)

cpu

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

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

scalingTarget

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

default UpdateExpressGatewayServiceRequest.Builder scalingTarget(Consumer<ExpressGatewayScalingTarget.Builder> 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:

• scalingTarget(ExpressGatewayScalingTarget)

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, taskRoleArn, cpu, or memory.

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, taskRoleArn, cpu, or memory.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

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

UpdateExpressGatewayServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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.