@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Deployment extends Object implements Serializable, Cloneable, StructuredPojo
The details of an Amazon ECS service deployment. This is used only when a service uses the ECS
deployment controller type.
Constructor and Description |
---|
Deployment() |
Modifier and Type | Method and Description |
---|---|
Deployment |
clone() |
boolean |
equals(Object obj) |
List<CapacityProviderStrategyItem> |
getCapacityProviderStrategy()
The capacity provider strategy that the deployment is using.
|
Date |
getCreatedAt()
The Unix timestamp for when the service deployment was created.
|
Integer |
getDesiredCount()
The most recent desired count of tasks that was specified for the service to deploy or maintain.
|
Integer |
getFailedTasks()
The number of consecutively failed tasks in the deployment.
|
String |
getId()
The ID of the deployment.
|
String |
getLaunchType()
The launch type the tasks in the service are using.
|
NetworkConfiguration |
getNetworkConfiguration()
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the
awsvpc networking mode. |
Integer |
getPendingCount()
The number of tasks in the deployment that are in the
PENDING status. |
String |
getPlatformVersion()
The platform version on which your tasks in the service are running.
|
String |
getRolloutState()
|
String |
getRolloutStateReason()
A description of the rollout state of a deployment.
|
Integer |
getRunningCount()
The number of tasks in the deployment that are in the
RUNNING status. |
String |
getStatus()
The status of the deployment.
|
String |
getTaskDefinition()
The most recent task definition that was specified for the tasks in the service to use.
|
Date |
getUpdatedAt()
The Unix timestamp for when the service deployment was last updated.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy that the deployment is using.
|
void |
setCreatedAt(Date createdAt)
The Unix timestamp for when the service deployment was created.
|
void |
setDesiredCount(Integer desiredCount)
The most recent desired count of tasks that was specified for the service to deploy or maintain.
|
void |
setFailedTasks(Integer failedTasks)
The number of consecutively failed tasks in the deployment.
|
void |
setId(String id)
The ID of the deployment.
|
void |
setLaunchType(String launchType)
The launch type the tasks in the service are using.
|
void |
setNetworkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the
awsvpc networking mode. |
void |
setPendingCount(Integer pendingCount)
The number of tasks in the deployment that are in the
PENDING status. |
void |
setPlatformVersion(String platformVersion)
The platform version on which your tasks in the service are running.
|
void |
setRolloutState(String rolloutState)
|
void |
setRolloutStateReason(String rolloutStateReason)
A description of the rollout state of a deployment.
|
void |
setRunningCount(Integer runningCount)
The number of tasks in the deployment that are in the
RUNNING status. |
void |
setStatus(String status)
The status of the deployment.
|
void |
setTaskDefinition(String taskDefinition)
The most recent task definition that was specified for the tasks in the service to use.
|
void |
setUpdatedAt(Date updatedAt)
The Unix timestamp for when the service deployment was last updated.
|
String |
toString()
Returns a string representation of this object.
|
Deployment |
withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy that the deployment is using.
|
Deployment |
withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy that the deployment is using.
|
Deployment |
withCreatedAt(Date createdAt)
The Unix timestamp for when the service deployment was created.
|
Deployment |
withDesiredCount(Integer desiredCount)
The most recent desired count of tasks that was specified for the service to deploy or maintain.
|
Deployment |
withFailedTasks(Integer failedTasks)
The number of consecutively failed tasks in the deployment.
|
Deployment |
withId(String id)
The ID of the deployment.
|
Deployment |
withLaunchType(LaunchType launchType)
The launch type the tasks in the service are using.
|
Deployment |
withLaunchType(String launchType)
The launch type the tasks in the service are using.
|
Deployment |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the
awsvpc networking mode. |
Deployment |
withPendingCount(Integer pendingCount)
The number of tasks in the deployment that are in the
PENDING status. |
Deployment |
withPlatformVersion(String platformVersion)
The platform version on which your tasks in the service are running.
|
Deployment |
withRolloutState(DeploymentRolloutState rolloutState)
|
Deployment |
withRolloutState(String rolloutState)
|
Deployment |
withRolloutStateReason(String rolloutStateReason)
A description of the rollout state of a deployment.
|
Deployment |
withRunningCount(Integer runningCount)
The number of tasks in the deployment that are in the
RUNNING status. |
Deployment |
withStatus(String status)
The status of the deployment.
|
Deployment |
withTaskDefinition(String taskDefinition)
The most recent task definition that was specified for the tasks in the service to use.
|
Deployment |
withUpdatedAt(Date updatedAt)
The Unix timestamp for when the service deployment was last updated.
|
public void setId(String id)
The ID of the deployment.
id
- The ID of the deployment.public String getId()
The ID of the deployment.
public Deployment withId(String id)
The ID of the deployment.
id
- The ID of the deployment.public void setStatus(String status)
The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment.
A deployment that has been completely replaced.
status
- The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment.
A deployment that has been completely replaced.
public String getStatus()
The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment.
A deployment that has been completely replaced.
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment.
A deployment that has been completely replaced.
public Deployment withStatus(String status)
The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment.
A deployment that has been completely replaced.
status
- The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment.
A deployment that has been completely replaced.
public void setTaskDefinition(String taskDefinition)
The most recent task definition that was specified for the tasks in the service to use.
taskDefinition
- The most recent task definition that was specified for the tasks in the service to use.public String getTaskDefinition()
The most recent task definition that was specified for the tasks in the service to use.
public Deployment withTaskDefinition(String taskDefinition)
The most recent task definition that was specified for the tasks in the service to use.
taskDefinition
- The most recent task definition that was specified for the tasks in the service to use.public void setDesiredCount(Integer desiredCount)
The most recent desired count of tasks that was specified for the service to deploy or maintain.
desiredCount
- The most recent desired count of tasks that was specified for the service to deploy or maintain.public Integer getDesiredCount()
The most recent desired count of tasks that was specified for the service to deploy or maintain.
public Deployment withDesiredCount(Integer desiredCount)
The most recent desired count of tasks that was specified for the service to deploy or maintain.
desiredCount
- The most recent desired count of tasks that was specified for the service to deploy or maintain.public void setPendingCount(Integer pendingCount)
The number of tasks in the deployment that are in the PENDING
status.
pendingCount
- The number of tasks in the deployment that are in the PENDING
status.public Integer getPendingCount()
The number of tasks in the deployment that are in the PENDING
status.
PENDING
status.public Deployment withPendingCount(Integer pendingCount)
The number of tasks in the deployment that are in the PENDING
status.
pendingCount
- The number of tasks in the deployment that are in the PENDING
status.public void setRunningCount(Integer runningCount)
The number of tasks in the deployment that are in the RUNNING
status.
runningCount
- The number of tasks in the deployment that are in the RUNNING
status.public Integer getRunningCount()
The number of tasks in the deployment that are in the RUNNING
status.
RUNNING
status.public Deployment withRunningCount(Integer runningCount)
The number of tasks in the deployment that are in the RUNNING
status.
runningCount
- The number of tasks in the deployment that are in the RUNNING
status.public void setFailedTasks(Integer failedTasks)
The number of consecutively failed tasks in the deployment. A task is considered a failure if the service
scheduler can't launch the task, the task doesn't transition to a RUNNING
state, or if it fails any
of its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
failedTasks
- The number of consecutively failed tasks in the deployment. A task is considered a failure if the service
scheduler can't launch the task, the task doesn't transition to a RUNNING
state, or if it
fails any of its defined health checks and is stopped. Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
public Integer getFailedTasks()
The number of consecutively failed tasks in the deployment. A task is considered a failure if the service
scheduler can't launch the task, the task doesn't transition to a RUNNING
state, or if it fails any
of its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
RUNNING
state, or if it
fails any of its defined health checks and is stopped. Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
public Deployment withFailedTasks(Integer failedTasks)
The number of consecutively failed tasks in the deployment. A task is considered a failure if the service
scheduler can't launch the task, the task doesn't transition to a RUNNING
state, or if it fails any
of its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
failedTasks
- The number of consecutively failed tasks in the deployment. A task is considered a failure if the service
scheduler can't launch the task, the task doesn't transition to a RUNNING
state, or if it
fails any of its defined health checks and is stopped. Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
public void setCreatedAt(Date createdAt)
The Unix timestamp for when the service deployment was created.
createdAt
- The Unix timestamp for when the service deployment was created.public Date getCreatedAt()
The Unix timestamp for when the service deployment was created.
public Deployment withCreatedAt(Date createdAt)
The Unix timestamp for when the service deployment was created.
createdAt
- The Unix timestamp for when the service deployment was created.public void setUpdatedAt(Date updatedAt)
The Unix timestamp for when the service deployment was last updated.
updatedAt
- The Unix timestamp for when the service deployment was last updated.public Date getUpdatedAt()
The Unix timestamp for when the service deployment was last updated.
public Deployment withUpdatedAt(Date updatedAt)
The Unix timestamp for when the service deployment was last updated.
updatedAt
- The Unix timestamp for when the service deployment was last updated.public List<CapacityProviderStrategyItem> getCapacityProviderStrategy()
The capacity provider strategy that the deployment is using.
public void setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy that the deployment is using.
capacityProviderStrategy
- The capacity provider strategy that the deployment is using.public Deployment withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy that the deployment is using.
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.
capacityProviderStrategy
- The capacity provider strategy that the deployment is using.public Deployment withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy that the deployment is using.
capacityProviderStrategy
- The capacity provider strategy that the deployment is using.public void setLaunchType(String launchType)
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
launchType
- The launch type the tasks in the service are using. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.LaunchType
public String getLaunchType()
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
LaunchType
public Deployment withLaunchType(String launchType)
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
launchType
- The launch type the tasks in the service are using. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.LaunchType
public Deployment withLaunchType(LaunchType launchType)
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
launchType
- The launch type the tasks in the service are using. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.LaunchType
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 one 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.
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 one 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.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 one 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.
LATEST
platform
version is used by default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.public Deployment 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 one 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.
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 one 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.public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the awsvpc
networking mode.
networkConfiguration
- The VPC subnet and security group configuration for tasks that receive their own elastic network interface
by using the awsvpc
networking mode.public NetworkConfiguration getNetworkConfiguration()
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the awsvpc
networking mode.
awsvpc
networking mode.public Deployment withNetworkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the awsvpc
networking mode.
networkConfiguration
- The VPC subnet and security group configuration for tasks that receive their own elastic network interface
by using the awsvpc
networking mode.public void setRolloutState(String rolloutState)
The rolloutState
of a service is only returned for services that use the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition to a
COMPLETED
state. If the service fails to reach a steady state and circuit breaker is enabled, the
deployment will transition to a FAILED
state. A deployment in FAILED
state will launch
no new tasks. For more information, see DeploymentCircuitBreaker.
rolloutState
-
The rolloutState
of a service is only returned for services that use the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition to
a COMPLETED
state. If the service fails to reach a steady state and circuit breaker is
enabled, the deployment will transition to a FAILED
state. A deployment in
FAILED
state will launch no new tasks. For more information, see
DeploymentCircuitBreaker.
DeploymentRolloutState
public String getRolloutState()
The rolloutState
of a service is only returned for services that use the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition to a
COMPLETED
state. If the service fails to reach a steady state and circuit breaker is enabled, the
deployment will transition to a FAILED
state. A deployment in FAILED
state will launch
no new tasks. For more information, see DeploymentCircuitBreaker.
The rolloutState
of a service is only returned for services that use the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition
to a COMPLETED
state. If the service fails to reach a steady state and circuit breaker is
enabled, the deployment will transition to a FAILED
state. A deployment in
FAILED
state will launch no new tasks. For more information, see
DeploymentCircuitBreaker.
DeploymentRolloutState
public Deployment withRolloutState(String rolloutState)
The rolloutState
of a service is only returned for services that use the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition to a
COMPLETED
state. If the service fails to reach a steady state and circuit breaker is enabled, the
deployment will transition to a FAILED
state. A deployment in FAILED
state will launch
no new tasks. For more information, see DeploymentCircuitBreaker.
rolloutState
-
The rolloutState
of a service is only returned for services that use the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition to
a COMPLETED
state. If the service fails to reach a steady state and circuit breaker is
enabled, the deployment will transition to a FAILED
state. A deployment in
FAILED
state will launch no new tasks. For more information, see
DeploymentCircuitBreaker.
DeploymentRolloutState
public Deployment withRolloutState(DeploymentRolloutState rolloutState)
The rolloutState
of a service is only returned for services that use the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition to a
COMPLETED
state. If the service fails to reach a steady state and circuit breaker is enabled, the
deployment will transition to a FAILED
state. A deployment in FAILED
state will launch
no new tasks. For more information, see DeploymentCircuitBreaker.
rolloutState
-
The rolloutState
of a service is only returned for services that use the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition to
a COMPLETED
state. If the service fails to reach a steady state and circuit breaker is
enabled, the deployment will transition to a FAILED
state. A deployment in
FAILED
state will launch no new tasks. For more information, see
DeploymentCircuitBreaker.
DeploymentRolloutState
public void setRolloutStateReason(String rolloutStateReason)
A description of the rollout state of a deployment.
rolloutStateReason
- A description of the rollout state of a deployment.public String getRolloutStateReason()
A description of the rollout state of a deployment.
public Deployment withRolloutStateReason(String rolloutStateReason)
A description of the rollout state of a deployment.
rolloutStateReason
- A description of the rollout state of a deployment.public String toString()
toString
in class Object
Object.toString()
public Deployment clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.