extension_associations

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

Overview

Name	extension_associations
Type	Resource
Id	aws.appconfig.extension_associations

Fields

The following fields are returned by SELECT queries:

get_extension_association

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>)
extension_arn	string	The ARN of the extension defined in the association. (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>)
extension_version_number	integer	The version number for the extension defined in the association.
id	string	The system-generated ID for the association.
parameters	object	The parameter names and values defined in the association.
resource_arn	string	The ARNs of applications, configuration profiles, or environments defined in the association. (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>)

list_extension_associations

Name	Datatype	Description
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>)
id	string	The extension association ID. This ID is used to call other ExtensionAssociation API actions such as GetExtensionAssociation or DeleteExtensionAssociation.
resource_arn	string	The ARNs of applications, configuration profiles, or environments defined in the association. (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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_extension_association	select	extension_association_id, region		Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
list_extension_associations	select	region	resource_identifier, extension_identifier, extension_version_number, max_results, next_token	Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
create_extension_association	insert	region, ExtensionIdentifier, ResourceIdentifier		When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
update_extension_association	update	extension_association_id, region		Updates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
delete_extension_association	delete	extension_association_id, region		Deletes an extension association. This action doesn't delete extensions defined in the association.

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_association_id	string	The ID of the extension association to delete.
region	string	AWS region (default: us-east-1)
extension_identifier	string	The name, the ID, or the Amazon Resource Name (ARN) of the extension.
extension_version_number	integer	The version number for the extension defined in the association.
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.
next_token	string	A token to start the list. Use this token to get the next set of results or pass null to get the first set of results.
resource_identifier	string	The ARN of an application, configuration profile, or environment.

SELECT examples

get_extension_association

Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

SELECT
arn,
extension_arn,
extension_version_number,
id,
parameters,
resource_arn
FROM aws.appconfig.extension_associations
WHERE extension_association_id = '{{ extension_association_id }}' -- required
AND region = '{{ region }}' -- required
;

list_extension_associations

Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

SELECT
extension_arn,
id,
resource_arn
FROM aws.appconfig.extension_associations
WHERE region = '{{ region }}' -- required
AND resource_identifier = '{{ resource_identifier }}'
AND extension_identifier = '{{ extension_identifier }}'
AND extension_version_number = '{{ extension_version_number }}'
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
;

INSERT examples

create_extension_association

When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

INSERT INTO aws.appconfig.extension_associations (
ExtensionIdentifier,
ExtensionVersionNumber,
ResourceIdentifier,
Parameters,
Tags,
region
)
SELECT 
'{{ ExtensionIdentifier }}' /* required */,
{{ ExtensionVersionNumber }},
'{{ ResourceIdentifier }}' /* required */,
'{{ Parameters }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
extension_arn,
extension_version_number,
id,
parameters,
resource_arn
;

Manifest

# Description fields are for documentation purposes
- name: extension_associations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the extension_associations resource.
  - name: ExtensionIdentifier
    value: "{{ ExtensionIdentifier }}"
  - name: ExtensionVersionNumber
    value: {{ ExtensionVersionNumber }}
  - name: ResourceIdentifier
    value: "{{ ResourceIdentifier }}"
  - name: Parameters
    value: "{{ Parameters }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_extension_association

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

UPDATE aws.appconfig.extension_associations
SET 
Parameters = '{{ Parameters }}'
WHERE 
extension_association_id = '{{ extension_association_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
extension_arn,
extension_version_number,
id,
parameters,
resource_arn;

DELETE examples

delete_extension_association

Deletes an extension association. This action doesn't delete extensions defined in the association.

DELETE FROM aws.appconfig.extension_associations
WHERE extension_association_id = '{{ extension_association_id }}' --required
AND region = '{{ region }}' --required
;