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

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.
#outdated_instances_strategy ⇒ String

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
#service_role_arn ⇒ String

A replacement ARN for the service role, if you want to change it.
#termination_hook_enabled ⇒ Boolean

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling.
#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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 or do not specify this parameter.
To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see [Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error “Heartbeat Timeout”] in the *CodeDeploy User Guide*.

[1]: docs.aws.amazon.com/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat

Returns:

(Array<String>)

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

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 Amazon EC2 instances identified by all the tag groups.

Returns:

(Types::EC2TagSet)

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

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#outdated_instances_strategy ⇒ `String`

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:

(String)

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

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#termination_hook_enabled ⇒ `Boolean`

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 update 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][3: topic in the *Amazon EC2 Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html [2]: docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable [3]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in

Returns:

(Boolean)

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

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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 *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 5134

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,
  :outdated_instances_strategy,
  :deployment_style,
  :blue_green_deployment_configuration,
  :load_balancer_info,
  :ec2_tag_set,
  :ecs_services,
  :on_premises_tag_set,
  :termination_hook_enabled)
  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

#outdated_instances_strategy ⇒ String

#service_role_arn ⇒ String

#termination_hook_enabled ⇒ Boolean

#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`

#outdated_instances_strategy ⇒ `String`

#service_role_arn ⇒ `String`

#termination_hook_enabled ⇒ `Boolean`

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