Deployment (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opsworks.model.Deployment

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes a deployment of a stack or app.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Deployment()

Constructors
Constructor and Description
`Deployment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Deployment`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAppId()` The app ID.
`DeploymentCommand`	`getCommand()` Used to specify a stack or deployment command.
`String`	`getComment()` A user-defined comment.
`String`	`getCompletedAt()` Date when the deployment completed.
`String`	`getCreatedAt()` Date when the deployment was created.
`String`	`getCustomJson()` A string that contains user-defined custom JSON.
`String`	`getDeploymentId()` The deployment ID.
`Integer`	`getDuration()` The deployment duration.
`String`	`getIamUserArn()` The user's IAM ARN.
`List<String>`	`getInstanceIds()` The IDs of the target instances.
`String`	`getStackId()` The stack ID.
`String`	`getStatus()` The deployment status:
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAppId(String appId)` The app ID.
`void`	`setCommand(DeploymentCommand command)` Used to specify a stack or deployment 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`	`setStatus(String status)` The deployment status:
`String`	`toString()` Returns a string representation of this object.
`Deployment`	`withAppId(String appId)` The app ID.
`Deployment`	`withCommand(DeploymentCommand command)` Used to specify a stack or deployment command.
`Deployment`	`withComment(String comment)` A user-defined comment.
`Deployment`	`withCompletedAt(String completedAt)` Date when the deployment completed.
`Deployment`	`withCreatedAt(String createdAt)` Date when the deployment was created.
`Deployment`	`withCustomJson(String customJson)` A string that contains user-defined custom JSON.
`Deployment`	`withDeploymentId(String deploymentId)` The deployment ID.
`Deployment`	`withDuration(Integer duration)` The deployment duration.
`Deployment`	`withIamUserArn(String iamUserArn)` The user's IAM ARN.
`Deployment`	`withInstanceIds(Collection<String> instanceIds)` The IDs of the target instances.
`Deployment`	`withInstanceIds(String... instanceIds)` The IDs of the target instances.
`Deployment`	`withStackId(String stackId)` The stack ID.
`Deployment`	`withStatus(String status)` The deployment status:

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Deployment
```
public Deployment()
```
- Method Detail
  - 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)
```
    Used to specify a stack or deployment command.
    
    Parameters:
    
    command - Used to specify a stack or deployment command.
  - getCommand
```
public DeploymentCommand getCommand()
```
    Used to specify a stack or deployment command.
    
    Returns:
    
    Used to specify a stack or deployment command.
  - withCommand
```
public Deployment withCommand(DeploymentCommand command)
```
    Used to specify a stack or deployment command.
    
    Parameters:
    
    command - Used to specify a stack or deployment 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:
    
    "{\"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:
    
    "{\"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:
    
    "{\"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:
    
    "{\"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:
    
    "{\"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:
    
    "{\"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. 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 Deployment clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Deployment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Deployment

Method Detail

setDeploymentId

getDeploymentId

withDeploymentId

setStackId

getStackId

withStackId

setAppId

getAppId

withAppId

setCreatedAt

getCreatedAt

withCreatedAt

setCompletedAt

getCompletedAt

withCompletedAt

setDuration

getDuration

withDuration

setIamUserArn

getIamUserArn

withIamUserArn

setComment

getComment

withComment

setCommand

getCommand

withCommand

setStatus

getStatus

withStatus

setCustomJson

getCustomJson

withCustomJson

getInstanceIds

setInstanceIds

withInstanceIds

withInstanceIds

toString

equals

hashCode

clone

marshall