Class CreateDeploymentGroupRequest

    • Constructor Detail

      • CreateDeploymentGroupRequest

        public CreateDeploymentGroupRequest()
    • Method Detail

      • setApplicationName

        public void setApplicationName​(String applicationName)

        The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

        Parameters:
        applicationName - The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
      • getApplicationName

        public String getApplicationName()

        The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

        Returns:
        The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
      • withApplicationName

        public CreateDeploymentGroupRequest withApplicationName​(String applicationName)

        The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

        Parameters:
        applicationName - The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDeploymentGroupName

        public void setDeploymentGroupName​(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.
      • getDeploymentGroupName

        public String getDeploymentGroupName()

        The name of a new deployment group for the specified application.

        Returns:
        The name of a new deployment group for the specified application.
      • withDeploymentGroupName

        public CreateDeploymentGroupRequest withDeploymentGroupName​(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.
      • setDeploymentConfigName

        public void setDeploymentConfigName​(String deploymentConfigName)

        If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

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

        The predefined deployment configurations include the following:

        • CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.

        • CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.

        • CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.

          For deployment groups that contain more than one instance:

          • The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.

          • The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.

          • In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.

          For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful

        Parameters:
        deploymentConfigName - If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

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

        The predefined deployment configurations include the following:

        • CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.

        • CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.

        • CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.

          For deployment groups that contain more than one instance:

          • The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.

          • The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.

          • In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.

          For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful

      • getDeploymentConfigName

        public String getDeploymentConfigName()

        If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

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

        The predefined deployment configurations include the following:

        • CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.

        • CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.

        • CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.

          For deployment groups that contain more than one instance:

          • The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.

          • The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.

          • In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.

          For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful

        Returns:
        If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

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

        The predefined deployment configurations include the following:

        • CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.

        • CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.

        • CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.

          For deployment groups that contain more than one instance:

          • The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.

          • The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.

          • In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.

          For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful

      • withDeploymentConfigName

        public CreateDeploymentGroupRequest withDeploymentConfigName​(String deploymentConfigName)

        If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

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

        The predefined deployment configurations include the following:

        • CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.

        • CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.

        • CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.

          For deployment groups that contain more than one instance:

          • The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.

          • The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.

          • In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.

          For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful

        Parameters:
        deploymentConfigName - If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

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

        The predefined deployment configurations include the following:

        • CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.

        • CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.

        • CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.

          For deployment groups that contain more than one instance:

          • The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.

          • The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.

          • In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.

          For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful

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

        public List<EC2TagFilter> getEc2TagFilters()

        The Amazon EC2 tags on which to filter.

        Returns:
        The Amazon EC2 tags on which to filter.
      • setEc2TagFilters

        public void setEc2TagFilters​(Collection<EC2TagFilter> ec2TagFilters)

        The Amazon EC2 tags on which to filter.

        Parameters:
        ec2TagFilters - The Amazon EC2 tags on which to filter.
      • withEc2TagFilters

        public CreateDeploymentGroupRequest withEc2TagFilters​(Collection<EC2TagFilter> ec2TagFilters)

        The Amazon EC2 tags on which to filter.

        Parameters:
        ec2TagFilters - The Amazon EC2 tags on which to filter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getOnPremisesInstanceTagFilters

        public List<TagFilter> getOnPremisesInstanceTagFilters()

        The on-premises instance tags on which to filter.

        Returns:
        The on-premises instance tags on which to filter.
      • setOnPremisesInstanceTagFilters

        public void setOnPremisesInstanceTagFilters​(Collection<TagFilter> onPremisesInstanceTagFilters)

        The on-premises instance tags on which to filter.

        Parameters:
        onPremisesInstanceTagFilters - The on-premises instance tags on which to filter.
      • withOnPremisesInstanceTagFilters

        public CreateDeploymentGroupRequest withOnPremisesInstanceTagFilters​(Collection<TagFilter> onPremisesInstanceTagFilters)

        The on-premises instance tags on which to filter.

        Parameters:
        onPremisesInstanceTagFilters - The on-premises instance tags on which to filter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getAutoScalingGroups

        public List<String> getAutoScalingGroups()

        A list of associated Auto Scaling groups.

        Returns:
        A list of associated Auto Scaling groups.
      • setAutoScalingGroups

        public void setAutoScalingGroups​(Collection<String> autoScalingGroups)

        A list of associated Auto Scaling groups.

        Parameters:
        autoScalingGroups - A list of associated Auto Scaling groups.
      • withAutoScalingGroups

        public CreateDeploymentGroupRequest withAutoScalingGroups​(Collection<String> autoScalingGroups)

        A list of associated Auto Scaling groups.

        Parameters:
        autoScalingGroups - A list of associated Auto Scaling groups.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setServiceRoleArn

        public void setServiceRoleArn​(String serviceRoleArn)

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

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

        public String getServiceRoleArn()

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

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

        public CreateDeploymentGroupRequest withServiceRoleArn​(String serviceRoleArn)

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

        Parameters:
        serviceRoleArn - A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getTriggerConfigurations

        public List<TriggerConfig> getTriggerConfigurations()

        Information about triggers to create when the deployment group is created.

        Returns:
        Information about triggers to create when the deployment group is created.
      • setTriggerConfigurations

        public void setTriggerConfigurations​(Collection<TriggerConfig> triggerConfigurations)

        Information about triggers to create when the deployment group is created.

        Parameters:
        triggerConfigurations - Information about triggers to create when the deployment group is created.
      • withTriggerConfigurations

        public CreateDeploymentGroupRequest withTriggerConfigurations​(Collection<TriggerConfig> triggerConfigurations)

        Information about triggers to create when the deployment group is created.

        Parameters:
        triggerConfigurations - Information about triggers to create when the deployment group is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object