Skip to content

aws.codedeploy.get_deployment_group

Example SQL Queries

SELECT * FROM
aws.codedeploy.get_deployment_group
WHERE
"application_name" = 'VALUE'
AND "deployment_group_name" = 'VALUE';

Description

Gets information about a deployment group.

Table Definition

Column NameColumn Data Type
application_name Required Input Column

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

VARCHAR
deployment_group_name Required Input Column

The name of a deployment group for the specified application.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
deployment_group_info

Information about the deployment group.

STRUCT(
"application_name" VARCHAR,
"deployment_group_id" VARCHAR,
"deployment_group_name" VARCHAR,
"deployment_config_name" VARCHAR,
"ec2_tag_filters" STRUCT(
"key" VARCHAR,
"value" VARCHAR,
"type" VARCHAR
)[],
"on_premises_instance_tag_filters" STRUCT(
"key" VARCHAR,
"value" VARCHAR,
"type" VARCHAR
)[],
"auto_scaling_groups" STRUCT(
"name" VARCHAR,
"hook" VARCHAR,
"termination_hook" VARCHAR
)[],
"service_role_arn" VARCHAR,
"target_revision" STRUCT(
"revision_type" VARCHAR,
"s3_location" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR,
"bundle_type" VARCHAR,
"version" VARCHAR,
"e_tag" VARCHAR
),
"git_hub_location" STRUCT(
"repository" VARCHAR,
"commit_id" VARCHAR
),
"string" STRUCT(
"content" VARCHAR,
"sha256" VARCHAR
),
"app_spec_content" STRUCT(
"content" VARCHAR,
"sha256" VARCHAR
)
),
"trigger_configurations" STRUCT(
"trigger_name" VARCHAR,
"trigger_target_arn" VARCHAR,
"trigger_events" VARCHAR[]
)[],
"alarm_configuration" STRUCT(
"enabled" BOOLEAN,
"ignore_poll_alarm_failure" BOOLEAN,
"alarms" STRUCT(
"name" VARCHAR
)[]
),
"auto_rollback_configuration" STRUCT(
"enabled" BOOLEAN,
"events" VARCHAR[]
),
"deployment_style" STRUCT(
"deployment_type" VARCHAR,
"deployment_option" VARCHAR
),
"outdated_instances_strategy" VARCHAR,
"blue_green_deployment_configuration" STRUCT(
"terminate_blue_instances_on_deployment_success" STRUCT(
"action" VARCHAR,
"termination_wait_time_in_minutes" BIGINT
),
"deployment_ready_option" STRUCT(
"action_on_timeout" VARCHAR,
"wait_time_in_minutes" BIGINT
),
"green_fleet_provisioning_option" STRUCT(
"action" VARCHAR
)
),
"load_balancer_info" STRUCT(
"elb_info_list" STRUCT(
"name" VARCHAR
)[],
"target_group_info_list" STRUCT(
"name" VARCHAR
)[],
"target_group_pair_info_list" STRUCT(
"target_groups" STRUCT(
"name" VARCHAR
)[],
"prod_traffic_route" STRUCT(
"listener_arns" VARCHAR[]
),
"test_traffic_route" STRUCT(
"listener_arns" VARCHAR[]
)
)[]
),
"last_successful_deployment" STRUCT(
"deployment_id" VARCHAR,
"status" VARCHAR,
"end_time" TIMESTAMP_S,
"create_time" TIMESTAMP_S
),
"last_attempted_deployment" STRUCT(
"deployment_id" VARCHAR,
"status" VARCHAR,
"end_time" TIMESTAMP_S,
"create_time" TIMESTAMP_S
),
"ec2_tag_set" STRUCT(
"ec2_tag_set_list" STRUCT(
"key" VARCHAR,
"value" VARCHAR,
"type" VARCHAR
)[][]
),
"on_premises_tag_set" STRUCT(
"on_premises_tag_set_list" STRUCT(
"key" VARCHAR,
"value" VARCHAR,
"type" VARCHAR
)[][]
),
"compute_platform" VARCHAR,
"ecs_services" STRUCT(
"service_name" VARCHAR,
"cluster_name" VARCHAR
)[],
"termination_hook_enabled" BOOLEAN
)
Show child fields
deployment_group_info.alarm_configuration

A list of alarms associated with the deployment group.

Show child fields
deployment_group_info.alarm_configuration.alarms[]
Show child fields
deployment_group_info.alarm_configuration.alarms[].name

The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

deployment_group_info.alarm_configuration.enabled

Indicates whether the alarm configuration is enabled.

deployment_group_info.alarm_configuration.ignore_poll_alarm_failure

Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

  • true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.

  • false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.

deployment_group_info.application_name

The application name.

deployment_group_info.auto_rollback_configuration

Information about the automatic rollback configuration associated with the deployment group.

Show child fields
deployment_group_info.auto_rollback_configuration.enabled

