public class CreateDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a create deployment group operation.
NOOP
Constructor and Description |
---|
CreateDeploymentGroupRequest() |
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 can be either one of the
predefined configurations provided with AWS CodeDeploy, or a custom
deployment configuration that you created by calling the create
deployment configuration operation.
|
String |
getDeploymentGroupName()
The name of a new 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.
|
List<TriggerConfig> |
getTriggerConfigurations()
Information about triggers to create when the deployment group is
created.
|
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 can be either one of the
predefined configurations provided with AWS CodeDeploy, or a custom
deployment configuration that you created 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 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.
|
void |
setTriggerConfigurations(Collection<TriggerConfig> triggerConfigurations)
Information about triggers to create when the deployment group is
created.
|
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 can be either one of the
predefined configurations provided with AWS CodeDeploy, or a custom
deployment configuration that you created by calling the create
deployment configuration operation.
|
CreateDeploymentGroupRequest |
withDeploymentGroupName(String deploymentGroupName)
The name of a new 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.
|
CreateDeploymentGroupRequest |
withTriggerConfigurations(Collection<TriggerConfig> triggerConfigurations)
Information about triggers to create when the deployment group is
created.
|
CreateDeploymentGroupRequest |
withTriggerConfigurations(TriggerConfig... triggerConfigurations)
Information about triggers to create when the deployment group is
created.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setApplicationName(String applicationName)
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
applicationName
- The name of an existing AWS CodeDeploy application associated with
the applicable IAM user or AWS account.public String getApplicationName()
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
public CreateDeploymentGroupRequest withApplicationName(String applicationName)
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
applicationName
- The name of an existing AWS CodeDeploy application associated with
the applicable IAM user or AWS account.public void setDeploymentGroupName(String deploymentGroupName)
The name of a new deployment group for the specified application.
deploymentGroupName
- The name of a new deployment group for the specified application.public String getDeploymentGroupName()
The name of a new deployment group for the specified application.
public CreateDeploymentGroupRequest withDeploymentGroupName(String deploymentGroupName)
The name of a new deployment group for the specified application.
deploymentGroupName
- The name of a new deployment group for the specified application.public 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 created by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group.
The predefined deployment configurations including the following:
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances 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 instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances 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 instances 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 deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; 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 instance at a time.
For deployment groups that contain more than one instance:
The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration.
The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails.
For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds.
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 created by calling the
create deployment configuration operation. CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group.
The predefined deployment configurations including the following:
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances 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 instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances 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 instances 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 deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; 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 instance at a time.
For deployment groups that contain more than one instance:
The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration.
The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails.
For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds.
public String 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 created by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group.
The predefined deployment configurations including the following:
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances 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 instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances 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 instances 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 deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; 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 instance at a time.
For deployment groups that contain more than one instance:
The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration.
The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails.
For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds.
CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group.
The predefined deployment configurations including the following:
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances 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 instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances 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 instances 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 deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; 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 instance at a time.
For deployment groups that contain more than one instance:
The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration.
The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails.
For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds.
public CreateDeploymentGroupRequest 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 created by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group.
The predefined deployment configurations including the following:
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances 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 instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances 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 instances 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 deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; 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 instance at a time.
For deployment groups that contain more than one instance:
The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration.
The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails.
For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds.
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 created by calling the
create deployment configuration operation. CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group.
The predefined deployment configurations including the following:
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances 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 instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances 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 instances 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 deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; 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 instance at a time.
For deployment groups that contain more than one instance:
The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration.
The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails.
For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds.
public List<EC2TagFilter> getEc2TagFilters()
The Amazon EC2 tags to filter on.
public void setEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters)
The Amazon EC2 tags to filter on.
ec2TagFilters
- The Amazon EC2 tags to filter on.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.
ec2TagFilters
- The Amazon EC2 tags to filter on.public CreateDeploymentGroupRequest withEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters)
The Amazon EC2 tags to filter on.
ec2TagFilters
- The Amazon EC2 tags to filter on.public List<TagFilter> getOnPremisesInstanceTagFilters()
The on-premises instance tags to filter on.
public void setOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters)
The on-premises instance tags to filter on.
onPremisesInstanceTagFilters
- The on-premises instance tags to filter on.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.
onPremisesInstanceTagFilters
- The on-premises instance tags to filter on.public CreateDeploymentGroupRequest withOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters)
The on-premises instance tags to filter on.
onPremisesInstanceTagFilters
- The on-premises instance tags to filter on.public List<String> getAutoScalingGroups()
A list of associated Auto Scaling groups.
public void setAutoScalingGroups(Collection<String> autoScalingGroups)
A list of associated Auto Scaling groups.
autoScalingGroups
- A list of associated Auto Scaling groups.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.
autoScalingGroups
- A list of associated Auto Scaling groups.public CreateDeploymentGroupRequest withAutoScalingGroups(Collection<String> autoScalingGroups)
A list of associated Auto Scaling groups.
autoScalingGroups
- A list of associated Auto Scaling groups.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.
serviceRoleArn
- A service role ARN that allows AWS CodeDeploy to act on the user's
behalf when interacting with AWS services.public String getServiceRoleArn()
A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
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.
serviceRoleArn
- A service role ARN that allows AWS CodeDeploy to act on the user's
behalf when interacting with AWS services.public List<TriggerConfig> getTriggerConfigurations()
Information about triggers to create when the deployment group is created.
public void setTriggerConfigurations(Collection<TriggerConfig> triggerConfigurations)
Information about triggers to create when the deployment group is created.
triggerConfigurations
- Information about triggers to create when the deployment group is
created.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)
or
withTriggerConfigurations(java.util.Collection)
if you want to
override the existing values.
triggerConfigurations
- Information about triggers to create when the deployment group is
created.public CreateDeploymentGroupRequest withTriggerConfigurations(Collection<TriggerConfig> triggerConfigurations)
Information about triggers to create when the deployment group is created.
triggerConfigurations
- Information about triggers to create when the deployment group is
created.public String toString()
toString
in class Object
Object.toString()
public CreateDeploymentGroupRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2016. All rights reserved.