com.amazonaws.services.ecs.model

Class UpdateServiceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.UpdateServiceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateServiceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateServiceRequest()

Method Summary

Modifier and Type	Method and Description
UpdateServiceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<CapacityProviderStrategyItem>	getCapacityProviderStrategy() The capacity provider strategy to update the service to use.
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.
DeploymentConfiguration	getDeploymentConfiguration() Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Integer	getDesiredCount() The number of instantiations of the task to place and keep running in your service.
Boolean	getForceNewDeployment() Whether to force a new deployment of the service.
Integer	getHealthCheckGracePeriodSeconds() The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started.
NetworkConfiguration	getNetworkConfiguration()
String	getPlatformVersion() The platform version on which your tasks in the service are running.
String	getService() The name of the service to update.
String	getTaskDefinition() The family and revision (family:revision) or full ARN of the task definition to run in your service.
int	hashCode()
Boolean	isForceNewDeployment() Whether to force a new deployment of the service.
void	setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy to update the service to use.
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.
void	setDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration) Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
void	setDesiredCount(Integer desiredCount) The number of instantiations of the task to place and keep running in your service.
void	setForceNewDeployment(Boolean forceNewDeployment) Whether to force a new deployment of the service.
void	setHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds) The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started.
void	setNetworkConfiguration(NetworkConfiguration networkConfiguration)
void	setPlatformVersion(String platformVersion) The platform version on which your tasks in the service are running.
void	setService(String service) The name of the service to update.
void	setTaskDefinition(String taskDefinition) The family and revision (family:revision) or full ARN of the task definition to run in your service.
String	toString() Returns a string representation of this object.
UpdateServiceRequest	withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy) The capacity provider strategy to update the service to use.
UpdateServiceRequest	withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy to update the service to use.
UpdateServiceRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.
UpdateServiceRequest	withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration) Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
UpdateServiceRequest	withDesiredCount(Integer desiredCount) The number of instantiations of the task to place and keep running in your service.
UpdateServiceRequest	withForceNewDeployment(Boolean forceNewDeployment) Whether to force a new deployment of the service.
UpdateServiceRequest	withHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds) The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started.
UpdateServiceRequest	withNetworkConfiguration(NetworkConfiguration networkConfiguration)
UpdateServiceRequest	withPlatformVersion(String platformVersion) The platform version on which your tasks in the service are running.
UpdateServiceRequest	withService(String service) The name of the service to update.
UpdateServiceRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full ARN of the task definition to run in your service.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateServiceRequest

public UpdateServiceRequest()

Method Detail

setCluster

public void setCluster(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.

Parameters:

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.

getCluster

public String getCluster()

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.

withCluster

public UpdateServiceRequest withCluster(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.

Parameters:

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:

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

setService

public void setService(String service)

The name of the service to update.

Parameters:

service - The name of the service to update.

getService

public String getService()

The name of the service to update.

Returns:

The name of the service to update.

withService

public UpdateServiceRequest withService(String service)

The name of the service to update.

Parameters:

service - The name of the service to update.

Returns:

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

setDesiredCount

public void setDesiredCount(Integer desiredCount)

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

Parameters:

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

getDesiredCount

public Integer getDesiredCount()

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.

withDesiredCount

public UpdateServiceRequest withDesiredCount(Integer desiredCount)

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

Parameters:

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

Returns:

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

setTaskDefinition

public void setTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full 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.

Parameters:

taskDefinition - The family and revision (family:revision) or full 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.

getTaskDefinition

public String getTaskDefinition()

The family and revision (family:revision) or full 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 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.

withTaskDefinition

public UpdateServiceRequest withTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full 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.

Parameters:

taskDefinition - The family and revision (family:revision) or full 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:

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

getCapacityProviderStrategy

public List<CapacityProviderStrategyItem> getCapacityProviderStrategy()

The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

Returns:

The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

setCapacityProviderStrategy

public void setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

Parameters:

capacityProviderStrategy - The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

withCapacityProviderStrategy

public UpdateServiceRequest withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)

The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

NOTE: This method appends the values to the existing list (if any). Use setCapacityProviderStrategy(java.util.Collection) or withCapacityProviderStrategy(java.util.Collection) if you want to override the existing values.

Parameters:

capacityProviderStrategy - The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

Returns:

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

withCapacityProviderStrategy

public UpdateServiceRequest withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

Parameters:

capacityProviderStrategy - The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

Returns:

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

setDeploymentConfiguration

public void setDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

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

Parameters:

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

getDeploymentConfiguration

public DeploymentConfiguration getDeploymentConfiguration()

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.

withDeploymentConfiguration

public UpdateServiceRequest withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

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

Parameters:

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

Returns:

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

setNetworkConfiguration

public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)

Parameters:

networkConfiguration -

getNetworkConfiguration

public NetworkConfiguration getNetworkConfiguration()

Returns:

withNetworkConfiguration

public UpdateServiceRequest withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Parameters:

networkConfiguration -

Returns:

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

setPlatformVersion

public void setPlatformVersion(String platformVersion)

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Parameters:

platformVersion - The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

getPlatformVersion

public String getPlatformVersion()

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

withPlatformVersion

public UpdateServiceRequest withPlatformVersion(String platformVersion)

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Parameters:

platformVersion - The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

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

setForceNewDeployment

public void setForceNewDeployment(Boolean forceNewDeployment)

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

Parameters:

forceNewDeployment - Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination ( my_image:latest) or to roll Fargate tasks onto a newer platform version.

getForceNewDeployment

public Boolean getForceNewDeployment()

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

Returns:

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination ( my_image:latest) or to roll Fargate tasks onto a newer platform version.

withForceNewDeployment

public UpdateServiceRequest withForceNewDeployment(Boolean forceNewDeployment)

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

Parameters:

forceNewDeployment - Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination ( my_image:latest) or to roll Fargate tasks onto a newer platform version.

Returns:

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

isForceNewDeployment

public Boolean isForceNewDeployment()

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

Returns:

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination ( my_image:latest) or to roll Fargate tasks onto a newer platform version.

setHealthCheckGracePeriodSeconds

public void setHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Parameters:

healthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

getHealthCheckGracePeriodSeconds

public Integer getHealthCheckGracePeriodSeconds()

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Returns:

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

withHealthCheckGracePeriodSeconds

public UpdateServiceRequest withHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Parameters:

healthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateServiceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()