Class Deployment
- All Implemented Interfaces:
Serializable
,Cloneable
Describes a deployment of a stack or app.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
getAppId()
The app ID.A user-defined comment.Date when the deployment completed.Date when the deployment was created.A string that contains user-defined custom JSON.The deployment ID.The deployment duration.The user's IAM ARN.The IDs of the target instances.The stack ID.The deployment status:int
hashCode()
void
The app ID.void
setCommand
(DeploymentCommand command) void
setComment
(String comment) A user-defined comment.void
setCompletedAt
(String completedAt) Date when the deployment completed.void
setCreatedAt
(String createdAt) Date when the deployment was created.void
setCustomJson
(String customJson) A string that contains user-defined custom JSON.void
setDeploymentId
(String deploymentId) The deployment ID.void
setDuration
(Integer duration) The deployment duration.void
setIamUserArn
(String iamUserArn) The user's IAM ARN.void
setInstanceIds
(Collection<String> instanceIds) The IDs of the target instances.void
setStackId
(String stackId) The stack ID.void
The deployment status:toString()
Returns a string representation of this object; useful for testing and debugging.The app ID.withCommand
(DeploymentCommand command) withComment
(String comment) A user-defined comment.withCompletedAt
(String completedAt) Date when the deployment completed.withCreatedAt
(String createdAt) Date when the deployment was created.withCustomJson
(String customJson) A string that contains user-defined custom JSON.withDeploymentId
(String deploymentId) The deployment ID.withDuration
(Integer duration) The deployment duration.withIamUserArn
(String iamUserArn) The user's IAM ARN.withInstanceIds
(String... instanceIds) The IDs of the target instances.withInstanceIds
(Collection<String> instanceIds) The IDs of the target instances.withStackId
(String stackId) The stack ID.withStatus
(String status) The deployment status:
-
Constructor Details
-
Deployment
public Deployment()
-
-
Method Details
-
setDeploymentId
The deployment ID.
- Parameters:
deploymentId
- The deployment ID.
-
getDeploymentId
The deployment ID.
- Returns:
- The deployment ID.
-
withDeploymentId
The deployment ID.
- Parameters:
deploymentId
- The deployment ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackId
The stack ID.
- Parameters:
stackId
- The stack ID.
-
getStackId
The stack ID.
- Returns:
- The stack ID.
-
withStackId
The stack ID.
- Parameters:
stackId
- The stack ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAppId
The app ID.
- Parameters:
appId
- The app ID.
-
getAppId
The app ID.
- Returns:
- The app ID.
-
withAppId
The app ID.
- Parameters:
appId
- The app ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreatedAt
Date when the deployment was created.
- Parameters:
createdAt
- Date when the deployment was created.
-
getCreatedAt
Date when the deployment was created.
- Returns:
- Date when the deployment was created.
-
withCreatedAt
Date when the deployment was created.
- Parameters:
createdAt
- Date when the deployment was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCompletedAt
Date when the deployment completed.
- Parameters:
completedAt
- Date when the deployment completed.
-
getCompletedAt
Date when the deployment completed.
- Returns:
- Date when the deployment completed.
-
withCompletedAt
Date when the deployment completed.
- Parameters:
completedAt
- Date when the deployment completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDuration
The deployment duration.
- Parameters:
duration
- The deployment duration.
-
getDuration
The deployment duration.
- Returns:
- The deployment duration.
-
withDuration
The deployment duration.
- Parameters:
duration
- The deployment duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIamUserArn
The user's IAM ARN.
- Parameters:
iamUserArn
- The user's IAM ARN.
-
getIamUserArn
The user's IAM ARN.
- Returns:
- The user's IAM ARN.
-
withIamUserArn
The user's IAM ARN.
- Parameters:
iamUserArn
- The user's IAM ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setComment
A user-defined comment.
- Parameters:
comment
- A user-defined comment.
-
getComment
A user-defined comment.
- Returns:
- A user-defined comment.
-
withComment
A user-defined comment.
- Parameters:
comment
- A user-defined comment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCommand
- Parameters:
command
-
-
getCommand
- Returns:
-
withCommand
- Parameters:
command
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
The deployment status:
- running
- successful
- failed
- Parameters:
status
- The deployment status:- running
- successful
- failed
-
getStatus
The deployment status:
- running
- successful
- failed
- Returns:
- The deployment status:
- running
- successful
- failed
-
withStatus
The deployment status:
- running
- successful
- failed
- Parameters:
status
- The deployment status:- running
- successful
- failed
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCustomJson
A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format and must escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- Parameters:
customJson
- A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format and must escape characters such as '"':"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
-
getCustomJson
A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format and must escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- Returns:
- A string that contains user-defined custom JSON. It can be used
to override the corresponding default stack configuration
attribute values for stack or to pass data to recipes. The string
should be in the following format and must escape characters such
as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
-
withCustomJson
A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format and must escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- Parameters:
customJson
- A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format and must escape characters such as '"':"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getInstanceIds
The IDs of the target instances.
- Returns:
- The IDs of the target instances.
-
setInstanceIds
The IDs of the target instances.
- Parameters:
instanceIds
- The IDs of the target instances.
-
withInstanceIds
The IDs of the target instances.
NOTE: This method appends the values to the existing list (if any). Use
setInstanceIds(java.util.Collection)
orwithInstanceIds(java.util.Collection)
if you want to override the existing values.- Parameters:
instanceIds
- The IDs of the target instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withInstanceIds
The IDs of the target instances.
- Parameters:
instanceIds
- The IDs of the target instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-