group_profiles

Creates, updates, deletes, gets or lists a group_profiles resource.

Overview

Name	group_profiles
Type	Resource
Id	aws.datazone.group_profiles

Fields

The following fields are returned by SELECT queries:

get_group_profile

Name	Datatype	Description
id	string	The identifier of the group profile. (pattern: <code>([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}</code>)
domain_id	string	The identifier of the Amazon DataZone domain in which the group profile exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
group_name	string	The name of the group for which the specified group profile exists. (pattern: <code>[a-zA-Z_0-9+=,.@-]+</code>)
role_principal_arn	string	The ARN of the IAM role principal. This role is associated with the group profile.
role_principal_id	string	The unique identifier of the IAM role principal. This principal is associated with the group profile.
status	string	The identifier of the group profile. (ASSIGNED, NOT_ASSIGNED)

search_group_profiles

Name	Datatype	Description
id	string	The ID of a group profile. (pattern: <code>([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}</code>)
domain_id	string	The ID of the Amazon DataZone domain of a group profile. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
group_name	string	The group name of a group profile. (pattern: <code>[a-zA-Z_0-9+=,.@-]+</code>)
role_principal_arn	string	The ARN of the IAM role principal. This role is associated with the group profile.
role_principal_id	string	The unique identifier of the IAM role principal. This principal is associated with the group profile.
status	string	The status of a group profile. (ASSIGNED, NOT_ASSIGNED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_group_profile	select	domain_identifier, group_identifier, region		Gets a group profile in Amazon DataZone.
search_group_profiles	select	domain_identifier, region		Searches group profiles in Amazon DataZone.
create_group_profile	insert	domain_identifier, region		Creates a group profile in Amazon DataZone.
update_group_profile	update	domain_identifier, group_identifier, region, status		Updates the specified group profile in Amazon DataZone.

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
domain_identifier	string	The identifier of the Amazon DataZone domain in which a group profile is updated.
group_identifier	string	The identifier of the group profile that is updated.
region	string	AWS region (default: us-east-1)

SELECT examples

get_group_profile

Gets a group profile in Amazon DataZone.

SELECT
id,
domain_id,
group_name,
role_principal_arn,
role_principal_id,
status
FROM aws.datazone.group_profiles
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND group_identifier = '{{ group_identifier }}' -- required
AND region = '{{ region }}' -- required
;

search_group_profiles

Searches group profiles in Amazon DataZone.

SELECT
id,
domain_id,
group_name,
role_principal_arn,
role_principal_id,
status
FROM aws.datazone.group_profiles
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_group_profile

Creates a group profile in Amazon DataZone.

INSERT INTO aws.datazone.group_profiles (
groupIdentifier,
rolePrincipalArn,
clientToken,
domain_identifier,
region
)
SELECT 
'{{ groupIdentifier }}',
'{{ rolePrincipalArn }}',
'{{ clientToken }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
domain_id,
group_name,
role_principal_arn,
role_principal_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: group_profiles
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the group_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the group_profiles resource.
  - name: groupIdentifier
    value: "{{ groupIdentifier }}"
  - name: rolePrincipalArn
    value: "{{ rolePrincipalArn }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_group_profile

Updates the specified group profile in Amazon DataZone.

UPDATE aws.datazone.group_profiles
SET 
status = '{{ status }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND group_identifier = '{{ group_identifier }}' --required
AND region = '{{ region }}' --required
AND status = '{{ status }}' --required
RETURNING
id,
domain_id,
group_name,
role_principal_arn,
role_principal_id,
status;