Package software.amazon.awssdk.services.codedeploy.model

Interface UpdateDeploymentGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeDeployRequest.Builder, CopyableBuilder<UpdateDeploymentGroupRequest.Builder,UpdateDeploymentGroupRequest>, SdkBuilder<UpdateDeploymentGroupRequest.Builder,UpdateDeploymentGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateDeploymentGroupRequest
public static interface UpdateDeploymentGroupRequest.Builder extends CodeDeployRequest.Builder, SdkPojo, CopyableBuilder<UpdateDeploymentGroupRequest.Builder,UpdateDeploymentGroupRequest>

  • Method Details

    • applicationName

      UpdateDeploymentGroupRequest.Builder applicationName(String applicationName)

      The application name that corresponds to the deployment group to update.

      Parameters:
      applicationName - The application name that corresponds to the deployment group to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • currentDeploymentGroupName

      UpdateDeploymentGroupRequest.Builder currentDeploymentGroupName(String currentDeploymentGroupName)

      The current name of the deployment group.

      Parameters:
      currentDeploymentGroupName - The current name of the deployment group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newDeploymentGroupName

      UpdateDeploymentGroupRequest.Builder newDeploymentGroupName(String newDeploymentGroupName)

      The new name of the deployment group, if you want to change it.

      Parameters:
      newDeploymentGroupName - The new name of the deployment group, if you want to change it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentConfigName

      UpdateDeploymentGroupRequest.Builder deploymentConfigName(String deploymentConfigName)

      The replacement deployment configuration name to use, if you want to change it.

      Parameters:
      deploymentConfigName - The replacement deployment configuration name to use, if you want to change it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2TagFilters

      UpdateDeploymentGroupRequest.Builder ec2TagFilters(Collection<EC2TagFilter> ec2TagFilters)

      The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

      Parameters:
      ec2TagFilters - The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2TagFilters

      UpdateDeploymentGroupRequest.Builder ec2TagFilters(EC2TagFilter... ec2TagFilters)

      The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

      Parameters:
      ec2TagFilters - The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2TagFilters

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

      The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

      This is a convenience method that creates an instance of the EC2TagFilter.Builder avoiding the need to create one manually via EC2TagFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ec2TagFilters(List<EC2TagFilter>).

      Parameters:
      ec2TagFilters - a consumer that will call methods on EC2TagFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • onPremisesInstanceTagFilters

      UpdateDeploymentGroupRequest.Builder onPremisesInstanceTagFilters(Collection<TagFilter> onPremisesInstanceTagFilters)

      The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

      Parameters:
      onPremisesInstanceTagFilters - The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onPremisesInstanceTagFilters

      UpdateDeploymentGroupRequest.Builder onPremisesInstanceTagFilters(TagFilter... onPremisesInstanceTagFilters)

      The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

      Parameters:
      onPremisesInstanceTagFilters - The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onPremisesInstanceTagFilters

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

      The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

      This is a convenience method that creates an instance of the TagFilter.Builder avoiding the need to create one manually via TagFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onPremisesInstanceTagFilters(List<TagFilter>).

      Parameters:
      onPremisesInstanceTagFilters - a consumer that will call methods on TagFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoScalingGroups

      UpdateDeploymentGroupRequest.Builder autoScalingGroups(Collection<String> autoScalingGroups)

      The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

      Parameters:
      autoScalingGroups - The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

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

    • autoScalingGroups

      UpdateDeploymentGroupRequest.Builder autoScalingGroups(String... autoScalingGroups)

      The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

      Parameters:
      autoScalingGroups - The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

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

    • serviceRoleArn

      UpdateDeploymentGroupRequest.Builder serviceRoleArn(String serviceRoleArn)

      A replacement ARN for the service role, if you want to change it.

      Parameters:
      serviceRoleArn - A replacement ARN for the service role, if you want to change it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerConfigurations

      UpdateDeploymentGroupRequest.Builder triggerConfigurations(Collection<TriggerConfig> triggerConfigurations)

      Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.

      Parameters:
      triggerConfigurations - Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerConfigurations

      UpdateDeploymentGroupRequest.Builder triggerConfigurations(TriggerConfig... triggerConfigurations)

      Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.

      Parameters:
      triggerConfigurations - Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerConfigurations

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

      Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.

      This is a convenience method that creates an instance of the TriggerConfig.Builder avoiding the need to create one manually via TriggerConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to triggerConfigurations(List<TriggerConfig>).

      Parameters:
      triggerConfigurations - a consumer that will call methods on TriggerConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • alarmConfiguration

      UpdateDeploymentGroupRequest.Builder alarmConfiguration(AlarmConfiguration alarmConfiguration)

      Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

      Parameters:
      alarmConfiguration - Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmConfiguration

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

      Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

      This is a convenience method 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:

    • autoRollbackConfiguration

      UpdateDeploymentGroupRequest.Builder autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

      Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

      Parameters:
      autoRollbackConfiguration - Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoRollbackConfiguration

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

      Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

      This is a convenience method 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:

    • outdatedInstancesStrategy

      UpdateDeploymentGroupRequest.Builder outdatedInstancesStrategy(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

      UpdateDeploymentGroupRequest.Builder outdatedInstancesStrategy(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:

    • deploymentStyle

      UpdateDeploymentGroupRequest.Builder deploymentStyle(DeploymentStyle deploymentStyle)

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

      Parameters:
      deploymentStyle - Information about the type of deployment, either in-place or blue/green, 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 UpdateDeploymentGroupRequest.Builder deploymentStyle(Consumer<DeploymentStyle.Builder> deploymentStyle)

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

      This is a convenience method 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:

    • blueGreenDeploymentConfiguration

      UpdateDeploymentGroupRequest.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 UpdateDeploymentGroupRequest.Builder blueGreenDeploymentConfiguration(Consumer<BlueGreenDeploymentConfiguration.Builder> blueGreenDeploymentConfiguration)

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

      This is a convenience method 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:

    • loadBalancerInfo

      UpdateDeploymentGroupRequest.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 UpdateDeploymentGroupRequest.Builder loadBalancerInfo(Consumer<LoadBalancerInfo.Builder> loadBalancerInfo)

      Information about the load balancer used in a deployment.

      This is a convenience method 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:

    • ec2TagSet

      UpdateDeploymentGroupRequest.Builder ec2TagSet(EC2TagSet ec2TagSet)

      Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.

      Parameters:
      ec2TagSet - Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2TagSet

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

      Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.

      This is a convenience method 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:

    • ecsServices

      UpdateDeploymentGroupRequest.Builder ecsServices(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.

    • ecsServices

      UpdateDeploymentGroupRequest.Builder ecsServices(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.

    • ecsServices

      UpdateDeploymentGroupRequest.Builder ecsServices(Consumer<ECSService.Builder>... 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>.

      This is a convenience method that creates an instance of the ECSService.Builder avoiding the need to create one manually via ECSService.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ecsServices(List<ECSService>).

      Parameters:
      ecsServices - a consumer that will call methods on ECSService.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • onPremisesTagSet

      UpdateDeploymentGroupRequest.Builder onPremisesTagSet(OnPremisesTagSet onPremisesTagSet)

      Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

      Parameters:
      onPremisesTagSet - Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onPremisesTagSet

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

      Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

      This is a convenience method 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:

    • terminationHookEnabled

      UpdateDeploymentGroupRequest.Builder terminationHookEnabled(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 update 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 update 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.

    • overrideConfiguration

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

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