Indicates whether a defined automatic rollback configuration is currently enabled.

deployment_group_info.auto_rollback_configuration.events[]
deployment_group_info.auto_scaling_groups[]
Show child fields
deployment_group_info.auto_scaling_groups[].hook

The name of the launch hook that CodeDeploy installed into the Auto Scaling group.

For more information about the launch hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.

deployment_group_info.auto_scaling_groups[].name

The Auto Scaling group name.

deployment_group_info.auto_scaling_groups[].termination_hook

The name of the termination hook that CodeDeploy installed into the Auto Scaling group.

For more information about the termination hook, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

deployment_group_info.blue_green_deployment_configuration

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

Show child fields
deployment_group_info.blue_green_deployment_configuration.deployment_ready_option

Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

Show child fields
deployment_group_info.blue_green_deployment_configuration.deployment_ready_option.action_on_timeout

Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

  • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

  • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

deployment_group_info.blue_green_deployment_configuration.deployment_ready_option.wait_time_in_minutes

The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout.

deployment_group_info.blue_green_deployment_configuration.green_fleet_provisioning_option

Information about how instances are provisioned for a replacement environment in a blue/green deployment.

Show child fields
deployment_group_info.blue_green_deployment_configuration.green_fleet_provisioning_option.action

The method used to add instances to a replacement environment.

  • DISCOVER_EXISTING: Use instances that already exist or will be created manually.

  • COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.

deployment_group_info.blue_green_deployment_configuration.terminate_blue_instances_on_deployment_success

Information about whether to terminate instances in the original fleet during a blue/green deployment.

Show child fields
deployment_group_info.blue_green_deployment_configuration.terminate_blue_instances_on_deployment_success.action

The action to take on instances in the original environment after a successful blue/green deployment.

  • TERMINATE: Instances are terminated after a specified wait time.

  • KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

deployment_group_info.blue_green_deployment_configuration.terminate_blue_instances_on_deployment_success.termination_wait_time_in_minutes

For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set.

The maximum setting is 2880 minutes (2 days).

deployment_group_info.compute_platform

The destination platform type for the deployment (Lambda, Server, or ECS).

deployment_group_info.deployment_config_name

The deployment configuration name.

deployment_group_info.deployment_group_id

The deployment group ID.

deployment_group_info.deployment_group_name

The deployment group name.

deployment_group_info.deployment_style

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.

Show child fields
deployment_group_info.deployment_style.deployment_option

Indicates whether to route deployment traffic behind a load balancer.

deployment_group_info.deployment_style.deployment_type

Indicates whether to run an in-place deployment or a blue/green deployment.

deployment_group_info.ec2_tag_filters[]
Show child fields
deployment_group_info.ec2_tag_filters[].key

The tag filter key.

deployment_group_info.ec2_tag_filters[].type

The tag filter type:

  • KEY_ONLY: Key only.

  • VALUE_ONLY: Value only.

  • KEY_AND_VALUE: Key and value.

deployment_group_info.ec2_tag_filters[].value

The tag filter value.

deployment_group_info.ec2_tag_set

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

Show child fields
deployment_group_info.ec2_tag_set.ec2_tag_set_list[][]
Show child fields
deployment_group_info.ec2_tag_set.ec2_tag_set_list[][].key

The tag filter key.

deployment_group_info.ec2_tag_set.ec2_tag_set_list[][].type

The tag filter type:

  • KEY_ONLY: Key only.

  • VALUE_ONLY: Value only.

  • KEY_AND_VALUE: Key and value.

deployment_group_info.ec2_tag_set.ec2_tag_set_list[][].value

The tag filter value.

deployment_group_info.ecs_services[]
Show child fields
deployment_group_info.ecs_services[].cluster_name

The name of the cluster that the Amazon ECS service is associated with.

deployment_group_info.ecs_services[].service_name

The name of the target Amazon ECS service.

deployment_group_info.last_attempted_deployment

Information about the most recent attempted deployment to the deployment group.

Show child fields
deployment_group_info.last_attempted_deployment.create_time

A timestamp that indicates when the most recent deployment to the deployment group started.

deployment_group_info.last_attempted_deployment.deployment_id

The unique ID of a deployment.

deployment_group_info.last_attempted_deployment.end_time

A timestamp that indicates when the most recent deployment to the deployment group was complete.

deployment_group_info.last_attempted_deployment.status

The status of the most recent deployment.

deployment_group_info.last_successful_deployment

Information about the most recent successful deployment to the deployment group.

Show child fields
deployment_group_info.last_successful_deployment.create_time

A timestamp that indicates when the most recent deployment to the deployment group started.

deployment_group_info.last_successful_deployment.deployment_id

The unique ID of a deployment.

deployment_group_info.last_successful_deployment.end_time

A timestamp that indicates when the most recent deployment to the deployment group was complete.

deployment_group_info.last_successful_deployment.status

