resource_associations

Creates, updates, deletes or gets a resource_association resource or lists resource_associations in a region

Overview

Name	resource_associations
Type	Resource
Description	Resource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation
Id	awscc.servicecatalogappregistry.resource_associations

Fields

get (all properties)

Name	Datatype	Description
application	string	The name or the Id of the Application.
resource	string	The name or the Id of the Resource.
resource_type	string	The type of the CFN Resource for now it's enum CFN_STACK.
application_arn	string
resource_arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
application	string	The name or the Id of the Application.
resource	string	The name or the Id of the Resource.
resource_type	string	The type of the CFN Resource for now it's enum CFN_STACK.
application_arn	string
resource_arn	string
region	string	AWS region.

For more information, see AWS::ServiceCatalogAppRegistry::ResourceAssociation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	resource_associations	INSERT	Application, Resource, ResourceType, region
delete_resource	resource_associations	DELETE	Identifier, region
list_resources	resource_associations_list_only	SELECT	region
get_resource	resource_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual resource_association.

SELECT
  region,
  application,
  resource,
  resource_type,
  application_arn,
  resource_arn
FROM awscc.servicecatalogappregistry.resource_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_arn }}|{{ resource_arn }}|{{ resource_type }}';

list (identifiers only)

Lists all resource_associations in a region.

SELECT
  region,
  application_arn,
  resource_arn,
  resource_type
FROM awscc.servicecatalogappregistry.resource_associations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.servicecatalogappregistry.resource_associations (
  Application,
  Resource,
  ResourceType,
  region
)
SELECT
  '{{ application }}',
  '{{ resource }}',
  '{{ resource_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.servicecatalogappregistry.resource_associations (
  Application,
  Resource,
  ResourceType,
  region
)
SELECT
  '{{ application }}',
  '{{ resource }}',
  '{{ resource_type }}',
  '{{ 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: resource_association
  props:
    - name: application
      value: '{{ application }}'
    - name: resource
      value: '{{ resource }}'
    - name: resource_type
      value: '{{ resource_type }}'

DELETE example

/*+ delete */
DELETE FROM awscc.servicecatalogappregistry.resource_associations
WHERE
  Identifier = '{{ application_arn }}|{{ resource_arn }}|{{ resource_type }}' 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 resource_associations resource, the following permissions are required:

Create

servicecatalog:AssociateResource,
cloudformation:DescribeStacks

Read

servicecatalog:ListAssociatedResources

Delete

servicecatalog:DisassociateResource

List

servicecatalog:ListAssociatedResources