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

Interface DeploymentGroupInfo.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DeploymentGroupInfo.Builder,DeploymentGroupInfo>, SdkBuilder<DeploymentGroupInfo.Builder,DeploymentGroupInfo>, SdkPojo
Enclosing class:
DeploymentGroupInfo
public static interface DeploymentGroupInfo.Builder extends SdkPojo, CopyableBuilder<DeploymentGroupInfo.Builder,DeploymentGroupInfo>

  • Method Details

    • applicationName

      DeploymentGroupInfo.Builder applicationName(String applicationName)

      The application name.

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

    • deploymentGroupId

      DeploymentGroupInfo.Builder deploymentGroupId(String deploymentGroupId)

      The deployment group ID.

      Parameters:
      deploymentGroupId - The deployment group ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentGroupName

      DeploymentGroupInfo.Builder deploymentGroupName(String deploymentGroupName)

      The deployment group name.

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

    • deploymentConfigName

      DeploymentGroupInfo.Builder deploymentConfigName(String deploymentConfigName)

      The deployment configuration name.

      Parameters:
      deploymentConfigName - The deployment configuration name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2TagFilters

      DeploymentGroupInfo.Builder ec2TagFilters(Collection<EC2TagFilter> ec2TagFilters)

      The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

      Parameters:
      ec2TagFilters - The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2TagFilters

      DeploymentGroupInfo.Builder ec2TagFilters(EC2TagFilter... ec2TagFilters)

      The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

      Parameters:
      ec2TagFilters - The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2TagFilters

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

      The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

      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

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

      Parameters:
      onPremisesInstanceTagFilters - The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onPremisesInstanceTagFilters

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

      Parameters:
      onPremisesInstanceTagFilters - The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onPremisesInstanceTagFilters

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

      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

      DeploymentGroupInfo.Builder autoScalingGroups(Collection<AutoScalingGroup> 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

      DeploymentGroupInfo.Builder autoScalingGroups(AutoScalingGroup... 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

      DeploymentGroupInfo.Builder autoScalingGroups(Consumer<AutoScalingGroup.Builder>... autoScalingGroups)

      A list of associated Auto Scaling groups.

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

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

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

    • serviceRoleArn

      DeploymentGroupInfo.Builder serviceRoleArn(String serviceRoleArn)

      A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the CodeDeploy User Guide.

      Parameters:
      serviceRoleArn - A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the CodeDeploy User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetRevision

      DeploymentGroupInfo.Builder targetRevision(RevisionLocation targetRevision)

      Information about the deployment group's target revision, including type and location.

      Parameters:
      targetRevision - Information about the deployment group's target revision, including type and location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetRevision

      default DeploymentGroupInfo.Builder targetRevision(Consumer<RevisionLocation.Builder> targetRevision)

      Information about the deployment group's target revision, including type and location.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetRevision(RevisionLocation).

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

    • triggerConfigurations

      DeploymentGroupInfo.Builder triggerConfigurations(Collection<TriggerConfig> triggerConfigurations)

      Information about triggers associated with the deployment group.

      Parameters:
      triggerConfigurations - Information about triggers associated with the deployment group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerConfigurations

      DeploymentGroupInfo.Builder triggerConfigurations(TriggerConfig... triggerConfigurations)

      Information about triggers associated with the deployment group.

      Parameters:
      triggerConfigurations - Information about triggers associated with the deployment group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerConfigurations

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

      Information about triggers associated with the deployment group.

      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

      DeploymentGroupInfo.Builder alarmConfiguration(AlarmConfiguration alarmConfiguration)

      A list of alarms associated with the deployment group.

      Parameters:
      alarmConfiguration - A list of alarms associated with the deployment group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmConfiguration

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

      A list of alarms associated with the deployment group.

      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

      DeploymentGroupInfo.Builder autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

      Information about the automatic rollback configuration associated with the deployment group.

      Parameters:
      autoRollbackConfiguration - Information about the automatic rollback configuration associated with the deployment group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoRollbackConfiguration

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

      Information about the automatic rollback configuration associated with the deployment group.

      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:

    • deploymentStyle

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

    • outdatedInstancesStrategy

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

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

    • blueGreenDeploymentConfiguration

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

      DeploymentGroupInfo.Builder loadBalancerInfo(LoadBalancerInfo loadBalancerInfo)

      Information about the load balancer to use in a deployment.

      Parameters:
      loadBalancerInfo - Information about the load balancer to use in a deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loadBalancerInfo

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

      Information about the load balancer to use 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:

    • lastSuccessfulDeployment

      DeploymentGroupInfo.Builder lastSuccessfulDeployment(LastDeploymentInfo lastSuccessfulDeployment)

      Information about the most recent successful deployment to the deployment group.

      Parameters:
      lastSuccessfulDeployment - Information about the most recent successful deployment to the deployment group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastSuccessfulDeployment

      default DeploymentGroupInfo.Builder lastSuccessfulDeployment(Consumer<LastDeploymentInfo.Builder> lastSuccessfulDeployment)

      Information about the most recent successful deployment to the deployment group.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastSuccessfulDeployment(LastDeploymentInfo).

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

    • lastAttemptedDeployment

      DeploymentGroupInfo.Builder lastAttemptedDeployment(LastDeploymentInfo lastAttemptedDeployment)

      Information about the most recent attempted deployment to the deployment group.

      Parameters:
      lastAttemptedDeployment - Information about the most recent attempted deployment to the deployment group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastAttemptedDeployment

      default DeploymentGroupInfo.Builder lastAttemptedDeployment(Consumer<LastDeploymentInfo.Builder> lastAttemptedDeployment)

      Information about the most recent attempted deployment to the deployment group.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastAttemptedDeployment(LastDeploymentInfo).

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

    • ec2TagSet

      DeploymentGroupInfo.Builder ec2TagSet(EC2TagSet ec2TagSet)

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

      Parameters:
      ec2TagSet - Information about groups of tags applied to an Amazon EC2 instance. The deployment group includes only Amazon EC2 instances identified by all of 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 DeploymentGroupInfo.Builder ec2TagSet(Consumer<EC2TagSet.Builder> ec2TagSet)

      Information about groups of tags applied to an Amazon EC2 instance. The deployment group includes only Amazon EC2 instances identified by all of 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:

    • onPremisesTagSet

      DeploymentGroupInfo.Builder onPremisesTagSet(OnPremisesTagSet onPremisesTagSet)

      Information about groups of tags applied to an on-premises instance. The deployment group includes 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 an on-premises instance. The deployment group includes 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 DeploymentGroupInfo.Builder onPremisesTagSet(Consumer<OnPremisesTagSet.Builder> onPremisesTagSet)

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

    • computePlatform

      DeploymentGroupInfo.Builder computePlatform(String computePlatform)

      The destination platform type for the deployment (Lambda, Server, or ECS).

      Parameters:
      computePlatform - The destination platform type for the deployment (Lambda, Server, or ECS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • computePlatform

      DeploymentGroupInfo.Builder computePlatform(ComputePlatform computePlatform)

      The destination platform type for the deployment (Lambda, Server, or ECS).

      Parameters:
      computePlatform - The destination platform type for the deployment (Lambda, Server, or ECS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ecsServices

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

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

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