The status of the most recent deployment.

deployment_group_info.load_balancer_info

Information about the load balancer to use in a deployment.

Show child fields
deployment_group_info.load_balancer_info.elb_info_list[]
Show child fields
deployment_group_info.load_balancer_info.elb_info_list[].name

For blue/green deployments, the name of the Classic Load Balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the Classic Load Balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

deployment_group_info.load_balancer_info.target_group_info_list[]
Show child fields
deployment_group_info.load_balancer_info.target_group_info_list[].name

For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

deployment_group_info.load_balancer_info.target_group_pair_info_list[]
Show child fields
deployment_group_info.load_balancer_info.target_group_pair_info_list[].prod_traffic_route

The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.

Show child fields
deployment_group_info.load_balancer_info.target_group_pair_info_list[].prod_traffic_route.listener_arns[]
deployment_group_info.load_balancer_info.target_group_pair_info_list[].target_groups[]
Show child fields
deployment_group_info.load_balancer_info.target_group_pair_info_list[].target_groups[].name

For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

deployment_group_info.load_balancer_info.target_group_pair_info_list[].test_traffic_route

An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment.

Show child fields
deployment_group_info.load_balancer_info.target_group_pair_info_list[].test_traffic_route.listener_arns[]
deployment_group_info.on_premises_instance_tag_filters[]
Show child fields
deployment_group_info.on_premises_instance_tag_filters[].key

The on-premises instance tag filter key.

deployment_group_info.on_premises_instance_tag_filters[].type

The on-premises instance tag filter type:

  • KEY_ONLY: Key only.

  • VALUE_ONLY: Value only.

  • KEY_AND_VALUE: Key and value.

deployment_group_info.on_premises_instance_tag_filters[].value

The on-premises instance tag filter value.

deployment_group_info.on_premises_tag_set

Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

Show child fields
deployment_group_info.on_premises_tag_set.on_premises_tag_set_list[][]
Show child fields
deployment_group_info.on_premises_tag_set.on_premises_tag_set_list[][].key

The on-premises instance tag filter key.

deployment_group_info.on_premises_tag_set.on_premises_tag_set_list[][].type

The on-premises instance tag filter type:

  • KEY_ONLY: Key only.

  • VALUE_ONLY: Value only.

  • KEY_AND_VALUE: Key and value.

deployment_group_info.on_premises_tag_set.on_premises_tag_set_list[][].value

The on-premises instance tag filter value.

deployment_group_info.outdated_instances_strategy

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.

deployment_group_info.service_role_arn

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the CodeDeploy User Guide.

deployment_group_info.target_revision

Information about the deployment group's target revision, including type and location.

Show child fields
deployment_group_info.target_revision.app_spec_content

The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.

Show child fields
deployment_group_info.target_revision.app_spec_content.content

The YAML-formatted or JSON-formatted revision string.

For an Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version.

For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more.

For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment.

deployment_group_info.target_revision.app_spec_content.sha256

The SHA256 hash value of the revision content.

deployment_group_info.target_revision.git_hub_location

Information about the location of application artifacts stored in GitHub.

Show child fields
deployment_group_info.target_revision.git_hub_location.commit_id

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

deployment_group_info.target_revision.git_hub_location.repository

The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.

Specified as account/repository.

deployment_group_info.target_revision.revision_type

The type of application revision:

  • S3: An application revision stored in Amazon S3.

  • GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).

  • String: A YAML-formatted or JSON-formatted string (Lambda deployments only).

  • AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.

deployment_group_info.target_revision.s3_location

Information about the location of a revision stored in Amazon S3.

Show child fields
deployment_group_info.target_revision.s3_location.bucket

The name of the Amazon S3 bucket where the application revision is stored.

deployment_group_info.target_revision.s3_location.bundle_type

The file type of the application revision. Must be one of the following:

  • tar: A tar archive file.

  • tgz: A compressed tar archive file.

  • zip: A zip archive file.

  • YAML: A YAML-formatted file.

  • JSON: A JSON-formatted file.

deployment_group_info.target_revision.s3_location.e_tag

The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the ETag is not specified as an input parameter, ETag validation of the object is skipped.

deployment_group_info.target_revision.s3_location.key

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

deployment_group_info.target_revision.s3_location.version

A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the version is not specified, the system uses the most recent version by default.

deployment_group_info.target_revision.string

Information about the location of an Lambda deployment revision stored as a RawString.

Show child fields
deployment_group_info.target_revision.string.content

The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.

deployment_group_info.target_revision.string.sha256

The SHA256 hash value of the revision content.

deployment_group_info.termination_hook_enabled

Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.

deployment_group_info.trigger_configurations[]
Show child fields
deployment_group_info.trigger_configurations[].trigger_events[]
deployment_group_info.trigger_configurations[].trigger_name

The name of the notification trigger.

deployment_group_info.trigger_configurations[].trigger_target_arn

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.