extensions

Creates, updates, deletes or gets an extension resource or lists extensions in a region

Overview

Name	extensions
Type	Resource
Description	Resource Type definition for AWS::AppConfig::Extension
Id	awscc.appconfig.extensions

Fields

get (all properties)

Name	Datatype	Description
id	string
arn	string
version_number	integer
name	string	Name of the extension.
description	string	Description of the extension.
actions	object
parameters	object
latest_version_number	integer
▶tags	array	An array of key-value tags to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	extensions	INSERT	Name, Actions, region
delete_resource	extensions	DELETE	Identifier, region
update_resource	extensions	UPDATE	Identifier, PatchDocument, region
list_resources	extensions_list_only	SELECT	region
get_resource	extensions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual extension.

SELECT
  region,
  id,
  arn,
  version_number,
  name,
  description,
  actions,
  parameters,
  latest_version_number,
  tags
FROM awscc.appconfig.extensions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all extensions in a region.

SELECT
  region,
  id
FROM awscc.appconfig.extensions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.appconfig.extensions (
  Name,
  Actions,
  region
)
SELECT
  '{{ name }}',
  '{{ actions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appconfig.extensions (
  Name,
  Description,
  Actions,
  Parameters,
  LatestVersionNumber,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ actions }}',
  '{{ parameters }}',
  '{{ latest_version_number }}',
  '{{ 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: extension
  props:
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: actions
      value: {}
    - name: parameters
      value: {}
    - name: latest_version_number
      value: '{{ latest_version_number }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a extension resource, using stack-deploy.

/*+ update */
UPDATE awscc.appconfig.extensions
SET PatchDocument = string('{{ {
    "Description": description,
    "Actions": actions,
    "Parameters": parameters,
    "LatestVersionNumber": latest_version_number,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.appconfig.extensions
WHERE
  Identifier = '{{ id }}' 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 extensions resource, the following permissions are required:

Create

appconfig:CreateExtension,
appconfig:TagResource,
iam:PassRole

Read

appconfig:GetExtension,
appconfig:ListTagsForResource

Update

appconfig:UpdateExtension,
appconfig:TagResource,
appconfig:UntagResource

Delete

appconfig:DeleteExtension,
appconfig:UntagResource

List

appconfig:ListExtensions