Skip to content

aws.codedeploy.get_deployment_config

Example SQL Queries

SELECT * FROM
aws.codedeploy.get_deployment_config
WHERE
"deployment_config_name" = 'VALUE';

Description

Gets information about a deployment configuration.

Table Definition

Column NameColumn Data Type
deployment_config_name Required Input Column

The name of a deployment configuration associated with the user or Amazon Web Services account.

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_config_info

Information about the deployment configuration.

STRUCT(
"deployment_config_id" VARCHAR,
"deployment_config_name" VARCHAR,
"minimum_healthy_hosts" STRUCT(
"type" VARCHAR,
"value" BIGINT
),
"create_time" TIMESTAMP_S,
"compute_platform" VARCHAR,
"traffic_routing_config" STRUCT(
"type" VARCHAR,
"time_based_canary" STRUCT(
"canary_percentage" BIGINT,
"canary_interval" BIGINT
),
"time_based_linear" STRUCT(
"linear_percentage" BIGINT,
"linear_interval" BIGINT
)
),
"zonal_config" STRUCT(
"first_zone_monitor_duration_in_seconds" BIGINT,
"monitor_duration_in_seconds" BIGINT,
"minimum_healthy_hosts_per_zone" STRUCT(
"type" VARCHAR,
"value" BIGINT
)
)
)
Show child fields
deployment_config_info.compute_platform

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

deployment_config_info.create_time

The time at which the deployment configuration was created.

deployment_config_info.deployment_config_id

The deployment configuration ID.

deployment_config_info.deployment_config_name

The deployment configuration name.

deployment_config_info.minimum_healthy_hosts

Information about the number or percentage of minimum healthy instances.

Show child fields
deployment_config_info.minimum_healthy_hosts.type

The minimum healthy instance type:

  • HOST_COUNT: The minimum number of healthy instances as an absolute value.

  • FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.

In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.

In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.

For more information, see CodeDeploy Instance Health in the CodeDeploy User Guide.

deployment_config_info.minimum_healthy_hosts.value

The minimum healthy instance value.

deployment_config_info.traffic_routing_config

The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.

Show child fields
deployment_config_info.traffic_routing_config.time_based_canary

A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.

Show child fields
deployment_config_info.traffic_routing_config.time_based_canary.canary_interval

The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.

deployment_config_info.traffic_routing_config.time_based_canary.canary_percentage

The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.

deployment_config_info.traffic_routing_config.time_based_linear

A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file.

Show child fields
deployment_config_info.traffic_routing_config.time_based_linear.linear_interval

The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.

deployment_config_info.traffic_routing_config.time_based_linear.linear_percentage

The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.

deployment_config_info.traffic_routing_config.type

The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.

deployment_config_info.zonal_config

Information about a zonal configuration.

Show child fields
deployment_config_info.zonal_config.first_zone_monitor_duration_in_seconds

The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the second Availability Zone. You might set this option if you want to allow extra bake time for the first Availability Zone. If you don't specify a value for firstZoneMonitorDurationInSeconds, then CodeDeploy uses the monitorDurationInSeconds value for the first Availability Zone.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

deployment_config_info.zonal_config.minimum_healthy_hosts_per_zone

The number or percentage of instances that must remain available per Availability Zone during a deployment. This option works in conjunction with the MinimumHealthyHosts option. For more information, see About the minimum number of healthy hosts per Availability Zone in the CodeDeploy User Guide.

If you don't specify the minimumHealthyHostsPerZone option, then CodeDeploy uses a default value of 0 percent.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

Show child fields
deployment_config_info.zonal_config.minimum_healthy_hosts_per_zone.type

The type associated with the MinimumHealthyHostsPerZone option.

deployment_config_info.zonal_config.minimum_healthy_hosts_per_zone.value

The value associated with the MinimumHealthyHostsPerZone option.

deployment_config_info.zonal_config.monitor_duration_in_seconds

The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the next Availability Zone. Consider adding a monitor duration to give the deployment some time to prove itself (or 'bake') in one Availability Zone before it is released in the next zone. If you don't specify a monitorDurationInSeconds, CodeDeploy starts deploying to the next Availability Zone immediately.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.