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
Represents the input of a create deployment operation.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreateDeploymentRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateDeploymentRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getApplicationName()
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.String
getDeploymentConfigName()
The name of a deployment configuration associated with the applicable IAM user or AWS account.String
getDeploymentGroupName()
The name of the deployment group.String
getDescription()
A comment about the deployment.Boolean
getIgnoreApplicationStopFailures()
If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.RevisionLocation
getRevision()
The type and location of the revision to deploy.int
hashCode()
Boolean
isIgnoreApplicationStopFailures()
If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.void
setApplicationName(String applicationName)
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.void
setDeploymentConfigName(String deploymentConfigName)
The name of a deployment configuration associated with the applicable IAM user or AWS account.void
setDeploymentGroupName(String deploymentGroupName)
The name of the deployment group.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 an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.void
setRevision(RevisionLocation revision)
The type and location of the revision to deploy.String
toString()
Returns a string representation of this object; useful for testing and debugging.CreateDeploymentRequest
withApplicationName(String applicationName)
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.CreateDeploymentRequest
withDeploymentConfigName(String deploymentConfigName)
The name of a deployment configuration associated with the applicable IAM user or AWS account.CreateDeploymentRequest
withDeploymentGroupName(String deploymentGroupName)
The name of the deployment group.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 an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.CreateDeploymentRequest
withRevision(RevisionLocation revision)
The type and location of the revision to deploy.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setApplicationName
public void setApplicationName(String applicationName)
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
- Parameters:
applicationName
- The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
-
getApplicationName
public String getApplicationName()
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
- Returns:
- The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
-
withApplicationName
public CreateDeploymentRequest withApplicationName(String applicationName)
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
- Parameters:
applicationName
- The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDeploymentGroupName
public void setDeploymentGroupName(String deploymentGroupName)
The name of the deployment group.
- Parameters:
deploymentGroupName
- The name of the deployment group.
-
getDeploymentGroupName
public String getDeploymentGroupName()
The name of the deployment group.
- Returns:
- The name of the deployment group.
-
withDeploymentGroupName
public CreateDeploymentRequest withDeploymentGroupName(String deploymentGroupName)
The name of the deployment group.
- Parameters:
deploymentGroupName
- The name of the deployment group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRevision
public void setRevision(RevisionLocation revision)
The type and location of the revision to deploy.
- Parameters:
revision
- The type and location of the revision to deploy.
-
getRevision
public RevisionLocation getRevision()
The type and location of the revision to deploy.
- Returns:
- The type and location of the revision to deploy.
-
withRevision
public CreateDeploymentRequest withRevision(RevisionLocation revision)
The type and location of the revision to deploy.
- Parameters:
revision
- The type and location of the revision to deploy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDeploymentConfigName
public void setDeploymentConfigName(String deploymentConfigName)
The name of a 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.
- Parameters:
deploymentConfigName
- The name of a 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.
-
getDeploymentConfigName
public String getDeploymentConfigName()
The name of a 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:
- The name of a 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 a 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.
- Parameters:
deploymentConfigName
- The name of a 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:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
A comment about the deployment.
- Parameters:
description
- A comment about the deployment.
-
getDescription
public String getDescription()
A comment about the deployment.
- Returns:
- A comment about the deployment.
-
withDescription
public CreateDeploymentRequest withDescription(String description)
A comment about the deployment.
- Parameters:
description
- A comment about the deployment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIgnoreApplicationStopFailures
public void setIgnoreApplicationStopFailures(Boolean ignoreApplicationStopFailures)
If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, 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 an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.
-
getIgnoreApplicationStopFailures
public Boolean getIgnoreApplicationStopFailures()
If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, 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 an instance to fail, the deployment
to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, 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 an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, 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 an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.
- Returns:
- Returns a reference to this 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 an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, 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 an instance to fail, the deployment
to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreateDeploymentRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-