deployments

Creates, updates, deletes or gets a deployment resource or lists deployments in a region

Overview

Name	deployments
Type	Resource
Description	Resource Type definition for AWS::AppConfig::Deployment
Id	aws.appconfig.deployments

Fields

Name	Datatype	Description
deployment_strategy_id	string	The deployment strategy ID.
configuration_profile_id	string	The configuration profile ID.
environment_id	string	The environment ID.
kms_key_identifier	string	The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
description	string	A description of the deployment.
configuration_version	string	The configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.
deployment_number	string	The sequence number of the deployment.
application_id	string	The application ID.
dynamic_extension_parameters	array
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::AppConfig::Deployment.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationId, ConfigurationProfileId, DeploymentStrategyId, EnvironmentId, ConfigurationVersion, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all deployments in a region.

SELECT
region,
deployment_strategy_id,
configuration_profile_id,
environment_id,
kms_key_identifier,
description,
configuration_version,
deployment_number,
application_id,
dynamic_extension_parameters,
tags
FROM aws.appconfig.deployments
WHERE region = 'us-east-1';

Gets all properties from an individual deployment.

SELECT
region,
deployment_strategy_id,
configuration_profile_id,
environment_id,
kms_key_identifier,
description,
configuration_version,
deployment_number,
application_id,
dynamic_extension_parameters,
tags
FROM aws.appconfig.deployments
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationId>|<EnvironmentId>|<DeploymentNumber>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.appconfig.deployments (
 DeploymentStrategyId,
 ConfigurationProfileId,
 EnvironmentId,
 ConfigurationVersion,
 ApplicationId,
 region
)
SELECT 
'{{ DeploymentStrategyId }}',
 '{{ ConfigurationProfileId }}',
 '{{ EnvironmentId }}',
 '{{ ConfigurationVersion }}',
 '{{ ApplicationId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appconfig.deployments (
 DeploymentStrategyId,
 ConfigurationProfileId,
 EnvironmentId,
 KmsKeyIdentifier,
 Description,
 ConfigurationVersion,
 ApplicationId,
 DynamicExtensionParameters,
 Tags,
 region
)
SELECT 
 '{{ DeploymentStrategyId }}',
 '{{ ConfigurationProfileId }}',
 '{{ EnvironmentId }}',
 '{{ KmsKeyIdentifier }}',
 '{{ Description }}',
 '{{ ConfigurationVersion }}',
 '{{ ApplicationId }}',
 '{{ DynamicExtensionParameters }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: deployment
    props:
      - name: DeploymentStrategyId
        value: '{{ DeploymentStrategyId }}'
      - name: ConfigurationProfileId
        value: '{{ ConfigurationProfileId }}'
      - name: EnvironmentId
        value: '{{ EnvironmentId }}'
      - name: KmsKeyIdentifier
        value: '{{ KmsKeyIdentifier }}'
      - name: Description
        value: '{{ Description }}'
      - name: ConfigurationVersion
        value: '{{ ConfigurationVersion }}'
      - name: ApplicationId
        value: '{{ ApplicationId }}'
      - name: DynamicExtensionParameters
        value:
          - ParameterValue: '{{ ParameterValue }}'
            ExtensionReference: '{{ ExtensionReference }}'
            ParameterName: '{{ ParameterName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.appconfig.deployments
WHERE data__Identifier = '<ApplicationId|EnvironmentId|DeploymentNumber>'
AND region = 'us-east-1';

Permissions

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

Read

appconfig:GetDeployment,
appconfig:ListTagsForResource

Create

appconfig:StartDeployment,
appconfig:GetDeployment,
appconfig:TagResource,
appconfig:ListTagsForResource,
kms:GenerateDataKey

List

appconfig:ListDeployments

Delete

appconfig:StopDeployment