Class: Aws::CodeDeploy::Types::CreateDeploymentGroupInput

Inherits:

Struct

Object
Struct
Aws::CodeDeploy::Types::CreateDeploymentGroupInput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-codedeploy/types.rb

Overview

Note:

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

{
  application_name: "ApplicationName", # required
  deployment_group_name: "DeploymentGroupName", # required
  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", # required
  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
        },
      ],
    ],
  },
  tags: [
    {
      key: "Key",
      value: "Value",
    },
  ],
}

Represents the input of a CreateDeploymentGroup operation.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#alarm_configuration ⇒ Types::AlarmConfiguration

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

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
#auto_rollback_configuration ⇒ Types::AutoRollbackConfiguration

Configuration information for an automatic rollback that is added when a deployment group is created.
#auto_scaling_groups ⇒ Array<String>

A list of associated Amazon EC2 Auto Scaling groups.
#blue_green_deployment_configuration ⇒ Types::BlueGreenDeploymentConfiguration

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

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

The name of a new deployment group for the specified application.
#deployment_style ⇒ Types::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.
#ec2_tag_filters ⇒ Array<Types::EC2TagFilter>

The Amazon EC2 tags on which to filter.
#ec2_tag_set ⇒ Types::EC2TagSet

Information about groups of tags applied to EC2 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.
#on_premises_instance_tag_filters ⇒ Array<Types::TagFilter>

The on-premises instance tags on which to filter.
#on_premises_tag_set ⇒ Types::OnPremisesTagSet

Information about groups of tags applied to on-premises instances.
#service_role_arn ⇒ String

A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user’s behalf when interacting with AWS services.
#tags ⇒ Array<Types::Tag>

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
#trigger_configurations ⇒ Array<Types::TriggerConfig>

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

Instance Attribute Details

#alarm_configuration ⇒ `Types::AlarmConfiguration`

Information to add about Amazon CloudWatch alarms when the deployment group is created.

Returns:

(Types::AlarmConfiguration)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#application_name ⇒ `String`

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

Returns:

(String)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#auto_rollback_configuration ⇒ `Types::AutoRollbackConfiguration`

Configuration information for an automatic rollback that is added when a deployment group is created.

Returns:

(Types::AutoRollbackConfiguration)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#auto_scaling_groups ⇒ `Array<String>`

A list of associated Amazon EC2 Auto Scaling groups.

Returns:

(Array<String>)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  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 1208

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_config_name ⇒ `String`

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 deployment group.

For more information about the predefined deployment configurations in AWS CodeDeploy, see [Working with Deployment Configurations in CodeDeploy] in the *AWS CodeDeploy User Guide*.

[1]: docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html

Returns:

(String)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_group_name ⇒ `String`

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

Returns:

(String)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

(Types::DeploymentStyle)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

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

Returns:

(Array<Types::EC2TagFilter>)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_tag_set ⇒ `Types::EC2TagSet`

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

Returns:

(Types::EC2TagSet)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  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 1208

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  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 1208

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

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:

(Array<Types::TagFilter>)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

(Types::OnPremisesTagSet)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#service_role_arn ⇒ `String`

A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user’s behalf when interacting with AWS services.

Returns:

(String)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

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:

(Array<Types::Tag>)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Information about triggers to create when the deployment group is created. For examples, see [Create a Trigger for an AWS CodeDeploy Event] in the *AWS CodeDeploy User Guide*.

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

Returns:

(Array<Types::TriggerConfig>)

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

class CreateDeploymentGroupInput < Struct.new(
  :application_name,
  :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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CodeDeploy::Types::CreateDeploymentGroupInput

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

#deployment_config_name ⇒ String

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

#on_premises_instance_tag_filters ⇒ Array<Types::TagFilter>

#on_premises_tag_set ⇒ Types::OnPremisesTagSet

#service_role_arn ⇒ String

#tags ⇒ Array<Types::Tag>

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

#deployment_config_name ⇒ `String`

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

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

#on_premises_tag_set ⇒ `Types::OnPremisesTagSet`

#service_role_arn ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

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