com.amazonaws.services.codedeploy.model

Class CreateDeploymentGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codedeploy.model.CreateDeploymentGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDeploymentGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a CreateDeploymentGroup operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDeploymentGroupRequest()

Method Summary

Modifier and Type	Method and Description
CreateDeploymentGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AlarmConfiguration	getAlarmConfiguration() Information to add about Amazon CloudWatch alarms when the deployment group is created.
String	getApplicationName() The name of an CodeDeploy application associated with the user or Amazon Web Services account.
AutoRollbackConfiguration	getAutoRollbackConfiguration() Configuration information for an automatic rollback that is added when a deployment group is created.
List<String>	getAutoScalingGroups() A list of associated Amazon EC2 Auto Scaling groups.
BlueGreenDeploymentConfiguration	getBlueGreenDeploymentConfiguration() Information about blue/green deployment options for a deployment group.
String	getDeploymentConfigName() If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
String	getDeploymentGroupName() The name of a new deployment group for the specified application.
DeploymentStyle	getDeploymentStyle() Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
List<EC2TagFilter>	getEc2TagFilters() The Amazon EC2 tags on which to filter.
EC2TagSet	getEc2TagSet() Information about groups of tags applied to Amazon EC2 instances.
List<ECSService>	getEcsServices() The target Amazon ECS services in the deployment group.
LoadBalancerInfo	getLoadBalancerInfo() Information about the load balancer used in a deployment.
List<TagFilter>	getOnPremisesInstanceTagFilters() The on-premises instance tags on which to filter.
OnPremisesTagSet	getOnPremisesTagSet() Information about groups of tags applied to on-premises instances.
String	getOutdatedInstancesStrategy() Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
String	getServiceRoleArn() A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
List<Tag>	getTags() The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
Boolean	getTerminationHookEnabled() This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling.
List<TriggerConfig>	getTriggerConfigurations() Information about triggers to create when the deployment group is created.
int	hashCode()
Boolean	isTerminationHookEnabled() This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling.
void	setAlarmConfiguration(AlarmConfiguration alarmConfiguration) Information to add about Amazon CloudWatch alarms when the deployment group is created.
void	setApplicationName(String applicationName) The name of an CodeDeploy application associated with the user or Amazon Web Services account.
void	setAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration) Configuration information for an automatic rollback that is added when a deployment group is created.
void	setAutoScalingGroups(Collection<String> autoScalingGroups) A list of associated Amazon EC2 Auto Scaling groups.
void	setBlueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration) Information about blue/green deployment options for a deployment group.
void	setDeploymentConfigName(String deploymentConfigName) If specified, the deployment configuration name can be either one of the predefined configurations provided with 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	setDeploymentStyle(DeploymentStyle deploymentStyle) Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
void	setEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters) The Amazon EC2 tags on which to filter.
void	setEc2TagSet(EC2TagSet ec2TagSet) Information about groups of tags applied to Amazon EC2 instances.
void	setEcsServices(Collection<ECSService> ecsServices) The target Amazon ECS services in the deployment group.
void	setLoadBalancerInfo(LoadBalancerInfo loadBalancerInfo) Information about the load balancer used in a deployment.
void	setOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.
void	setOnPremisesTagSet(OnPremisesTagSet onPremisesTagSet) Information about groups of tags applied to on-premises instances.
void	setOutdatedInstancesStrategy(String outdatedInstancesStrategy) Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
void	setServiceRoleArn(String serviceRoleArn) A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
void	setTags(Collection<Tag> tags) The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
void	setTerminationHookEnabled(Boolean terminationHookEnabled) This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling.
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.
CreateDeploymentGroupRequest	withAlarmConfiguration(AlarmConfiguration alarmConfiguration) Information to add about Amazon CloudWatch alarms when the deployment group is created.
CreateDeploymentGroupRequest	withApplicationName(String applicationName) The name of an CodeDeploy application associated with the user or Amazon Web Services account.
CreateDeploymentGroupRequest	withAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration) Configuration information for an automatic rollback that is added when a deployment group is created.
CreateDeploymentGroupRequest	withAutoScalingGroups(Collection<String> autoScalingGroups) A list of associated Amazon EC2 Auto Scaling groups.
CreateDeploymentGroupRequest	withAutoScalingGroups(String... autoScalingGroups) A list of associated Amazon EC2 Auto Scaling groups.
CreateDeploymentGroupRequest	withBlueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration) Information about blue/green deployment options for a deployment group.
CreateDeploymentGroupRequest	withDeploymentConfigName(String deploymentConfigName) If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CreateDeploymentGroupRequest	withDeploymentGroupName(String deploymentGroupName) The name of a new deployment group for the specified application.
CreateDeploymentGroupRequest	withDeploymentStyle(DeploymentStyle deploymentStyle) Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
CreateDeploymentGroupRequest	withEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters) The Amazon EC2 tags on which to filter.
CreateDeploymentGroupRequest	withEc2TagFilters(EC2TagFilter... ec2TagFilters) The Amazon EC2 tags on which to filter.
CreateDeploymentGroupRequest	withEc2TagSet(EC2TagSet ec2TagSet) Information about groups of tags applied to Amazon EC2 instances.
CreateDeploymentGroupRequest	withEcsServices(Collection<ECSService> ecsServices) The target Amazon ECS services in the deployment group.
CreateDeploymentGroupRequest	withEcsServices(ECSService... ecsServices) The target Amazon ECS services in the deployment group.
CreateDeploymentGroupRequest	withLoadBalancerInfo(LoadBalancerInfo loadBalancerInfo) Information about the load balancer used in a deployment.
CreateDeploymentGroupRequest	withOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.
CreateDeploymentGroupRequest	withOnPremisesInstanceTagFilters(TagFilter... onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.
CreateDeploymentGroupRequest	withOnPremisesTagSet(OnPremisesTagSet onPremisesTagSet) Information about groups of tags applied to on-premises instances.
CreateDeploymentGroupRequest	withOutdatedInstancesStrategy(OutdatedInstancesStrategy outdatedInstancesStrategy) Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
CreateDeploymentGroupRequest	withOutdatedInstancesStrategy(String outdatedInstancesStrategy) Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
CreateDeploymentGroupRequest	withServiceRoleArn(String serviceRoleArn) A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
CreateDeploymentGroupRequest	withTags(Collection<Tag> tags) The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
CreateDeploymentGroupRequest	withTags(Tag... tags) The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
CreateDeploymentGroupRequest	withTerminationHookEnabled(Boolean terminationHookEnabled) This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDeploymentGroupRequest

public CreateDeploymentGroupRequest()

Method Detail

setApplicationName

public void setApplicationName(String applicationName)

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

Parameters:

applicationName - The name of an CodeDeploy application associated with the user or Amazon Web Services account.

getApplicationName

public String getApplicationName()

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

Returns:

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

withApplicationName

public CreateDeploymentGroupRequest withApplicationName(String applicationName)

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

Parameters:

applicationName - The name of an CodeDeploy application associated with the user or Amazon Web Services 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 a new deployment group for the specified application.

Parameters:

deploymentGroupName - The name of a new deployment group for the specified application.

getDeploymentGroupName

public String 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

public CreateDeploymentGroupRequest withDeploymentGroupName(String deploymentGroupName)

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

public void setDeploymentConfigName(String deploymentConfigName)

If specified, the deployment configuration name can be either one of the predefined configurations provided with 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 deployment group.

For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.

Parameters:

deploymentConfigName - If specified, the deployment configuration name can be either one of the predefined configurations provided with 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 deployment group.

For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.

getDeploymentConfigName

public String getDeploymentConfigName()

If specified, the deployment configuration name can be either one of the predefined configurations provided with 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 deployment group.

For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.

Returns:

If specified, the deployment configuration name can be either one of the predefined configurations provided with 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 deployment group.

For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.

withDeploymentConfigName

public CreateDeploymentGroupRequest withDeploymentConfigName(String deploymentConfigName)

If specified, the deployment configuration name can be either one of the predefined configurations provided with 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 deployment group.

For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.

Parameters:

deploymentConfigName - If specified, the deployment configuration name can be either one of the predefined configurations provided with 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 deployment group.

For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.

Returns:

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

getEc2TagFilters

public List<EC2TagFilter> getEc2TagFilters()

The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

Returns:

The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

setEc2TagFilters

public void setEc2TagFilters(Collection<EC2TagFilter> ec2TagFilters)

The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

Parameters:

ec2TagFilters - The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

withEc2TagFilters

public CreateDeploymentGroupRequest withEc2TagFilters(EC2TagFilter... ec2TagFilters)

The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

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 on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

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 on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

Parameters:

ec2TagFilters - The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

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 on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

Returns:

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

setOnPremisesInstanceTagFilters

public void setOnPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters)

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

