Class Deployment

java.lang.Object
com.amazonaws.services.opsworks.model.Deployment
All Implemented Interfaces:
Serializable, Cloneable
public class Deployment extends Object implements Serializable, Cloneable

Describes a deployment of a stack or app.

See Also:

  • Constructor Details

    • Deployment

      public Deployment()

  • Method Details

    • setDeploymentId

      public void setDeploymentId(String deploymentId)

      The deployment ID.

      Parameters:
      deploymentId - The deployment ID.

    • getDeploymentId

      public String getDeploymentId()

      The deployment ID.

      Returns:
      The deployment ID.

    • withDeploymentId

      public Deployment withDeploymentId(String deploymentId)

      The deployment ID.

      Parameters:
      deploymentId - The deployment ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setStackId

      public void setStackId(String stackId)

      The stack ID.

      Parameters:
      stackId - The stack ID.

    • getStackId

      public String getStackId()

      The stack ID.

      Returns:
      The stack ID.

    • withStackId

      public Deployment withStackId(String stackId)

      The stack ID.

      Parameters:
      stackId - The stack ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setAppId

      public void setAppId(String appId)

      The app ID.

      Parameters:
      appId - The app ID.

    • getAppId

      public String getAppId()

      The app ID.

      Returns:
      The app ID.

    • withAppId

      public Deployment withAppId(String appId)

      The app ID.

      Parameters:
      appId - The app ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setCreatedAt

      public void setCreatedAt(String createdAt)

      Date when the deployment was created.

      Parameters:
      createdAt - Date when the deployment was created.

    • getCreatedAt

      public String getCreatedAt()

      Date when the deployment was created.

      Returns:
      Date when the deployment was created.

    • withCreatedAt

      public Deployment withCreatedAt(String createdAt)

      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

      public void setCompletedAt(String completedAt)

      Date when the deployment completed.

      Parameters:
      completedAt - Date when the deployment completed.

    • getCompletedAt

      public String getCompletedAt()

      Date when the deployment completed.

      Returns:
      Date when the deployment completed.

    • withCompletedAt

      public Deployment withCompletedAt(String completedAt)

      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

      public void setDuration(Integer duration)

      The deployment duration.

      Parameters:
      duration - The deployment duration.

    • getDuration

      public Integer getDuration()

      The deployment duration.

      Returns:
      The deployment duration.

    • withDuration

      public Deployment withDuration(Integer duration)

      The deployment duration.

      Parameters:
      duration - The deployment duration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setIamUserArn

      public void setIamUserArn(String iamUserArn)

      The user's IAM ARN.

      Parameters:
      iamUserArn - The user's IAM ARN.

    • getIamUserArn

      public String getIamUserArn()

      The user's IAM ARN.

      Returns:
      The user's IAM ARN.

    • withIamUserArn

      public Deployment withIamUserArn(String iamUserArn)

      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

      public void setComment(String comment)

      A user-defined comment.

      Parameters:
      comment - A user-defined comment.

    • getComment

      public String getComment()

      A user-defined comment.

      Returns:
      A user-defined comment.

    • withComment

      public Deployment withComment(String comment)

      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

      public void setCommand(DeploymentCommand command)
      Parameters:
      command -

    • getCommand

      public DeploymentCommand getCommand()
      Returns:

    • withCommand

      public Deployment withCommand(DeploymentCommand command)
      Parameters:
      command -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setStatus

      public void setStatus(String status)

      The deployment status:

      • running
      • successful
      • failed
      Parameters:
      status - The deployment status:

      • running
      • successful
      • failed

    • getStatus

      public String getStatus()

      The deployment status:

      • running
      • successful
      • failed
      Returns:
      The deployment status:

      • running
      • successful
      • failed

    • withStatus

      public Deployment withStatus(String status)

      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

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

      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

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

      public Deployment withCustomJson(String 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.

      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

      public List<String> getInstanceIds()

      The IDs of the target instances.

      Returns:
      The IDs of the target instances.

    • setInstanceIds

      public void setInstanceIds(Collection<String> instanceIds)

      The IDs of the target instances.

      Parameters:
      instanceIds - The IDs of the target instances.

    • withInstanceIds

      public Deployment withInstanceIds(String... instanceIds)

      The IDs of the target instances.

      NOTE: This method appends the values to the existing list (if any). Use setInstanceIds(java.util.Collection) or withInstanceIds(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

      public Deployment withInstanceIds(Collection<String> instanceIds)

      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

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public Deployment clone()
      Overrides:
      clone in class Object