extensions

Creates, updates, deletes, gets or lists an extensions resource.

Overview

Name	extensions
Type	Resource
Id	aws.appconfig.extensions

Fields

The following fields are returned by SELECT queries:

get_extension

Name	Datatype	Description
actions	object	The actions defined in the extension.
arn	string	The system-generated Amazon Resource Name (ARN) for the extension. (pattern: <code>arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+</code>)
description	string	Information about the extension.
id	string	The system-generated ID of the extension. (pattern: <code>[a-z0-9]{4,7}</code>)
name	string	The extension name.
parameters	object	The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.
version_number	integer	The extension version number.

list_extensions

Name	Datatype	Description
arn	string	The system-generated Amazon Resource Name (ARN) for the extension. (pattern: <code>arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+</code>)
description	string	Information about the extension.
id	string	The system-generated ID of the extension. (pattern: <code>[a-z0-9]{4,7}</code>)
name	string	The extension name.
version_number	integer	The extension version number.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_extension	select	extension_identifier, region	version_number	Returns information about an AppConfig extension.
list_extensions	select	region	max_results, next_token, name	Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.
create_extension	insert	region	Latest-Version-Number	Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration. You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for the new extension version. For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the Uri field. For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri field. For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the Uri field. For more information about extensions, see Extending workflows in the AppConfig User Guide.
update_extension	update	extension_identifier, region		Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.
delete_extension	delete	extension_identifier, region	version	Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
extension_identifier	string	The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.
region	string	AWS region (default: us-east-1)
Latest-Version-Number	integer	You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.
max_results	integer	The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
name	string	The extension name.
next_token	string	A token to start the list. Use this token to get the next set of results.
version	integer	A specific version of an extension to delete. If omitted, the highest version is deleted.
version_number	integer	The extension version number. If no version number was defined, AppConfig uses the highest version.

SELECT examples

get_extension

Returns information about an AppConfig extension.

SELECT
actions,
arn,
description,
id,
name,
parameters,
version_number
FROM aws.appconfig.extensions
WHERE extension_identifier = '{{ extension_identifier }}' -- required
AND region = '{{ region }}' -- required
AND version_number = '{{ version_number }}'
;

list_extensions

Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.

SELECT
arn,
description,
id,
name,
version_number
FROM aws.appconfig.extensions
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
AND name = '{{ name }}'
;

INSERT examples

create_extension

Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration. You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for the new extension version. For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the Uri field. For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri field. For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the Uri field. For more information about extensions, see Extending workflows in the AppConfig User Guide.

INSERT INTO aws.appconfig.extensions (
Name,
Description,
Actions,
Parameters,
Tags,
region,
`Latest-Version-Number`
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ Actions }}',
'{{ Parameters }}',
'{{ Tags }}',
'{{ region }}',
'{{ Latest-Version-Number }}'
RETURNING
actions,
arn,
description,
id,
name,
parameters,
version_number
;

Manifest

# Description fields are for documentation purposes
- name: extensions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the extensions resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: Actions
    value: "{{ Actions }}"
  - name: Parameters
    value: "{{ Parameters }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: Latest-Version-Number
    value: {{ Latest-Version-Number }}
    description: You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.
    description: You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

UPDATE examples

update_extension

Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.

UPDATE aws.appconfig.extensions
SET 
Description = '{{ Description }}',
Actions = '{{ Actions }}',
Parameters = '{{ Parameters }}',
VersionNumber = {{ VersionNumber }}
WHERE 
extension_identifier = '{{ extension_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
actions,
arn,
description,
id,
name,
parameters,
version_number;

DELETE examples

delete_extension

Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

DELETE FROM aws.appconfig.extensions
WHERE extension_identifier = '{{ extension_identifier }}' --required
AND region = '{{ region }}' --required
AND version = '{{ version }}'
;