withOnPremisesInstanceTagFilters

public CreateDeploymentGroupRequest withOnPremisesInstanceTagFilters(TagFilter... onPremisesInstanceTagFilters)

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

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 on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

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. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

Returns:

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

getAutoScalingGroups

public List<String> getAutoScalingGroups()

A list of associated Amazon EC2 Auto Scaling groups.

Returns:

A list of associated Amazon EC2 Auto Scaling groups.

setAutoScalingGroups

public void setAutoScalingGroups(Collection<String> autoScalingGroups)

A list of associated Amazon EC2 Auto Scaling groups.

Parameters:

autoScalingGroups - A list of associated Amazon EC2 Auto Scaling groups.

withAutoScalingGroups

public CreateDeploymentGroupRequest withAutoScalingGroups(String... autoScalingGroups)

A list of associated Amazon EC2 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 Amazon EC2 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 Amazon EC2 Auto Scaling groups.

Parameters:

autoScalingGroups - A list of associated Amazon EC2 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 Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

Parameters:

serviceRoleArn - A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

getServiceRoleArn

public String getServiceRoleArn()

A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

Returns:

A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

withServiceRoleArn

public CreateDeploymentGroupRequest withServiceRoleArn(String serviceRoleArn)

A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

Parameters:

serviceRoleArn - A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

