project_memberships

Creates, updates, deletes or gets a project_membership resource or lists project_memberships in a region

Overview

Name	project_memberships
Type	Resource
Description	Definition of AWS::DataZone::ProjectMembership Resource Type
Id	aws.datazone.project_memberships

Fields

Name	Datatype	Description
project_identifier	string
designation	string
member	undefined
domain_identifier	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Designation, DomainIdentifier, ProjectIdentifier, Member, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all project_memberships in a region.

SELECT
region,
project_identifier,
designation,
member,
domain_identifier
FROM aws.datazone.project_memberships
WHERE region = 'us-east-1';

Gets all properties from an individual project_membership.

SELECT
region,
project_identifier,
designation,
member,
domain_identifier
FROM aws.datazone.project_memberships
WHERE region = 'us-east-1' AND data__Identifier = '<DomainIdentifier>|<MemberIdentifier>|<MemberIdentifierType>|<ProjectIdentifier>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.datazone.project_memberships (
 ProjectIdentifier,
 Designation,
 Member,
 DomainIdentifier,
 region
)
SELECT 
'{{ ProjectIdentifier }}',
 '{{ Designation }}',
 '{{ Member }}',
 '{{ DomainIdentifier }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.datazone.project_memberships (
 ProjectIdentifier,
 Designation,
 Member,
 DomainIdentifier,
 region
)
SELECT 
 '{{ ProjectIdentifier }}',
 '{{ Designation }}',
 '{{ Member }}',
 '{{ DomainIdentifier }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: project_membership
    props:
      - name: ProjectIdentifier
        value: '{{ ProjectIdentifier }}'
      - name: Designation
        value: '{{ Designation }}'
      - name: Member
        value: null
      - name: DomainIdentifier
        value: '{{ DomainIdentifier }}'

DELETE example

/*+ delete */
DELETE FROM aws.datazone.project_memberships
WHERE data__Identifier = '<DomainIdentifier|MemberIdentifier|MemberIdentifierType|ProjectIdentifier>'
AND region = 'us-east-1';

Permissions

To operate on the project_memberships resource, the following permissions are required:

Read

datazone:ListProjectMemberships

Create

datazone:CreateProjectMembership,
datazone:ListProjectMemberships,
iam:GetRole,
datazone:GetGroupProfile,
datazone:GetUserProfile

Update

datazone:CreateProjectMembership,
datazone:DeleteProjectMembership

List

datazone:ListProjectMemberships

Delete

datazone:DeleteProjectMembership