com.amazonaws.services.codedeploy.model

Class CreateDeploymentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codedeploy.model.CreateDeploymentRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateDeploymentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateDeployment operation.

Deploys an application revision through the specified deployment group.

See Also:

AmazonCodeDeploy.createDeployment(CreateDeploymentRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDeploymentRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateDeploymentRequest	clone()
boolean	equals(Object obj)
String	getApplicationName() The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String	getDeploymentConfigName() The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
String	getDeploymentGroupName() The deployment group's name.
String	getDescription() A comment about the deployment.
Boolean	getIgnoreApplicationStopFailures() If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
RevisionLocation	getRevision() The type of revision to deploy, along with information about the revision's location.
int	hashCode()
Boolean	isIgnoreApplicationStopFailures() If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
void	setApplicationName(String applicationName) The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
void	setDeploymentConfigName(String deploymentConfigName) The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
void	setDeploymentGroupName(String deploymentGroupName) The deployment group's name.
void	setDescription(String description) A comment about the deployment.
void	setIgnoreApplicationStopFailures(Boolean ignoreApplicationStopFailures) If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
void	setRevision(RevisionLocation revision) The type of revision to deploy, along with information about the revision's location.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDeploymentRequest	withApplicationName(String applicationName) The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
CreateDeploymentRequest	withDeploymentConfigName(String deploymentConfigName) The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
CreateDeploymentRequest	withDeploymentGroupName(String deploymentGroupName) The deployment group's name.
CreateDeploymentRequest	withDescription(String description) A comment about the deployment.
CreateDeploymentRequest	withIgnoreApplicationStopFailures(Boolean ignoreApplicationStopFailures) If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
CreateDeploymentRequest	withRevision(RevisionLocation revision) The type of revision to deploy, along with information about the revision's location.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateDeploymentRequest

public CreateDeploymentRequest()

Method Detail

getApplicationName

public String getApplicationName()

The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.

Constraints:
Length: 1 - 100

Returns:

The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.

setApplicationName

public void setApplicationName(String applicationName)

The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.

Constraints:
Length: 1 - 100

Parameters:

applicationName - The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.

withApplicationName

public CreateDeploymentRequest withApplicationName(String applicationName)

The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.

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

Constraints:
Length: 1 - 100

Parameters:

applicationName - The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.

Returns:

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

getDeploymentGroupName

public String getDeploymentGroupName()

The deployment group's name.

Constraints:
Length: 1 - 100

Returns:

The deployment group's name.

setDeploymentGroupName

public void setDeploymentGroupName(String deploymentGroupName)

The deployment group's name.

Constraints:
Length: 1 - 100

Parameters:

deploymentGroupName - The deployment group's name.

withDeploymentGroupName

public CreateDeploymentRequest withDeploymentGroupName(String deploymentGroupName)

The deployment group's name.

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

Constraints:
Length: 1 - 100

Parameters:

deploymentGroupName - The deployment group's name.

Returns:

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

getRevision

public RevisionLocation getRevision()

The type of revision to deploy, along with information about the revision's location.

Returns:

The type of revision to deploy, along with information about the revision's location.

setRevision

public void setRevision(RevisionLocation revision)

The type of revision to deploy, along with information about the revision's location.

Parameters:

revision - The type of revision to deploy, along with information about the revision's location.

withRevision

public CreateDeploymentRequest withRevision(RevisionLocation revision)

The type of revision to deploy, along with information about the revision's location.

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

Parameters:

revision - The type of revision to deploy, along with information about the revision's location.

Returns:

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

getDeploymentConfigName

public String getDeploymentConfigName()

The name of an existing deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

Constraints:
Length: 1 - 100

Returns:

The name of an existing deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

setDeploymentConfigName

public void setDeploymentConfigName(String deploymentConfigName)

The name of an existing deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

Constraints:
Length: 1 - 100

Parameters:

deploymentConfigName - The name of an existing deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

withDeploymentConfigName

public CreateDeploymentRequest withDeploymentConfigName(String deploymentConfigName)

The name of an existing deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

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

Constraints:
Length: 1 - 100

Parameters:

deploymentConfigName - The name of an existing deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

Returns:

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

getDescription

public String getDescription()

A comment about the deployment.

Returns:

A comment about the deployment.

setDescription

public void setDescription(String description)

A comment about the deployment.

Parameters:

description - A comment about the deployment.

withDescription

public CreateDeploymentRequest withDescription(String description)

A comment about the deployment.

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

Parameters:

description - A comment about the deployment.

Returns:

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

isIgnoreApplicationStopFailures

public Boolean isIgnoreApplicationStopFailures()

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

Returns:

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

setIgnoreApplicationStopFailures

public void setIgnoreApplicationStopFailures(Boolean ignoreApplicationStopFailures)

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

Parameters:

ignoreApplicationStopFailures - If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

withIgnoreApplicationStopFailures

public CreateDeploymentRequest withIgnoreApplicationStopFailures(Boolean ignoreApplicationStopFailures)

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

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

Parameters:

ignoreApplicationStopFailures - If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

Returns:

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

getIgnoreApplicationStopFailures

public Boolean getIgnoreApplicationStopFailures()

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

Returns:

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

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

clone

public CreateDeploymentRequest clone()

Overrides:

clone in class AmazonWebServiceRequest