software.amazon.awssdk.services.ecs.model

Class UpdateServiceRequest

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

All Implemented Interfaces:

ToCopyableBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateServiceRequest
extends EcsRequest
implements ToCopyableBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateServiceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateServiceRequest.Builder	builder()
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.
DeploymentConfiguration	deploymentConfiguration() Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Integer	desiredCount() The number of instantiations of the task to place and keep running in your service.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
NetworkConfiguration	networkConfiguration() The network configuration for the service.
static Class<? extends UpdateServiceRequest.Builder>	serializableBuilderClass()
String	service() The name of the service to update.
String	taskDefinition() The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service.
UpdateServiceRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

cluster

public String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

service

public String service()

The name of the service to update.

Returns:

The name of the service to update.

desiredCount

public Integer desiredCount()

The number of instantiations of the task to place and keep running in your service.

Returns:

The number of instantiations of the task to place and keep running in your service.

taskDefinition

public String taskDefinition()

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

Returns:

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

deploymentConfiguration

public DeploymentConfiguration deploymentConfiguration()

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Returns:

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

networkConfiguration

public NetworkConfiguration networkConfiguration()

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.

Returns:

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.

toBuilder

public UpdateServiceRequest.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<UpdateServiceRequest.Builder,UpdateServiceRequest>

Specified by:

toBuilder in class EcsRequest

Returns:

a builder for type T

builder

public static UpdateServiceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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