com.amazonaws.services.codedeploy.model

Class CreateDeploymentGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codedeploy.model.CreateDeploymentGroupRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateDeploymentGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a create deployment group operation.

See Also:

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 associated with the applicable IAM user or AWS 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:
String	getDeploymentGroupName() The name of an existing deployment group for the specified application.
List<EC2TagFilter>	getEc2TagFilters() The Amazon EC2 tags to filter on.
List<TagFilter>	getOnPremisesInstanceTagFilters() The on-premises instance 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 associated with the applicable IAM user or AWS 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:
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	setOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters) The on-premises instance 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 associated with the applicable IAM user or AWS 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:
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	withOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters) The on-premises instance tags to filter on.
CreateDeploymentGroupRequest	withOnPremisesInstanceTagFilters(TagFilter... onPremisesInstanceTagFilters) The on-premises instance 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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateDeploymentGroupRequest

public CreateDeploymentGroupRequest()

Method Detail

setApplicationName

public void setApplicationName(String applicationName)

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

Parameters:

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

getApplicationName

public String getApplicationName()

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

Returns:

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

withApplicationName

public CreateDeploymentGroupRequest withApplicationName(String applicationName)

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

Parameters:

applicationName - The name of an existing 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 an existing deployment group for the specified application.

Parameters:

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

getDeploymentGroupName

public String getDeploymentGroupName()

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

Returns:

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.

Parameters:

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

Returns:

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

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 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 instances. 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.

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 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 instances. 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.

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 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 instances. 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:

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 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 instances. 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 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 instances. 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.

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 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 instances. 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:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setEc2TagFilters(java.util.Collection) or withEc2TagFilters(java.util.Collection) if you want to override the existing values.

Parameters:

ec2TagFilters - The Amazon EC2 tags to filter on.

Returns:

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

withEc2TagFilters

public CreateDeploymentGroupRequest withEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters)

The Amazon EC2 tags to filter on.

Parameters:

ec2TagFilters - The Amazon EC2 tags to filter on.

Returns:

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

getOnPremisesInstanceTagFilters

public List<TagFilter> getOnPremisesInstanceTagFilters()

The on-premises instance tags to filter on.

Returns:

The on-premises instance tags to filter on.

setOnPremisesInstanceTagFilters

public void setOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters)

The on-premises instance tags to filter on.

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags to filter on.

withOnPremisesInstanceTagFilters

public CreateDeploymentGroupRequest withOnPremisesInstanceTagFilters(TagFilter... onPremisesInstanceTagFilters)

The on-premises instance tags to filter on.

NOTE: This method appends the values to the existing list (if any). Use setOnPremisesInstanceTagFilters(java.util.Collection) or withOnPremisesInstanceTagFilters(java.util.Collection) if you want to override the existing values.

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags to filter on.

Returns:

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

withOnPremisesInstanceTagFilters

public CreateDeploymentGroupRequest withOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters)

The on-premises instance tags to filter on.

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags to filter on.

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setAutoScalingGroups(java.util.Collection) or withAutoScalingGroups(java.util.Collection) if you want to override the existing values.

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups.

Returns:

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

withAutoScalingGroups

public CreateDeploymentGroupRequest withAutoScalingGroups(Collection<String> autoScalingGroups)

A list of associated Auto Scaling groups.

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups.

Returns:

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

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.

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.

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.

Parameters:

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

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; useful for testing and debugging.

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 CreateDeploymentGroupRequest clone()

Overrides:

clone in class AmazonWebServiceRequest