Returns:

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

getTriggerConfigurations

public List<TriggerConfig> getTriggerConfigurations()

Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.

Returns:

Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.

setTriggerConfigurations

public void setTriggerConfigurations(Collection<TriggerConfig> triggerConfigurations)

Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.

Parameters:

triggerConfigurations - Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.

withTriggerConfigurations

public CreateDeploymentGroupRequest withTriggerConfigurations(TriggerConfig... triggerConfigurations)

Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.

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.

Parameters:

triggerConfigurations - Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.

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. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.

Parameters:

triggerConfigurations - Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.

Returns:

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

setAlarmConfiguration

public void setAlarmConfiguration(AlarmConfiguration alarmConfiguration)

Information to add about Amazon CloudWatch alarms when the deployment group is created.

Parameters:

alarmConfiguration - Information to add about Amazon CloudWatch alarms when the deployment group is created.

getAlarmConfiguration

public AlarmConfiguration getAlarmConfiguration()

Information to add about Amazon CloudWatch alarms when the deployment group is created.

Returns:

Information to add about Amazon CloudWatch alarms when the deployment group is created.

withAlarmConfiguration

public CreateDeploymentGroupRequest withAlarmConfiguration(AlarmConfiguration alarmConfiguration)

Information to add about Amazon CloudWatch alarms when the deployment group is created.

Parameters:

alarmConfiguration - Information to add about Amazon CloudWatch alarms when the deployment group is created.

Returns:

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

setAutoRollbackConfiguration

public void setAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

Configuration information for an automatic rollback that is added when a deployment group is created.

Parameters:

autoRollbackConfiguration - Configuration information for an automatic rollback that is added when a deployment group is created.

getAutoRollbackConfiguration

public AutoRollbackConfiguration getAutoRollbackConfiguration()

Configuration information for an automatic rollback that is added when a deployment group is created.

Returns:

Configuration information for an automatic rollback that is added when a deployment group is created.

withAutoRollbackConfiguration

public CreateDeploymentGroupRequest withAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

Configuration information for an automatic rollback that is added when a deployment group is created.

Parameters:

autoRollbackConfiguration - Configuration information for an automatic rollback that is added when a deployment group is created.

Returns:

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

setOutdatedInstancesStrategy

public void setOutdatedInstancesStrategy(String outdatedInstancesStrategy)

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

Parameters:

outdatedInstancesStrategy - Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

See Also:

OutdatedInstancesStrategy

getOutdatedInstancesStrategy

public String getOutdatedInstancesStrategy()

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

Returns:

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

See Also:

OutdatedInstancesStrategy

withOutdatedInstancesStrategy

public CreateDeploymentGroupRequest withOutdatedInstancesStrategy(String outdatedInstancesStrategy)

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

Parameters:

outdatedInstancesStrategy - Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

Returns:

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

See Also:

OutdatedInstancesStrategy

withOutdatedInstancesStrategy

