associated_resources

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

Overview

Name	associated_resources
Type	Resource
Id	aws.servicecatalog_appregistry.associated_resources

Fields

The following fields are returned by SELECT queries:

get_associated_resource

Name	Datatype	Description
application_tag_result	object	The result of the application that's tag applied to a resource.
options	array	Determines whether an application tag is applied or skipped.
resource	object	The resource associated with the application.

list_associated_resources

Name	Datatype	Description
name	string	The name of the resource. (pattern: <code>\S+</code>)
arn	string	The Amazon resource name (ARN) that specifies the resource across services. (pattern: <code>arn:(aws[a-zA-Z0-9-]):([a-zA-Z0-9-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.)</code>)
options	array	Determines whether an application tag is applied or skipped.
resource_details	object	The details related to the resource.
resource_type	string	Provides information about the Service Catalog App Registry resource type. (CFN_STACK, RESOURCE_TAG_VALUE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_associated_resource	select	application, resource_type, resource, region	nextToken, resourceTagStatus, maxResults	Gets the resource associated with the application.
list_associated_resources	select	application, region	nextToken, maxResults	Lists all of the resources that are associated with the specified application. Results are paginated. If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.

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
application	string	The name, ID, or ARN of the application.
region	string	AWS region (default: us-east-1)
resource	string	The name or ID of the resource associated with the application.
resource_type	string	The type of resource associated with the application.
maxResults	integer	The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.
nextToken	string	The token to use to get the next page of results after a previous API call.
resourceTagStatus	array	States whether an application tag is applied, not applied, in the process of being applied, or skipped.

SELECT examples

get_associated_resource

Gets the resource associated with the application.

SELECT
application_tag_result,
options,
resource
FROM aws.servicecatalog_appregistry.associated_resources
WHERE application = '{{ application }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND resource = '{{ resource }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND resourceTagStatus = '{{ resourceTagStatus }}'
AND maxResults = '{{ maxResults }}'
;

list_associated_resources

Lists all of the resources that are associated with the specified application. Results are paginated. If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.

SELECT
name,
arn,
options,
resource_details,
resource_type
FROM aws.servicecatalog_appregistry.associated_resources
WHERE application = '{{ application }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;