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

Interface CreateDeploymentGroupRequest.Builder

    • Method Detail

      • 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

        CreateDeploymentGroupRequest.Builder ec2TagFilters​(Collection<EC2TagFilter> ec2TagFilters)

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

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

      • 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

        CreateDeploymentGroupRequest.Builder ec2TagFilters​(Consumer<EC2TagFilter.Builder>... 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).

        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:
        #ec2TagFilters(java.util.Collection)

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

        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:
        #onPremisesInstanceTagFilters(java.util.Collection)

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

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

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

      • 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, OutdatedInstancesStrategy

      • 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:
        OutdatedInstancesStrategy, OutdatedInstancesStrategy

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

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

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

      • ec2TagSet

        CreateDeploymentGroupRequest.Builder ec2TagSet​(EC2TagSet ec2TagSet)

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

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

      • ecsServices

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

        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

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

        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:
        #ecsServices(java.util.Collection)

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

      • tags

        CreateDeploymentGroupRequest.Builder tags​(Collection<Tag> tags)

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

        Parameters:
        tags - The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDeploymentGroupRequest.Builder tags​(Tag... tags)

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

        Parameters:
        tags - The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDeploymentGroupRequest.Builder tags​(Consumer<Tag.Builder>... 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).

        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:
        #tags(java.util.Collection)

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