public CreateDeploymentGroupRequest withOutdatedInstancesStrategy(OutdatedInstancesStrategy outdatedInstancesStrategy)

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

Parameters:

outdatedInstancesStrategy - Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

Returns:

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

See Also:

OutdatedInstancesStrategy

setDeploymentStyle

public void setDeploymentStyle(DeploymentStyle deploymentStyle)

Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

Parameters:

deploymentStyle - Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

getDeploymentStyle

public DeploymentStyle getDeploymentStyle()

Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

Returns:

Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

withDeploymentStyle

public CreateDeploymentGroupRequest withDeploymentStyle(DeploymentStyle deploymentStyle)

Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

Parameters:

deploymentStyle - Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

Returns:

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

setBlueGreenDeploymentConfiguration

public void setBlueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)

Information about blue/green deployment options for a deployment group.

Parameters:

blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group.

getBlueGreenDeploymentConfiguration

public BlueGreenDeploymentConfiguration getBlueGreenDeploymentConfiguration()

Information about blue/green deployment options for a deployment group.

Returns:

Information about blue/green deployment options for a deployment group.

withBlueGreenDeploymentConfiguration

public CreateDeploymentGroupRequest withBlueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)

Information about blue/green deployment options for a deployment group.

Parameters:

blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group.

Returns:

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

setLoadBalancerInfo

public void setLoadBalancerInfo(LoadBalancerInfo loadBalancerInfo)

Information about the load balancer used in a deployment.

Parameters:

loadBalancerInfo - Information about the load balancer used in a deployment.

getLoadBalancerInfo

public LoadBalancerInfo getLoadBalancerInfo()

Information about the load balancer used in a deployment.

Returns:

Information about the load balancer used in a deployment.

withLoadBalancerInfo

public CreateDeploymentGroupRequest withLoadBalancerInfo(LoadBalancerInfo loadBalancerInfo)

Information about the load balancer used in a deployment.

Parameters:

loadBalancerInfo - Information about the load balancer used in a deployment.

Returns:

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

setEc2TagSet

public void setEc2TagSet(EC2TagSet ec2TagSet)

Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

Parameters:

ec2TagSet - Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

getEc2TagSet

public EC2TagSet getEc2TagSet()

Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

Returns:

Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

withEc2TagSet

public CreateDeploymentGroupRequest withEc2TagSet(EC2TagSet ec2TagSet)

Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

Parameters:

ec2TagSet - Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

Returns:

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

getEcsServices

public List<ECSService> getEcsServices()

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

Returns:

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

setEcsServices

public void setEcsServices(Collection<ECSService> ecsServices)

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

Parameters:

ecsServices - The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

withEcsServices

public CreateDeploymentGroupRequest withEcsServices(ECSService... ecsServices)

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

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

Parameters:

ecsServices - The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

Returns:

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

withEcsServices

public CreateDeploymentGroupRequest withEcsServices(Collection<ECSService> ecsServices)

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

Parameters:

ecsServices - The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

Returns:

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

setOnPremisesTagSet

public void setOnPremisesTagSet(OnPremisesTagSet onPremisesTagSet)

Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

Parameters:

onPremisesTagSet - Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

getOnPremisesTagSet

public OnPremisesTagSet getOnPremisesTagSet()

Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

Returns:

Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

withOnPremisesTagSet

public CreateDeploymentGroupRequest withOnPremisesTagSet(OnPremisesTagSet onPremisesTagSet)

Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

Parameters:

onPremisesTagSet - Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

Returns:

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

getTags

public List<Tag> getTags()

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

Returns:

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

setTags

public void setTags(Collection<Tag> tags)

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

Parameters:

tags - The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

withTags

public CreateDeploymentGroupRequest withTags(Tag... tags)

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

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

Parameters:

tags - The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

Returns:

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

withTags

public CreateDeploymentGroupRequest withTags(Collection<Tag> tags)

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

Parameters:

tags - The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

Returns:

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

setTerminationHookEnabled

public void setTerminationHookEnabled(Boolean terminationHookEnabled)

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

Parameters:

terminationHookEnabled - This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

getTerminationHookEnabled

public Boolean getTerminationHookEnabled()

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

Returns:

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

withTerminationHookEnabled

public CreateDeploymentGroupRequest withTerminationHookEnabled(Boolean terminationHookEnabled)

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

Parameters:

terminationHookEnabled - This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

Returns:

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

isTerminationHookEnabled

public Boolean isTerminationHookEnabled()

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

Returns:

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()