members

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

Overview

Name	members
Type	Resource
Id	aws.managedblockchain.members

Fields

The following fields are returned by SELECT queries:

get_member

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. (pattern: <code>^arn:.+:.+:.+:.+:.+</code>)
creation_date	string (date-time)	The date and time that the member was created.
description	string	An optional description for the member.
framework_attributes	object	Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.
id	string	The unique identifier of the member.
kms_key_arn	string	The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the member uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the member uses an Amazon Web Services owned KMS key for encryption. This parameter is inherited by the nodes that this member owns. For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
log_publishing_configuration	object	Configuration properties for logging events associated with a member.
name	string	The name of the member. (pattern: <code>^(?!-|[0-9])(?!.-$)(?!.?--)[a-zA-Z0-9-]+$</code>)
network_id	string	The unique identifier of the network to which the member belongs.
status	string	The status of a member. CREATING - The Amazon Web Services account is in the process of creating a member. AVAILABLE - The member has been created and can participate in the network. CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed. UPDATING - The member is in the process of being updated. DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member. DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member. INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked. The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource. (CREATING, AVAILABLE, CREATE_FAILED, UPDATING, DELETING, DELETED, INACCESSIBLE_ENCRYPTION_KEY)
tags	object	Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

list_members

Name	Datatype	Description
members	array	An array of MemberSummary objects. Each object contains details about a network member.
next_token	string	The pagination token that indicates the next set of results to retrieve.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_member	select	network_id, member_id, region		Returns detailed information about a member. Applies only to Hyperledger Fabric.
list_members	select	network_id, region	name, status, isOwned, maxResults, nextToken	Returns a list of the members in a network and properties of their configurations. Applies only to Hyperledger Fabric.
create_member	insert	network_id, region, ClientRequestToken, InvitationId, MemberConfiguration		Creates a member within a Managed Blockchain network. Applies only to Hyperledger Fabric.
update_member	update	network_id, member_id, region		Updates a member configuration with new parameters. Applies only to Hyperledger Fabric.
delete_member	delete	network_id, member_id, region		Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the Amazon Web Services account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last Amazon Web Services account, the network is deleted also. Applies only to Hyperledger Fabric.

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
member_id	string	The unique identifier of the member to remove.
network_id	string	The unique identifier of the network from which the member is removed.
region	string	AWS region (default: us-east-1)
isOwned	boolean	An optional Boolean value. If provided, the request is limited either to members that the current Amazon Web Services account owns (true) or that other Amazon Web Services accountsn own (false). If omitted, all members are listed.
maxResults	integer	The maximum number of members to return in the request.
name	string	The optional name of the member to list.
nextToken	string	The pagination token that indicates the next set of results to retrieve.
status	string	An optional status specifier. If provided, only members currently in this status are listed.

SELECT examples

get_member

Returns detailed information about a member. Applies only to Hyperledger Fabric.

SELECT
arn,
creation_date,
description,
framework_attributes,
id,
kms_key_arn,
log_publishing_configuration,
name,
network_id,
status,
tags
FROM aws.managedblockchain.members
WHERE network_id = '{{ network_id }}' -- required
AND member_id = '{{ member_id }}' -- required
AND region = '{{ region }}' -- required
;

list_members

Returns a list of the members in a network and properties of their configurations. Applies only to Hyperledger Fabric.

SELECT
members,
next_token
FROM aws.managedblockchain.members
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
AND name = '{{ name }}'
AND status = '{{ status }}'
AND isOwned = '{{ isOwned }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_member

Creates a member within a Managed Blockchain network. Applies only to Hyperledger Fabric.

INSERT INTO aws.managedblockchain.members (
ClientRequestToken,
InvitationId,
MemberConfiguration,
network_id,
region
)
SELECT 
'{{ ClientRequestToken }}' /* required */,
'{{ InvitationId }}' /* required */,
'{{ MemberConfiguration }}' /* required */,
'{{ network_id }}',
'{{ region }}'
RETURNING
member_id
;

Manifest

# Description fields are for documentation purposes
- name: members
props:
  - name: network_id
    value: "{{ network_id }}"
    description: Required parameter for the members resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the members resource.
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: InvitationId
    value: "{{ InvitationId }}"
  - name: MemberConfiguration
    description: |
      Configuration properties of the member. Applies only to Hyperledger Fabric.
    value:
      Name: "{{ Name }}"
      Description: "{{ Description }}"
      FrameworkConfiguration:
        Fabric:
          AdminUsername: "{{ AdminUsername }}"
          AdminPassword: "{{ AdminPassword }}"
      LogPublishingConfiguration:
        Fabric:
          CaLogs:
            Cloudwatch:
              Enabled: {{ Enabled }}
      Tags: "{{ Tags }}"
      KmsKeyArn: "{{ KmsKeyArn }}"

UPDATE examples

update_member

Updates a member configuration with new parameters. Applies only to Hyperledger Fabric.

UPDATE aws.managedblockchain.members
SET 
LogPublishingConfiguration = '{{ LogPublishingConfiguration }}'
WHERE 
network_id = '{{ network_id }}' --required
AND member_id = '{{ member_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_member

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the Amazon Web Services account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last Amazon Web Services account, the network is deleted also. Applies only to Hyperledger Fabric.

DELETE FROM aws.managedblockchain.members
WHERE network_id = '{{ network_id }}' --required
AND member_id = '{{ member_id }}' --required
AND region = '{{ region }}' --required
;