attribute_groups

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

Overview

Name	attribute_groups
Type	Resource
Id	aws.servicecatalog_appregistry.attribute_groups

Fields

The following fields are returned by SELECT queries:

get_attribute_group

Name	Datatype	Description
id	string	The identifier of the attribute group. (pattern: <code>[-.\w]+</code>)
name	string	The name of the attribute group. (pattern: <code>[-.\w]+</code>)
arn	string	The Amazon resource name (ARN) that specifies the attribute group across services. (pattern: <code>arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+</code>)
attributes	string	A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components. (pattern: <code>[\u0009\u000A\u000D\u0020-\u00FF]+</code>)
created_by	string	The service principal that created the attribute group. (pattern: <code>^(?!-)([a-z0-9-]+.)+(aws.internal|amazonaws.com(.cn)?)$</code>)
creation_time	string (date-time)	The ISO-8601 formatted timestamp of the moment the attribute group was created.
description	string	The description of the attribute group that the user provides.
last_update_time	string (date-time)	The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
tags	object	Key-value pairs associated with the attribute group.

list_attribute_groups

Name	Datatype	Description
id	string	The globally unique attribute group identifier of the attribute group. (pattern: <code>[-.\w]+</code>)
name	string	The name of the attribute group. (pattern: <code>[-.\w]+</code>)
arn	string	The Amazon resource name (ARN) that specifies the attribute group across services. (pattern: <code>arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+</code>)
created_by	string	The service principal that created the attribute group. (pattern: <code>^(?!-)([a-z0-9-]+.)+(aws.internal|amazonaws.com(.cn)?)$</code>)
creation_time	string (date-time)	The ISO-8601 formatted timestamp of the moment the attribute group was created.
description	string	The description of the attribute group that the user provides.
last_update_time	string (date-time)	The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_attribute_group	select	attribute_group, region		Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.
list_attribute_groups	select	region	nextToken, maxResults	Lists all attribute groups which you have access to. Results are paginated.
create_attribute_group	insert	region, name, attributes, clientToken		Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.
associate_attribute_group	update	application, attribute_group, region		Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.
update_attribute_group	update	attribute_group, region		Updates an existing attribute group with new details.
delete_attribute_group	delete	attribute_group, region		Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
disassociate_attribute_group	exec	application, attribute_group, region		Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts AssociateAttributeGroup.

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.
attribute_group	string	The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
region	string	AWS region (default: us-east-1)
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.

SELECT examples

get_attribute_group

Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.

SELECT
id,
name,
arn,
attributes,
created_by,
creation_time,
description,
last_update_time,
tags
FROM aws.servicecatalog_appregistry.attribute_groups
WHERE attribute_group = '{{ attribute_group }}' -- required
AND region = '{{ region }}' -- required
;

list_attribute_groups

Lists all attribute groups which you have access to. Results are paginated.

SELECT
id,
name,
arn,
created_by,
creation_time,
description,
last_update_time
FROM aws.servicecatalog_appregistry.attribute_groups
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_attribute_group

Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.

INSERT INTO aws.servicecatalog_appregistry.attribute_groups (
name,
description,
attributes,
tags,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ attributes }}' /* required */,
'{{ tags }}',
'{{ clientToken }}' /* required */,
'{{ region }}'
RETURNING
attribute_group
;

Manifest

# Description fields are for documentation purposes
- name: attribute_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the attribute_groups resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: attributes
    value: "{{ attributes }}"
  - name: tags
    value: "{{ tags }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

associate_attribute_group

Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.

UPDATE aws.servicecatalog_appregistry.attribute_groups
SET 
-- No updatable properties
WHERE 
application = '{{ application }}' --required
AND attribute_group = '{{ attribute_group }}' --required
AND region = '{{ region }}' --required
RETURNING
application_arn,
attribute_group_arn;

update_attribute_group

Updates an existing attribute group with new details.

UPDATE aws.servicecatalog_appregistry.attribute_groups
SET 
name = '{{ name }}',
description = '{{ description }}',
attributes = '{{ attributes }}'
WHERE 
attribute_group = '{{ attribute_group }}' --required
AND region = '{{ region }}' --required
RETURNING
attribute_group;

DELETE examples

delete_attribute_group

Deletes an attribute group, specified either by its attribute group ID, name, or ARN.

DELETE FROM aws.servicecatalog_appregistry.attribute_groups
WHERE attribute_group = '{{ attribute_group }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_attribute_group

Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts AssociateAttributeGroup.

EXEC aws.servicecatalog_appregistry.attribute_groups.disassociate_attribute_group 
@application='{{ application }}' --required, 
@attribute_group='{{ attribute_group }}' --required, 
@region='{{ region }}' --required
;