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	awscc.appconfig.deployments

Fields

get (all properties)

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.
state	string	The state of the deployment.
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.

list (identifiers only)

Name	Datatype	Description
environment_id	string	The environment ID.
deployment_number	string	The sequence number of the deployment.
application_id	string	The application ID.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	deployments	INSERT	ApplicationId, ConfigurationProfileId, DeploymentStrategyId, EnvironmentId, ConfigurationVersion, region
delete_resource	deployments	DELETE	Identifier, region
list_resources	deployments_list_only	SELECT	region
get_resource	deployments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual deployment.

SELECT
  region,
  deployment_strategy_id,
  configuration_profile_id,
  environment_id,
  kms_key_identifier,
  description,
  configuration_version,
  state,
  deployment_number,
  application_id,
  dynamic_extension_parameters,
  tags
FROM awscc.appconfig.deployments
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ environment_id }}|{{ deployment_number }}';

list (identifiers only)

Lists all deployments in a region.

SELECT
  region,
  application_id,
  environment_id,
  deployment_number
FROM awscc.appconfig.deployments_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.appconfig.deployments (
  DeploymentStrategyId,
  ConfigurationProfileId,
  EnvironmentId,
  ConfigurationVersion,
  ApplicationId,
  region
)
SELECT
  '{{ deployment_strategy_id }}',
  '{{ configuration_profile_id }}',
  '{{ environment_id }}',
  '{{ configuration_version }}',
  '{{ application_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appconfig.deployments (
  DeploymentStrategyId,
  ConfigurationProfileId,
  EnvironmentId,
  KmsKeyIdentifier,
  Description,
  ConfigurationVersion,
  ApplicationId,
  DynamicExtensionParameters,
  Tags,
  region
)
SELECT
  '{{ deployment_strategy_id }}',
  '{{ configuration_profile_id }}',
  '{{ environment_id }}',
  '{{ kms_key_identifier }}',
  '{{ description }}',
  '{{ configuration_version }}',
  '{{ application_id }}',
  '{{ dynamic_extension_parameters }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: deployment
  props:
    - name: deployment_strategy_id
      value: '{{ deployment_strategy_id }}'
    - name: configuration_profile_id
      value: '{{ configuration_profile_id }}'
    - name: environment_id
      value: '{{ environment_id }}'
    - name: kms_key_identifier
      value: '{{ kms_key_identifier }}'
    - name: description
      value: '{{ description }}'
    - name: configuration_version
      value: '{{ configuration_version }}'
    - name: application_id
      value: '{{ application_id }}'
    - name: dynamic_extension_parameters
      value:
        - parameter_value: '{{ parameter_value }}'
          extension_reference: '{{ extension_reference }}'
          parameter_name: '{{ parameter_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.appconfig.deployments
WHERE
  Identifier = '{{ application_id }}|{{ environment_id }}|{{ deployment_number }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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