software.amazon.awssdk.services.codedeploy.model

Interface CreateDeploymentGroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CodeDeployRequest.Builder, CopyableBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>, SdkBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>, SdkRequest.Builder

Enclosing class:

CreateDeploymentGroupRequest

public static interface CreateDeploymentGroupRequest.Builder
extends CodeDeployRequest.Builder, CopyableBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>

Method Summary

Modifier and Type	Method and Description
CreateDeploymentGroupRequest.Builder	alarmConfiguration(AlarmConfiguration alarmConfiguration) Information to add about Amazon CloudWatch alarms when the deployment group is created.
default CreateDeploymentGroupRequest.Builder	alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration) Information to add about Amazon CloudWatch alarms when the deployment group is created.
CreateDeploymentGroupRequest.Builder	applicationName(String applicationName) The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
CreateDeploymentGroupRequest.Builder	autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration) Configuration information for an automatic rollback that is added when a deployment group is created.
default CreateDeploymentGroupRequest.Builder	autoRollbackConfiguration(Consumer<AutoRollbackConfiguration.Builder> autoRollbackConfiguration) Configuration information for an automatic rollback that is added when a deployment group is created.
CreateDeploymentGroupRequest.Builder	autoScalingGroups(Collection<String> autoScalingGroups) A list of associated Auto Scaling groups.
CreateDeploymentGroupRequest.Builder	autoScalingGroups(String... autoScalingGroups) A list of associated Auto Scaling groups.
CreateDeploymentGroupRequest.Builder	blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration) Information about blue/green deployment options for a deployment group.
default CreateDeploymentGroupRequest.Builder	blueGreenDeploymentConfiguration(Consumer<BlueGreenDeploymentConfiguration.Builder> blueGreenDeploymentConfiguration) Information about blue/green deployment options for a deployment group.
CreateDeploymentGroupRequest.Builder	deploymentConfigName(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.
CreateDeploymentGroupRequest.Builder	deploymentGroupName(String deploymentGroupName) The name of a new deployment group for the specified application.
default CreateDeploymentGroupRequest.Builder	deploymentStyle(Consumer<DeploymentStyle.Builder> 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.Builder	deploymentStyle(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.Builder	ec2TagFilters(Collection<EC2TagFilter> ec2TagFilters) The Amazon EC2 tags on which to filter.
CreateDeploymentGroupRequest.Builder	ec2TagFilters(Consumer<EC2TagFilter.Builder>... ec2TagFilters) The Amazon EC2 tags on which to filter.
CreateDeploymentGroupRequest.Builder	ec2TagFilters(EC2TagFilter... ec2TagFilters) The Amazon EC2 tags on which to filter.
default CreateDeploymentGroupRequest.Builder	ec2TagSet(Consumer<EC2TagSet.Builder> ec2TagSet) Information about groups of tags applied to EC2 instances.
CreateDeploymentGroupRequest.Builder	ec2TagSet(EC2TagSet ec2TagSet) Information about groups of tags applied to EC2 instances.
default CreateDeploymentGroupRequest.Builder	loadBalancerInfo(Consumer<LoadBalancerInfo.Builder> loadBalancerInfo) Information about the load balancer used in a deployment.
CreateDeploymentGroupRequest.Builder	loadBalancerInfo(LoadBalancerInfo loadBalancerInfo) Information about the load balancer used in a deployment.
CreateDeploymentGroupRequest.Builder	onPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.
CreateDeploymentGroupRequest.Builder	onPremisesInstanceTagFilters(Consumer<TagFilter.Builder>... onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.
CreateDeploymentGroupRequest.Builder	onPremisesInstanceTagFilters(TagFilter... onPremisesInstanceTagFilters) The on-premises instance tags on which to filter.
default CreateDeploymentGroupRequest.Builder	onPremisesTagSet(Consumer<OnPremisesTagSet.Builder> onPremisesTagSet) Information about groups of tags applied to on-premises instances.
CreateDeploymentGroupRequest.Builder	onPremisesTagSet(OnPremisesTagSet onPremisesTagSet) Information about groups of tags applied to on-premises instances.
CreateDeploymentGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateDeploymentGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateDeploymentGroupRequest.Builder	serviceRoleArn(String serviceRoleArn) A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
CreateDeploymentGroupRequest.Builder	triggerConfigurations(Collection<TriggerConfig> triggerConfigurations) Information about triggers to create when the deployment group is created.
CreateDeploymentGroupRequest.Builder	triggerConfigurations(Consumer<TriggerConfig.Builder>... triggerConfigurations) Information about triggers to create when the deployment group is created.
CreateDeploymentGroupRequest.Builder	triggerConfigurations(TriggerConfig... triggerConfigurations) Information about triggers to create when the deployment group is created.

Methods inherited from interface software.amazon.awssdk.services.codedeploy.model.CodeDeployRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

applicationName

CreateDeploymentGroupRequest.Builder applicationName(String applicationName)

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.

deploymentGroupName

CreateDeploymentGroupRequest.Builder deploymentGroupName(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.

deploymentConfigName

CreateDeploymentGroupRequest.Builder deploymentConfigName(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.

CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.

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

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.

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

Returns:

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

ec2TagFilters

CreateDeploymentGroupRequest.Builder ec2TagFilters(Collection<EC2TagFilter> ec2TagFilters)

The Amazon EC2 tags on which to filter. The deployment group will include 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 will include 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.

ec2TagFilters

CreateDeploymentGroupRequest.Builder ec2TagFilters(EC2TagFilter... ec2TagFilters)

The Amazon EC2 tags on which to filter. The deployment group will include 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 will include 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.

ec2TagFilters

CreateDeploymentGroupRequest.Builder ec2TagFilters(Consumer<EC2TagFilter.Builder>... ec2TagFilters)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #ec2TagFilters(List).

Parameters:

ec2TagFilters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#ec2TagFilters(List)

onPremisesInstanceTagFilters

CreateDeploymentGroupRequest.Builder onPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters)

The on-premises instance tags on which to filter. The deployment group will include 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 will include 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.

onPremisesInstanceTagFilters

CreateDeploymentGroupRequest.Builder onPremisesInstanceTagFilters(TagFilter... onPremisesInstanceTagFilters)

The on-premises instance tags on which to filter. The deployment group will include 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 will include 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.

onPremisesInstanceTagFilters

CreateDeploymentGroupRequest.Builder onPremisesInstanceTagFilters(Consumer<TagFilter.Builder>... onPremisesInstanceTagFilters)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #onPremisesInstanceTagFilters(List).

Parameters:

onPremisesInstanceTagFilters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#onPremisesInstanceTagFilters(List)

autoScalingGroups

CreateDeploymentGroupRequest.Builder autoScalingGroups(Collection<String> autoScalingGroups)

A list of associated Auto Scaling groups.

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups.

Returns:

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

autoScalingGroups

CreateDeploymentGroupRequest.Builder autoScalingGroups(String... autoScalingGroups)

A list of associated Auto Scaling groups.

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups.

Returns:

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

serviceRoleArn

CreateDeploymentGroupRequest.Builder serviceRoleArn(String serviceRoleArn)

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

Parameters:

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

Returns:

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

triggerConfigurations

CreateDeploymentGroupRequest.Builder triggerConfigurations(Collection<TriggerConfig> triggerConfigurations)

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

Parameters:

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

Returns:

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

triggerConfigurations

CreateDeploymentGroupRequest.Builder triggerConfigurations(TriggerConfig... triggerConfigurations)

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

Parameters:

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

Returns:

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

triggerConfigurations

CreateDeploymentGroupRequest.Builder triggerConfigurations(Consumer<TriggerConfig.Builder>... triggerConfigurations)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #triggerConfigurations(List).

Parameters:

triggerConfigurations - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#triggerConfigurations(List)

alarmConfiguration

CreateDeploymentGroupRequest.Builder alarmConfiguration(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.

alarmConfiguration

default CreateDeploymentGroupRequest.Builder alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)

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

This is a convenience that creates an instance of the AlarmConfiguration.Builder avoiding the need to create one manually via AlarmConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmConfiguration(AlarmConfiguration).

Parameters:

alarmConfiguration - a consumer that will call methods on AlarmConfiguration.Builder

Returns:

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

See Also:

alarmConfiguration(AlarmConfiguration)

autoRollbackConfiguration

CreateDeploymentGroupRequest.Builder autoRollbackConfiguration(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.

autoRollbackConfiguration

default CreateDeploymentGroupRequest.Builder autoRollbackConfiguration(Consumer<AutoRollbackConfiguration.Builder> autoRollbackConfiguration)

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

This is a convenience that creates an instance of the AutoRollbackConfiguration.Builder avoiding the need to create one manually via AutoRollbackConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoRollbackConfiguration(AutoRollbackConfiguration).

Parameters:

autoRollbackConfiguration - a consumer that will call methods on AutoRollbackConfiguration.Builder

Returns:

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

See Also:

autoRollbackConfiguration(AutoRollbackConfiguration)

deploymentStyle

CreateDeploymentGroupRequest.Builder deploymentStyle(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.

deploymentStyle

default CreateDeploymentGroupRequest.Builder deploymentStyle(Consumer<DeploymentStyle.Builder> 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.

This is a convenience that creates an instance of the DeploymentStyle.Builder avoiding the need to create one manually via DeploymentStyle.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentStyle(DeploymentStyle).

Parameters:

deploymentStyle - a consumer that will call methods on DeploymentStyle.Builder

Returns:

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

See Also:

deploymentStyle(DeploymentStyle)

blueGreenDeploymentConfiguration

CreateDeploymentGroupRequest.Builder blueGreenDeploymentConfiguration(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.

blueGreenDeploymentConfiguration

default CreateDeploymentGroupRequest.Builder blueGreenDeploymentConfiguration(Consumer<BlueGreenDeploymentConfiguration.Builder> blueGreenDeploymentConfiguration)

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

This is a convenience that creates an instance of the BlueGreenDeploymentConfiguration.Builder avoiding the need to create one manually via BlueGreenDeploymentConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration).

Parameters:

blueGreenDeploymentConfiguration - a consumer that will call methods on BlueGreenDeploymentConfiguration.Builder

Returns:

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

See Also:

blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration)

loadBalancerInfo

CreateDeploymentGroupRequest.Builder loadBalancerInfo(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.

loadBalancerInfo

default CreateDeploymentGroupRequest.Builder loadBalancerInfo(Consumer<LoadBalancerInfo.Builder> loadBalancerInfo)

Information about the load balancer used in a deployment.

This is a convenience that creates an instance of the LoadBalancerInfo.Builder avoiding the need to create one manually via LoadBalancerInfo.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loadBalancerInfo(LoadBalancerInfo).

Parameters:

loadBalancerInfo - a consumer that will call methods on LoadBalancerInfo.Builder

Returns:

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

See Also:

loadBalancerInfo(LoadBalancerInfo)

ec2TagSet

CreateDeploymentGroupRequest.Builder ec2TagSet(EC2TagSet ec2TagSet)

Information about groups of tags applied to EC2 instances. The deployment group will include only 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 EC2 instances. The deployment group will include only 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.

ec2TagSet

default CreateDeploymentGroupRequest.Builder ec2TagSet(Consumer<EC2TagSet.Builder> ec2TagSet)

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

This is a convenience that creates an instance of the EC2TagSet.Builder avoiding the need to create one manually via EC2TagSet.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ec2TagSet(EC2TagSet).

Parameters:

ec2TagSet - a consumer that will call methods on EC2TagSet.Builder

Returns:

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

See Also:

ec2TagSet(EC2TagSet)

onPremisesTagSet

CreateDeploymentGroupRequest.Builder onPremisesTagSet(OnPremisesTagSet onPremisesTagSet)

Information about groups of tags applied to on-premises instances. The deployment group will include only on-premises instances identified by all 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 will include only on-premises instances identified by all 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.

onPremisesTagSet

default CreateDeploymentGroupRequest.Builder onPremisesTagSet(Consumer<OnPremisesTagSet.Builder> onPremisesTagSet)

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

This is a convenience that creates an instance of the OnPremisesTagSet.Builder avoiding the need to create one manually via OnPremisesTagSet.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onPremisesTagSet(OnPremisesTagSet).

Parameters:

onPremisesTagSet - a consumer that will call methods on OnPremisesTagSet.Builder

Returns:

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

See Also:

onPremisesTagSet(OnPremisesTagSet)

overrideConfiguration

CreateDeploymentGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateDeploymentGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.