environment_memberships

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

Overview

Name	environment_memberships
Type	Resource
Id	aws.cloud9.environment_memberships

Fields

The following fields are returned by SELECT queries:

describe_environment_memberships

Name	Datatype	Description
environment_id	string	The ID of the environment for the environment member. (pattern: <code>^[a-zA-Z0-9]{8,32}$</code>)
last_access	string (date-time)	The time, expressed in epoch time format, when the environment member last opened the environment.
permissions	string	The type of environment member permissions associated with this environment member. Available values include: owner: Owns the environment. read-only: Has read-only access to the environment. read-write: Has read-write access to the environment. (owner, read-write, read-only)
user_arn	string	The Amazon Resource Name (ARN) of the environment member. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(iam|sts)::\d+:(root|(user/[\w+=/:,.@-]{1,64}|federated-user/[\w+=/:,.@-]{2,32}|assumed-role/[\w+=:,.@-]{1,64}/[\w+=,.@-]{1,64}))$</code>)
user_id	string	The user ID in Identity and Access Management (IAM) of the environment member.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_environment_memberships	select	region		Gets information about environment members for an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"
create_environment_membership	insert	region, environmentId, userArn, permissions		Adds an environment member to an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"
update_environment_membership	update	region, environmentId, userArn, permissions		Changes the settings of an existing environment member for an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"
delete_environment_membership	delete	region		Deletes an environment member from a development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_environment_memberships

Gets information about environment members for an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

SELECT
environment_id,
last_access,
permissions,
user_arn,
user_id
FROM aws.cloud9.environment_memberships
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_environment_membership

Adds an environment member to an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

INSERT INTO aws.cloud9.environment_memberships (
environmentId,
userArn,
permissions,
region
)
SELECT 
'{{ environmentId }}' /* required */,
'{{ userArn }}' /* required */,
'{{ permissions }}' /* required */,
'{{ region }}'
RETURNING
membership
;

Manifest

# Description fields are for documentation purposes
- name: environment_memberships
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the environment_memberships resource.
  - name: environmentId
    value: "{{ environmentId }}"
    description: |
      The ID of the environment that contains the environment member you want to add.
  - name: userArn
    value: "{{ userArn }}"
    description: |
      The Amazon Resource Name (ARN) of the environment member you want to add.
  - name: permissions
    value: "{{ permissions }}"
    description: |
      The type of environment member permissions you want to associate with this environment member. Available values include: read-only: Has read-only access to the environment. read-write: Has read-write access to the environment.
    valid_values: ['read-write', 'read-only']

UPDATE examples

update_environment_membership

Changes the settings of an existing environment member for an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

UPDATE aws.cloud9.environment_memberships
SET 
environmentId = '{{ environmentId }}',
userArn = '{{ userArn }}',
permissions = '{{ permissions }}'
WHERE 
region = '{{ region }}' --required
AND environmentId = '{{ environmentId }}' --required
AND userArn = '{{ userArn }}' --required
AND permissions = '{{ permissions }}' --required
RETURNING
membership;

DELETE examples

delete_environment_membership

Deletes an environment member from a development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

DELETE FROM aws.cloud9.environment_memberships
WHERE region = '{{ region }}' --required
;