com.amazonaws.services.codedeploy.model

Class CreateDeploymentGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codedeploy.model.CreateDeploymentGroupRequest

All Implemented Interfaces:

Serializable, Cloneable

public class CreateDeploymentGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateDeploymentGroup operation.

Creates a new deployment group for application revisions to be deployed to.

See Also:

AmazonCodeDeploy.createDeploymentGroup(CreateDeploymentGroupRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDeploymentGroupRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateDeploymentGroupRequest	clone()
boolean	equals(Object obj)
String	getApplicationName() The name of an existing AWS CodeDeploy application within the AWS user account.
List<String>	getAutoScalingGroups() A list of associated Auto Scaling groups.
String	getDeploymentConfigName() If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration: CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once.
String	getDeploymentGroupName() The name of an existing deployment group for the specified application.
List<EC2TagFilter>	getEc2TagFilters() The Amazon EC2 tags to filter on.
String	getServiceRoleArn() A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
int	hashCode()
void	setApplicationName(String applicationName) The name of an existing AWS CodeDeploy application within the AWS user account.
void	setAutoScalingGroups(Collection<String> autoScalingGroups) A list of associated Auto Scaling groups.
void	setDeploymentConfigName(String deploymentConfigName) If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration: CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once.
void	setDeploymentGroupName(String deploymentGroupName) The name of an existing deployment group for the specified application.
void	setEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters) The Amazon EC2 tags to filter on.
void	setServiceRoleArn(String serviceRoleArn) A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDeploymentGroupRequest	withApplicationName(String applicationName) The name of an existing AWS CodeDeploy application within the AWS user account.
CreateDeploymentGroupRequest	withAutoScalingGroups(Collection<String> autoScalingGroups) A list of associated Auto Scaling groups.
CreateDeploymentGroupRequest	withAutoScalingGroups(String... autoScalingGroups) A list of associated Auto Scaling groups.
CreateDeploymentGroupRequest	withDeploymentConfigName(String deploymentConfigName) If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration: CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once.
CreateDeploymentGroupRequest	withDeploymentGroupName(String deploymentGroupName) The name of an existing deployment group for the specified application.
CreateDeploymentGroupRequest	withEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters) The Amazon EC2 tags to filter on.
CreateDeploymentGroupRequest	withEc2TagFilters(EC2TagFilter... ec2TagFilters) The Amazon EC2 tags to filter on.
CreateDeploymentGroupRequest	withServiceRoleArn(String serviceRoleArn) A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

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

CreateDeploymentGroupRequest

public CreateDeploymentGroupRequest()

Method Detail

getApplicationName

public String getApplicationName()

The name of an existing AWS CodeDeploy application within the AWS user account.

Constraints:
Length: 1 - 100

Returns:

The name of an existing AWS CodeDeploy application within the AWS user account.

setApplicationName

public void setApplicationName(String applicationName)

The name of an existing AWS CodeDeploy application within the AWS user account.

Constraints:
Length: 1 - 100

Parameters:

applicationName - The name of an existing AWS CodeDeploy application within the AWS user account.

withApplicationName

public CreateDeploymentGroupRequest withApplicationName(String applicationName)

The name of an existing AWS CodeDeploy application within the AWS user 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 within the AWS user account.

Returns:

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

getDeploymentGroupName

public String getDeploymentGroupName()

The name of an existing deployment group for the specified application.

Constraints:
Length: 1 - 100

Returns:

The name of an existing deployment group for the specified application.

setDeploymentGroupName

public void setDeploymentGroupName(String deploymentGroupName)

The name of an existing deployment group for the specified application.

Constraints:
Length: 1 - 100

Parameters:

deploymentGroupName - The name of an existing deployment group for the specified application.

withDeploymentGroupName

public CreateDeploymentGroupRequest withDeploymentGroupName(String deploymentGroupName)

The name of an existing deployment group for the specified application.

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

Constraints:
Length: 1 - 100

Parameters:

deploymentGroupName - The name of an existing deployment group for the specified application.

Returns:

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

getDeploymentConfigName

public String getDeploymentConfigName()

If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:

• CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once. The overall deployment succeeds if the application revision deploys to at least one of the instances. The overall deployment fails after the application revision fails to deploy to all of the instances. For example, for 9 instances, deploy to up to all 9 instances at once. The overall deployment succeeds if any of the 9 instances is successfully deployed to, and it fails if all 9 instances fail to be deployed to.
• CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for 9 instances, deploy to up to 4 instances at a time. The overall deployment succeeds if 5 or more instances are successfully deployed to; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
• CodeDeployDefault.OneAtATime deploys the application revision to only one of the instances at a time. The overall deployment succeeds if the application revision deploys to all of the instances. The overall deployment fails after the application revision first fails to deploy to any one instance. For example, for 9 instances, deploy to one instance at a time. The overall deployment succeeds if all 9 instances are successfully deployed to, and it fails if any of one of the 9 instances fail to be deployed to. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. This is the default deployment configuration if a configuration isn't specified for either the deployment or the deployment group.

To create a custom deployment configuration, call the create deployment configuration operation.

Constraints:
Length: 1 - 100

Returns:

If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:

• CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once. The overall deployment succeeds if the application revision deploys to at least one of the instances. The overall deployment fails after the application revision fails to deploy to all of the instances. For example, for 9 instances, deploy to up to all 9 instances at once. The overall deployment succeeds if any of the 9 instances is successfully deployed to, and it fails if all 9 instances fail to be deployed to.
• CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for 9 instances, deploy to up to 4 instances at a time. The overall deployment succeeds if 5 or more instances are successfully deployed to; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
• CodeDeployDefault.OneAtATime deploys the application revision to only one of the instances at a time. The overall deployment succeeds if the application revision deploys to all of the instances. The overall deployment fails after the application revision first fails to deploy to any one instance. For example, for 9 instances, deploy to one instance at a time. The overall deployment succeeds if all 9 instances are successfully deployed to, and it fails if any of one of the 9 instances fail to be deployed to. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. This is the default deployment configuration if a configuration isn't specified for either the deployment or the deployment group.

To create a custom deployment configuration, call the create deployment configuration operation.

setDeploymentConfigName

public void setDeploymentConfigName(String deploymentConfigName)

If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:

• CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once. The overall deployment succeeds if the application revision deploys to at least one of the instances. The overall deployment fails after the application revision fails to deploy to all of the instances. For example, for 9 instances, deploy to up to all 9 instances at once. The overall deployment succeeds if any of the 9 instances is successfully deployed to, and it fails if all 9 instances fail to be deployed to.
• CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for 9 instances, deploy to up to 4 instances at a time. The overall deployment succeeds if 5 or more instances are successfully deployed to; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
• CodeDeployDefault.OneAtATime deploys the application revision to only one of the instances at a time. The overall deployment succeeds if the application revision deploys to all of the instances. The overall deployment fails after the application revision first fails to deploy to any one instance. For example, for 9 instances, deploy to one instance at a time. The overall deployment succeeds if all 9 instances are successfully deployed to, and it fails if any of one of the 9 instances fail to be deployed to. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. This is the default deployment configuration if a configuration isn't specified for either the deployment or the deployment group.

To create a custom deployment configuration, call the create deployment configuration operation.

Constraints:
Length: 1 - 100

Parameters:

deploymentConfigName - If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:

• CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once. The overall deployment succeeds if the application revision deploys to at least one of the instances. The overall deployment fails after the application revision fails to deploy to all of the instances. For example, for 9 instances, deploy to up to all 9 instances at once. The overall deployment succeeds if any of the 9 instances is successfully deployed to, and it fails if all 9 instances fail to be deployed to.
• CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for 9 instances, deploy to up to 4 instances at a time. The overall deployment succeeds if 5 or more instances are successfully deployed to; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
• CodeDeployDefault.OneAtATime deploys the application revision to only one of the instances at a time. The overall deployment succeeds if the application revision deploys to all of the instances. The overall deployment fails after the application revision first fails to deploy to any one instance. For example, for 9 instances, deploy to one instance at a time. The overall deployment succeeds if all 9 instances are successfully deployed to, and it fails if any of one of the 9 instances fail to be deployed to. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. This is the default deployment configuration if a configuration isn't specified for either the deployment or the deployment group.

To create a custom deployment configuration, call the create deployment configuration operation.

withDeploymentConfigName

public CreateDeploymentGroupRequest withDeploymentConfigName(String deploymentConfigName)

If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:

• CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once. The overall deployment succeeds if the application revision deploys to at least one of the instances. The overall deployment fails after the application revision fails to deploy to all of the instances. For example, for 9 instances, deploy to up to all 9 instances at once. The overall deployment succeeds if any of the 9 instances is successfully deployed to, and it fails if all 9 instances fail to be deployed to.
• CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for 9 instances, deploy to up to 4 instances at a time. The overall deployment succeeds if 5 or more instances are successfully deployed to; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
• CodeDeployDefault.OneAtATime deploys the application revision to only one of the instances at a time. The overall deployment succeeds if the application revision deploys to all of the instances. The overall deployment fails after the application revision first fails to deploy to any one instance. For example, for 9 instances, deploy to one instance at a time. The overall deployment succeeds if all 9 instances are successfully deployed to, and it fails if any of one of the 9 instances fail to be deployed to. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. This is the default deployment configuration if a configuration isn't specified for either the deployment or the deployment group.

To create a custom deployment configuration, call the create deployment configuration operation.

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

Constraints:
Length: 1 - 100

Parameters:

deploymentConfigName - If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:

• CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the Amazon EC2 instances at once. The overall deployment succeeds if the application revision deploys to at least one of the instances. The overall deployment fails after the application revision fails to deploy to all of the instances. For example, for 9 instances, deploy to up to all 9 instances at once. The overall deployment succeeds if any of the 9 instances is successfully deployed to, and it fails if all 9 instances fail to be deployed to.
• CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for 9 instances, deploy to up to 4 instances at a time. The overall deployment succeeds if 5 or more instances are successfully deployed to; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
• CodeDeployDefault.OneAtATime deploys the application revision to only one of the instances at a time. The overall deployment succeeds if the application revision deploys to all of the instances. The overall deployment fails after the application revision first fails to deploy to any one instance. For example, for 9 instances, deploy to one instance at a time. The overall deployment succeeds if all 9 instances are successfully deployed to, and it fails if any of one of the 9 instances fail to be deployed to. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. This is the default deployment configuration if a configuration isn't specified for either the deployment or the deployment group.

To create a custom deployment configuration, call the create deployment configuration operation.

Returns:

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

getEc2TagFilters

public List<EC2TagFilter> getEc2TagFilters()

The Amazon EC2 tags to filter on.

Returns:

The Amazon EC2 tags to filter on.

setEc2TagFilters

public void setEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters)

The Amazon EC2 tags to filter on.

Parameters:

ec2TagFilters - The Amazon EC2 tags to filter on.

withEc2TagFilters

public CreateDeploymentGroupRequest withEc2TagFilters(EC2TagFilter... ec2TagFilters)

The Amazon EC2 tags to filter on.

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

Parameters:

ec2TagFilters - The Amazon EC2 tags to filter on.

Returns:

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

withEc2TagFilters

public CreateDeploymentGroupRequest withEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters)

The Amazon EC2 tags to filter on.

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

Parameters:

ec2TagFilters - The Amazon EC2 tags to filter on.

Returns:

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

getAutoScalingGroups

public List<String> getAutoScalingGroups()

A list of associated Auto Scaling groups.

Returns:

A list of associated Auto Scaling groups.

setAutoScalingGroups

public void setAutoScalingGroups(Collection<String> autoScalingGroups)

A list of associated Auto Scaling groups.

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups.

withAutoScalingGroups

public CreateDeploymentGroupRequest withAutoScalingGroups(String... autoScalingGroups)

A list of associated Auto Scaling groups.

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

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups.

Returns:

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

withAutoScalingGroups

public CreateDeploymentGroupRequest withAutoScalingGroups(Collection<String> autoScalingGroups)

A list of associated Auto Scaling groups.

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

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups.

Returns:

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

getServiceRoleArn

public String getServiceRoleArn()

A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

Returns:

A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

setServiceRoleArn

public void setServiceRoleArn(String serviceRoleArn)

A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

Parameters:

serviceRoleArn - A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

withServiceRoleArn

public CreateDeploymentGroupRequest withServiceRoleArn(String serviceRoleArn)

A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

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

Parameters:

serviceRoleArn - A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

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

clone

public CreateDeploymentGroupRequest clone()

Overrides:

clone in class AmazonWebServiceRequest