Class CreateDeploymentGroupRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of a create deployment group operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.A list of associated Auto Scaling groups.If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.The name of a new deployment group for the specified application.The Amazon EC2 tags on which to filter.The on-premises instance tags on which to filter.A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.Information about triggers to create when the deployment group is created.int
hashCode()
void
setApplicationName
(String applicationName) The name of an 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 can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.void
setDeploymentGroupName
(String deploymentGroupName) The name of a new deployment group for the specified application.void
setEc2TagFilters
(Collection<EC2TagFilter> ec2TagFilters) The Amazon EC2 tags on which to filter.void
setOnPremisesInstanceTagFilters
(Collection<TagFilter> onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.void
setServiceRoleArn
(String serviceRoleArn) A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.void
setTriggerConfigurations
(Collection<TriggerConfig> triggerConfigurations) Information about triggers to create when the deployment group is created.toString()
Returns a string representation of this object; useful for testing and debugging.withApplicationName
(String applicationName) The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.withAutoScalingGroups
(String... autoScalingGroups) A list of associated Auto Scaling groups.withAutoScalingGroups
(Collection<String> autoScalingGroups) A list of associated Auto Scaling groups.withDeploymentConfigName
(String deploymentConfigName) If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.withDeploymentGroupName
(String deploymentGroupName) The name of a new deployment group for the specified application.withEc2TagFilters
(EC2TagFilter... ec2TagFilters) The Amazon EC2 tags on which to filter.withEc2TagFilters
(Collection<EC2TagFilter> ec2TagFilters) The Amazon EC2 tags on which to filter.withOnPremisesInstanceTagFilters
(TagFilter... onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.withOnPremisesInstanceTagFilters
(Collection<TagFilter> onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.withServiceRoleArn
(String serviceRoleArn) A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.withTriggerConfigurations
(TriggerConfig... triggerConfigurations) Information about triggers to create when the deployment group is created.withTriggerConfigurations
(Collection<TriggerConfig> triggerConfigurations) Information about triggers to create when the deployment group is created.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
-
Constructor Details
-
CreateDeploymentGroupRequest
public CreateDeploymentGroupRequest()
-
-
Method Details
-
setApplicationName
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
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
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
The name of a new deployment group for the specified application.
- Parameters:
deploymentGroupName
- The name of a new deployment group for the specified application.
-
getDeploymentGroupName
The name of a new deployment group for the specified application.
- Returns:
- The name of a new deployment group for the specified application.
-
withDeploymentGroupName
The name of a new deployment group for the specified application.
- Parameters:
deploymentGroupName
- The name of a new deployment group for the specified application.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDeploymentConfigName
If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.
The predefined deployment configurations include the following:
-
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.
-
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 is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.
For deployment groups that contain more than one instance:
-
The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.
-
The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.
For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful
-
- Parameters:
deploymentConfigName
- If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.
The predefined deployment configurations include the following:
-
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.
-
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 is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.
For deployment groups that contain more than one instance:
-
The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.
-
The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.
For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful
-
-
-
-
getDeploymentConfigName
If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.
The predefined deployment configurations include the following:
-
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.
-
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 is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.
For deployment groups that contain more than one instance:
-
The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.
-
The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.
For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful
-
- Returns:
- If specified, the deployment configuration name can be either one
of the predefined configurations provided with AWS CodeDeploy or
a custom deployment configuration that you create by calling the
create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.
The predefined deployment configurations include the following:
-
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.
-
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 is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.
For deployment groups that contain more than one instance:
-
The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.
-
The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.
For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful
-
-
-
-
withDeploymentConfigName
If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.
The predefined deployment configurations include the following:
-
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.
-
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 is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.
For deployment groups that contain more than one instance:
-
The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.
-
The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.
For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful
-
- Parameters:
deploymentConfigName
- If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.
The predefined deployment configurations include the following:
-
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.
-
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 is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.
For deployment groups that contain more than one instance:
-
The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.
-
The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.
-
In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.
For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
getEc2TagFilters
The Amazon EC2 tags on which to filter.
- Returns:
- The Amazon EC2 tags on which to filter.
-
setEc2TagFilters
The Amazon EC2 tags on which to filter.
- Parameters:
ec2TagFilters
- The Amazon EC2 tags on which to filter.
-
withEc2TagFilters
The Amazon EC2 tags on which to filter.
NOTE: This method appends the values to the existing list (if any). Use
setEc2TagFilters(java.util.Collection)
orwithEc2TagFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
ec2TagFilters
- The Amazon EC2 tags on which to filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withEc2TagFilters
The Amazon EC2 tags on which to filter.
- Parameters:
ec2TagFilters
- The Amazon EC2 tags on which to filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getOnPremisesInstanceTagFilters
The on-premises instance tags on which to filter.
- Returns:
- The on-premises instance tags on which to filter.
-
setOnPremisesInstanceTagFilters
The on-premises instance tags on which to filter.
- Parameters:
onPremisesInstanceTagFilters
- The on-premises instance tags on which to filter.
-
withOnPremisesInstanceTagFilters
public CreateDeploymentGroupRequest withOnPremisesInstanceTagFilters(TagFilter... onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.
NOTE: This method appends the values to the existing list (if any). Use
setOnPremisesInstanceTagFilters(java.util.Collection)
orwithOnPremisesInstanceTagFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
onPremisesInstanceTagFilters
- The on-premises instance tags on which to filter.- 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 on which to filter.
- Parameters:
onPremisesInstanceTagFilters
- The on-premises instance tags on which to filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAutoScalingGroups
A list of associated Auto Scaling groups.
- Returns:
- A list of associated Auto Scaling groups.
-
setAutoScalingGroups
A list of associated Auto Scaling groups.
- Parameters:
autoScalingGroups
- A list of associated Auto Scaling groups.
-
withAutoScalingGroups
A list of associated Auto Scaling groups.
NOTE: This method appends the values to the existing list (if any). Use
setAutoScalingGroups(java.util.Collection)
orwithAutoScalingGroups(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
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
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
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
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.
-
getTriggerConfigurations
Information about triggers to create when the deployment group is created.
- Returns:
- Information about triggers to create when the deployment group is created.
-
setTriggerConfigurations
Information about triggers to create when the deployment group is created.
- Parameters:
triggerConfigurations
- Information about triggers to create when the deployment group is created.
-
withTriggerConfigurations
public CreateDeploymentGroupRequest withTriggerConfigurations(TriggerConfig... triggerConfigurations) Information about triggers to create when the deployment group is created.
NOTE: This method appends the values to the existing list (if any). Use
setTriggerConfigurations(java.util.Collection)
orwithTriggerConfigurations(java.util.Collection)
if you want to override the existing values.- Parameters:
triggerConfigurations
- Information about triggers to create when the deployment group is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTriggerConfigurations
public CreateDeploymentGroupRequest withTriggerConfigurations(Collection<TriggerConfig> triggerConfigurations) Information about triggers to create when the deployment group is created.
- Parameters:
triggerConfigurations
- Information about triggers to create when the deployment group is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-