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	awscc.datazone.project_memberships

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
project_identifier	string
member	object
domain_identifier	string
region	string	AWS region.

For more information, see AWS::DataZone::ProjectMembership.

Methods

Name	Resource	Accessible by	Required Params
create_resource	project_memberships	INSERT	Designation, DomainIdentifier, ProjectIdentifier, Member, region
delete_resource	project_memberships	DELETE	Identifier, region
update_resource	project_memberships	UPDATE	Identifier, PatchDocument, region
list_resources	project_memberships_list_only	SELECT	region
get_resource	project_memberships	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual project_membership.

SELECT
  region,
  project_identifier,
  designation,
  member,
  domain_identifier
FROM awscc.datazone.project_memberships
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_identifier }}|{{ member_identifier }}|{{ member_identifier_type }}|{{ project_identifier }}';

list (identifiers only)

Lists all project_memberships in a region.

SELECT
  region,
  domain_identifier,
  member_identifier,
  member_identifier_type,
  project_identifier
FROM awscc.datazone.project_memberships_list_only
WHERE
  region = '{{ region }}';

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 awscc.datazone.project_memberships (
  ProjectIdentifier,
  Designation,
  Member,
  DomainIdentifier,
  region
)
SELECT
  '{{ project_identifier }}',
  '{{ designation }}',
  '{{ member }}',
  '{{ domain_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.datazone.project_memberships (
  ProjectIdentifier,
  Designation,
  Member,
  DomainIdentifier,
  region
)
SELECT
  '{{ project_identifier }}',
  '{{ designation }}',
  '{{ member }}',
  '{{ domain_identifier }}',
  '{{ 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: project_membership
  props:
    - name: project_identifier
      value: '{{ project_identifier }}'
    - name: designation
      value: '{{ designation }}'
    - name: member
      value: null
    - name: domain_identifier
      value: '{{ domain_identifier }}'

UPDATE example

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

/*+ update */
UPDATE awscc.datazone.project_memberships
SET PatchDocument = string('{{ {
    "Designation": designation
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_identifier }}|{{ member_identifier }}|{{ member_identifier_type }}|{{ project_identifier }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.project_memberships
WHERE
  Identifier = '{{ domain_identifier }}|{{ member_identifier }}|{{ member_identifier_type }}|{{ project_identifier }}' 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 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