You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeDeploy::Types::UpdateDeploymentGroupInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb

Overview

Note:

When making an API call, you may pass UpdateDeploymentGroupInput data as a hash:

{
  application_name: "ApplicationName", # required
  current_deployment_group_name: "DeploymentGroupName", # required
  new_deployment_group_name: "DeploymentGroupName",
  deployment_config_name: "DeploymentConfigName",
  ec2_tag_filters: [
    {
      key: "Key",
      value: "Value",
      type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
    },
  ],
  on_premises_instance_tag_filters: [
    {
      key: "Key",
      value: "Value",
      type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
    },
  ],
  auto_scaling_groups: ["AutoScalingGroupName"],
  service_role_arn: "Role",
  trigger_configurations: [
    {
      trigger_name: "TriggerName",
      trigger_target_arn: "TriggerTargetArn",
      trigger_events: ["DeploymentStart"], # accepts DeploymentStart, DeploymentSuccess, DeploymentFailure, DeploymentStop, DeploymentRollback, DeploymentReady, InstanceStart, InstanceSuccess, InstanceFailure, InstanceReady
    },
  ],
  alarm_configuration: {
    enabled: false,
    ignore_poll_alarm_failure: false,
    alarms: [
      {
        name: "AlarmName",
      },
    ],
  },
  auto_rollback_configuration: {
    enabled: false,
    events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
  },
  deployment_style: {
    deployment_type: "IN_PLACE", # accepts IN_PLACE, BLUE_GREEN
    deployment_option: "WITH_TRAFFIC_CONTROL", # accepts WITH_TRAFFIC_CONTROL, WITHOUT_TRAFFIC_CONTROL
  },
  blue_green_deployment_configuration: {
    terminate_blue_instances_on_deployment_success: {
      action: "TERMINATE", # accepts TERMINATE, KEEP_ALIVE
      termination_wait_time_in_minutes: 1,
    },
    deployment_ready_option: {
      action_on_timeout: "CONTINUE_DEPLOYMENT", # accepts CONTINUE_DEPLOYMENT, STOP_DEPLOYMENT
      wait_time_in_minutes: 1,
    },
    green_fleet_provisioning_option: {
      action: "DISCOVER_EXISTING", # accepts DISCOVER_EXISTING, COPY_AUTO_SCALING_GROUP
    },
  },
  load_balancer_info: {
    elb_info_list: [
      {
        name: "ELBName",
      },
    ],
    target_group_info_list: [
      {
        name: "TargetGroupName",
      },
    ],
  },
  ec2_tag_set: {
    ec2_tag_set_list: [
      [
        {
          key: "Key",
          value: "Value",
          type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
        },
      ],
    ],
  },
  on_premises_tag_set: {
    on_premises_tag_set_list: [
      [
        {
          key: "Key",
          value: "Value",
          type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
        },
      ],
    ],
  },
}

Represents the input of an UpdateDeploymentGroup operation.

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configurationTypes::AlarmConfiguration

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



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#application_nameString

The application name corresponding to the deployment group to update.

Returns:

  • (String)


3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#auto_rollback_configurationTypes::AutoRollbackConfiguration

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



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#auto_scaling_groupsArray<String>

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.

Returns:

  • (Array<String>)


3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#blue_green_deployment_configurationTypes::BlueGreenDeploymentConfiguration

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



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#current_deployment_group_nameString

The current name of the deployment group.

Returns:

  • (String)


3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#deployment_config_nameString

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

Returns:

  • (String)


3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#deployment_styleTypes::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.



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#ec2_tag_filtersArray<Types::EC2TagFilter>

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

Returns:



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#ec2_tag_setTypes::EC2TagSet

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

Returns:



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#load_balancer_infoTypes::LoadBalancerInfo

Information about the load balancer used in a deployment.



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#new_deployment_group_nameString

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

Returns:

  • (String)


3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#on_premises_instance_tag_filtersArray<Types::TagFilter>

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

Returns:



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#on_premises_tag_setTypes::OnPremisesTagSet

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



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#service_role_arnString

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

Returns:

  • (String)


3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end

#trigger_configurationsArray<Types::TriggerConfig>

Information about triggers to change when the deployment group is updated. For examples, see Modify Triggers in an AWS CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.

Returns:



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3743

class UpdateDeploymentGroupInput < Struct.new(
  :application_name,
  :current_deployment_group_name,
  :new_deployment_group_name,
  :deployment_config_name,
  :ec2_tag_filters,
  :on_premises_instance_tag_filters,
  :auto_scaling_groups,
  :service_role_arn,
  :trigger_configurations,
  :alarm_configuration,
  :auto_rollback_configuration,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :on_premises_tag_set)
  include Aws::Structure
end