Interface CreateDeploymentGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeDeployRequest.Builder, CopyableBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>, SdkBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDeploymentGroupRequest

public static interface CreateDeploymentGroupRequest.Builder extends CodeDeployRequest.Builder, SdkPojo, CopyableBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>
  • Method Details

    • applicationName

      CreateDeploymentGroupRequest.Builder applicationName(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.
    • 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 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.
    • 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.
    • ec2TagFilters

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

      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

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

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

      CreateDeploymentGroupRequest.Builder onPremisesInstanceTagFilters(Consumer<TagFilter.Builder>... 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.

      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

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

      CreateDeploymentGroupRequest.Builder autoScalingGroups(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.
    • serviceRoleArn

      CreateDeploymentGroupRequest.Builder serviceRoleArn(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.
    • 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 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.
    • 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 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.
    • 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 CodeDeploy Event 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

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

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

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

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

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

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

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

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

      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

      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

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

      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

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

      default CreateDeploymentGroupRequest.Builder onPremisesTagSet(Consumer<OnPremisesTagSet.Builder> 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.

      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:
    • 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.
    • 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.
    • 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.

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

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

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

      CreateDeploymentGroupRequest.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 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.
    • 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

      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.