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

Inherits:

Struct

Object
Struct
Aws::CodeDeploy::Types::UpdateDeploymentGroupInput

show all

Includes:: Structure

Defined in:: 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",
      },
    ],
    target_group_pair_info_list: [
      {
        target_groups: [
          {
            name: "TargetGroupName",
          },
        ],
        prod_traffic_route: {
          listener_arns: ["ListenerArn"],
        },
        test_traffic_route: {
          listener_arns: ["ListenerArn"],
        },
      },
    ],
  },
  ec2_tag_set: {
    ec2_tag_set_list: [
      [
        {
          key: "Key",
          value: "Value",
          type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
        },
      ],
    ],
  },
  ecs_services: [
    {
      service_name: "ECSServiceName",
      cluster_name: "ECSClusterName",
    },
  ],
  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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#alarm_configuration ⇒ Types::AlarmConfiguration

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

The application name that corresponds to the deployment group to update.
#auto_rollback_configuration ⇒ Types::AutoRollbackConfiguration

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
#auto_scaling_groups ⇒ Array<String>

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
#blue_green_deployment_configuration ⇒ Types::BlueGreenDeploymentConfiguration

Information about blue/green deployment options for a deployment group.
#current_deployment_group_name ⇒ String

The current name of the deployment group.
#deployment_config_name ⇒ String

The replacement deployment configuration name to use, if you want to change it.
#deployment_style ⇒ Types::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.
#ec2_tag_filters ⇒ Array<Types::EC2TagFilter>

The replacement set of Amazon EC2 tags on which to filter, if you want to change them.
#ec2_tag_set ⇒ Types::EC2TagSet

Information about groups of tags applied to on-premises instances.
#ecs_services ⇒ Array<Types::ECSService>

The target Amazon ECS services in the deployment group.
#load_balancer_info ⇒ Types::LoadBalancerInfo

Information about the load balancer used in a deployment.
#new_deployment_group_name ⇒ String

The new name of the deployment group, if you want to change it.
#on_premises_instance_tag_filters ⇒ Array<Types::TagFilter>

The replacement set of on-premises instance tags on which to filter, if you want to change them.
#on_premises_tag_set ⇒ Types::OnPremisesTagSet

Information about an on-premises instance tag set.
#service_role_arn ⇒ String

A replacement ARN for the service role, if you want to change it.
#trigger_configurations ⇒ Array<Types::TriggerConfig>

Information about triggers to change when the deployment group is updated.

Instance Attribute Details

#alarm_configuration ⇒ `Types::AlarmConfiguration`

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

Returns:

(Types::AlarmConfiguration)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#application_name ⇒ `String`

The application name that corresponds to the deployment group to update.

Returns:

(String)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#auto_rollback_configuration ⇒ `Types::AutoRollbackConfiguration`

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

Returns:

(Types::AutoRollbackConfiguration)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#auto_scaling_groups ⇒ `Array<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>)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#blue_green_deployment_configuration ⇒ `Types::BlueGreenDeploymentConfiguration`

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

Returns:

(Types::BlueGreenDeploymentConfiguration)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#current_deployment_group_name ⇒ `String`

The current name of the deployment group.

Returns:

(String)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_config_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_style ⇒ `Types::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:

(Types::DeploymentStyle)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_tag_filters ⇒ `Array<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:

(Array<Types::EC2TagFilter>)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_tag_set ⇒ `Types::EC2TagSet`

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

Returns:

(Types::EC2TagSet)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#ecs_services ⇒ `Array<Types::ECSService>`

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:

(Array<Types::ECSService>)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancer_info ⇒ `Types::LoadBalancerInfo`

Information about the load balancer used in a deployment.

Returns:

(Types::LoadBalancerInfo)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#new_deployment_group_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#on_premises_instance_tag_filters ⇒ `Array<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:

(Array<Types::TagFilter>)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#on_premises_tag_set ⇒ `Types::OnPremisesTagSet`

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

Returns:

(Types::OnPremisesTagSet)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#service_role_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_configurations ⇒ `Array<Types::TriggerConfig>`

Information about triggers to change when the deployment group is updated. For examples, see [Edit a Trigger in a CodeDeploy Deployment Group] in the *AWS CodeDeploy User Guide*.

[1]: docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html

Returns:

(Array<Types::TriggerConfig>)

# File 'lib/aws-sdk-codedeploy/types.rb', line 5986

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,
  :ecs_services,
  :on_premises_tag_set)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configuration ⇒ Types::AlarmConfiguration

#application_name ⇒ String

#auto_rollback_configuration ⇒ Types::AutoRollbackConfiguration

#auto_scaling_groups ⇒ Array<String>

#blue_green_deployment_configuration ⇒ Types::BlueGreenDeploymentConfiguration

#current_deployment_group_name ⇒ String

#deployment_config_name ⇒ String

#deployment_style ⇒ Types::DeploymentStyle

#ec2_tag_filters ⇒ Array<Types::EC2TagFilter>

#ec2_tag_set ⇒ Types::EC2TagSet

#ecs_services ⇒ Array<Types::ECSService>

#load_balancer_info ⇒ Types::LoadBalancerInfo

#new_deployment_group_name ⇒ String

#on_premises_instance_tag_filters ⇒ Array<Types::TagFilter>

#on_premises_tag_set ⇒ Types::OnPremisesTagSet

#service_role_arn ⇒ String

#trigger_configurations ⇒ Array<Types::TriggerConfig>

#alarm_configuration ⇒ `Types::AlarmConfiguration`

#application_name ⇒ `String`

#auto_rollback_configuration ⇒ `Types::AutoRollbackConfiguration`

#auto_scaling_groups ⇒ `Array<String>`

#blue_green_deployment_configuration ⇒ `Types::BlueGreenDeploymentConfiguration`

#current_deployment_group_name ⇒ `String`

#deployment_config_name ⇒ `String`

#deployment_style ⇒ `Types::DeploymentStyle`

#ec2_tag_filters ⇒ `Array<Types::EC2TagFilter>`

#ec2_tag_set ⇒ `Types::EC2TagSet`

#ecs_services ⇒ `Array<Types::ECSService>`

#load_balancer_info ⇒ `Types::LoadBalancerInfo`

#new_deployment_group_name ⇒ `String`

#on_premises_instance_tag_filters ⇒ `Array<Types::TagFilter>`

#on_premises_tag_set ⇒ `Types::OnPremisesTagSet`

#service_role_arn ⇒ `String`

#trigger_configurations ⇒ `Array<Types::TriggerConfig>`