com.amazonaws.services.opsworks.model

Class CreateDeploymentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.CreateDeploymentRequest

All Implemented Interfaces:

Serializable

public class CreateDeploymentRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateDeployment operation.

Deploys a stack or app.

• App deployment generates a deploy event, which runs the associated recipes and passes them a JSON stack configuration object that includes information about the app.
• Stack deployment runs the deploy recipes but does not raise an event.

For more information, see Deploying Apps and Run Stack Commands .

Required Permissions : To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:

AWSOpsWorks.createDeployment(CreateDeploymentRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateDeploymentRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAppId() The app ID.
DeploymentCommand	getCommand() A DeploymentCommand object that specifies the deployment command and any associated arguments.
String	getComment() A user-defined comment.
String	getCustomJson() A string that contains user-defined, custom JSON.
List<String>	getInstanceIds() The instance IDs for the deployment targets.
String	getStackId() The stack ID.
int	hashCode()
void	setAppId(String appId) The app ID.
void	setCommand(DeploymentCommand command) A DeploymentCommand object that specifies the deployment command and any associated arguments.
void	setComment(String comment) A user-defined comment.
void	setCustomJson(String customJson) A string that contains user-defined, custom JSON.
void	setInstanceIds(Collection<String> instanceIds) The instance IDs for the deployment targets.
void	setStackId(String stackId) The stack ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDeploymentRequest	withAppId(String appId) The app ID.
CreateDeploymentRequest	withCommand(DeploymentCommand command) A DeploymentCommand object that specifies the deployment command and any associated arguments.
CreateDeploymentRequest	withComment(String comment) A user-defined comment.
CreateDeploymentRequest	withCustomJson(String customJson) A string that contains user-defined, custom JSON.
CreateDeploymentRequest	withInstanceIds(Collection<String> instanceIds) The instance IDs for the deployment targets.
CreateDeploymentRequest	withInstanceIds(String... instanceIds) The instance IDs for the deployment targets.
CreateDeploymentRequest	withStackId(String stackId) The stack ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDeploymentRequest

public CreateDeploymentRequest()

Method Detail

getStackId

public String getStackId()

The stack ID.

Returns:

The stack ID.

setStackId

public void setStackId(String stackId)

The stack ID.

Parameters:

stackId - The stack ID.

withStackId

public CreateDeploymentRequest withStackId(String stackId)

The stack ID.

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

Parameters:

stackId - The stack ID.

Returns:

A reference to this updated object so that method calls can be chained together.

getAppId

public String getAppId()

The app ID. This parameter is required for app deployments, but not for other deployment commands.

Returns:

The app ID. This parameter is required for app deployments, but not for other deployment commands.

setAppId

public void setAppId(String appId)

The app ID. This parameter is required for app deployments, but not for other deployment commands.

Parameters:

appId - The app ID. This parameter is required for app deployments, but not for other deployment commands.

withAppId

public CreateDeploymentRequest withAppId(String appId)

The app ID. This parameter is required for app deployments, but not for other deployment commands.

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

Parameters:

appId - The app ID. This parameter is required for app deployments, but not for other deployment commands.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceIds

public List<String> getInstanceIds()

The instance IDs for the deployment targets.

Returns:

The instance IDs for the deployment targets.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

The instance IDs for the deployment targets.

Parameters:

instanceIds - The instance IDs for the deployment targets.

withInstanceIds

public CreateDeploymentRequest withInstanceIds(String... instanceIds)

The instance IDs for the deployment targets.

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

Parameters:

instanceIds - The instance IDs for the deployment targets.

Returns:

A reference to this updated object so that method calls can be chained together.

withInstanceIds

public CreateDeploymentRequest withInstanceIds(Collection<String> instanceIds)

The instance IDs for the deployment targets.

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

Parameters:

instanceIds - The instance IDs for the deployment targets.

Returns:

A reference to this updated object so that method calls can be chained together.

getCommand

public DeploymentCommand getCommand()

A DeploymentCommand object that specifies the deployment command and any associated arguments.

Returns:

A DeploymentCommand object that specifies the deployment command and any associated arguments.

setCommand

public void setCommand(DeploymentCommand command)

A DeploymentCommand object that specifies the deployment command and any associated arguments.

Parameters:

command - A DeploymentCommand object that specifies the deployment command and any associated arguments.

withCommand

public CreateDeploymentRequest withCommand(DeploymentCommand command)

A DeploymentCommand object that specifies the deployment command and any associated arguments.

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

Parameters:

command - A DeploymentCommand object that specifies the deployment command and any associated arguments.

Returns:

A reference to this updated object so that method calls can be chained together.

getComment

public String getComment()

A user-defined comment.

Returns:

A user-defined comment.

setComment

public void setComment(String comment)

A user-defined comment.

Parameters:

comment - A user-defined comment.

withComment

public CreateDeploymentRequest withComment(String comment)

A user-defined comment.

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

Parameters:

comment - A user-defined comment.

Returns:

A reference to this updated object so that method calls can be chained together.

getCustomJson

public String getCustomJson()

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

Returns:

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

setCustomJson

public void setCustomJson(String customJson)

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

Parameters:

customJson - A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

withCustomJson

public CreateDeploymentRequest withCustomJson(String customJson)

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

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

Parameters:

customJson - A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

Returns:

A reference to this updated 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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object