deployment_configs

Creates, updates, deletes or gets a deployment_config resource or lists deployment_configs in a region

Overview

Name	deployment_configs
Type	Resource
Description	Resource Type definition for AWS::CodeDeploy::DeploymentConfig
Id	aws.codedeploy.deployment_configs

Fields

Name	Datatype	Description
compute_platform	string	The destination platform type for the deployment (Lambda, Server, or ECS).
deployment_config_name	string	A name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.
minimum_healthy_hosts	object	The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
zonal_config	object	The zonal deployment config that specifies how the zonal deployment behaves
traffic_routing_config	object	The configuration that specifies how the deployment traffic is routed.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all deployment_configs in a region.

SELECT
region,
compute_platform,
deployment_config_name,
minimum_healthy_hosts,
zonal_config,
traffic_routing_config
FROM aws.codedeploy.deployment_configs
WHERE region = 'us-east-1';

Gets all properties from an individual deployment_config.

SELECT
region,
compute_platform,
deployment_config_name,
minimum_healthy_hosts,
zonal_config,
traffic_routing_config
FROM aws.codedeploy.deployment_configs
WHERE region = 'us-east-1' AND data__Identifier = '<DeploymentConfigName>';

INSERT example

Use the following StackQL query and manifest file to create a new deployment_config resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.codedeploy.deployment_configs (
 ComputePlatform,
 DeploymentConfigName,
 MinimumHealthyHosts,
 ZonalConfig,
 TrafficRoutingConfig,
 region
)
SELECT 
'{{ ComputePlatform }}',
 '{{ DeploymentConfigName }}',
 '{{ MinimumHealthyHosts }}',
 '{{ ZonalConfig }}',
 '{{ TrafficRoutingConfig }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.codedeploy.deployment_configs (
 ComputePlatform,
 DeploymentConfigName,
 MinimumHealthyHosts,
 ZonalConfig,
 TrafficRoutingConfig,
 region
)
SELECT 
 '{{ ComputePlatform }}',
 '{{ DeploymentConfigName }}',
 '{{ MinimumHealthyHosts }}',
 '{{ ZonalConfig }}',
 '{{ TrafficRoutingConfig }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: deployment_config
    props:
      - name: ComputePlatform
        value: '{{ ComputePlatform }}'
      - name: DeploymentConfigName
        value: '{{ DeploymentConfigName }}'
      - name: MinimumHealthyHosts
        value:
          Value: '{{ Value }}'
          Type: '{{ Type }}'
      - name: ZonalConfig
        value:
          FirstZoneMonitorDurationInSeconds: '{{ FirstZoneMonitorDurationInSeconds }}'
          MonitorDurationInSeconds: '{{ MonitorDurationInSeconds }}'
          MinimumHealthyHostsPerZone:
            Value: '{{ Value }}'
            Type: '{{ Type }}'
      - name: TrafficRoutingConfig
        value:
          Type: '{{ Type }}'
          TimeBasedLinear:
            LinearInterval: '{{ LinearInterval }}'
            LinearPercentage: '{{ LinearPercentage }}'
          TimeBasedCanary:
            CanaryPercentage: '{{ CanaryPercentage }}'
            CanaryInterval: '{{ CanaryInterval }}'

DELETE example

/*+ delete */
DELETE FROM aws.codedeploy.deployment_configs
WHERE data__Identifier = '<DeploymentConfigName>'
AND region = 'us-east-1';

Permissions

To operate on the deployment_configs resource, the following permissions are required:

Create

codedeploy:CreateDeploymentConfig

Read

codedeploy:GetDeploymentConfig

Delete

codedeploy:GetDeploymentConfig,
codedeploy:DeleteDeploymentConfig

List

codedeploy:ListDeploymentConfigs