networks

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

Overview

Name	networks
Type	Resource
Id	aws.managedblockchain.networks

Fields

The following fields are returned by SELECT queries:

get_network

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the network. 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 network was created.
description	string	Attributes of the blockchain framework for the network.
framework	string	The blockchain framework that the network uses. (HYPERLEDGER_FABRIC, ETHEREUM)
framework_attributes	object	Attributes of the blockchain framework that the network uses.
framework_version	string	The version of the blockchain framework that the network uses.
id	string	The unique identifier of the network.
name	string	The name of the network. (pattern: <code>.\S.</code>)
status	string	The current status of the network. (CREATING, AVAILABLE, CREATE_FAILED, DELETING, DELETED)
tags	object	Tags assigned to the network. Each tag consists 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.
voting_policy	object	The voting rules for the network to decide if a proposal is accepted Applies only to Hyperledger Fabric.
vpc_endpoint_service_name	string	The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service name to create a VPC endpoint to access network resources.

list_networks

Name	Datatype	Description
networks	array	An array of NetworkSummary objects that contain configuration properties for each network.
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_network	select	network_id, region		Returns detailed information about a network. Applies to Hyperledger Fabric and Ethereum.
list_networks	select	region	name, framework, status, maxResults, nextToken	Returns information about the networks in which the current Amazon Web Services account participates. Applies to Hyperledger Fabric and Ethereum.
create_network	insert	region, ClientRequestToken, Name, Framework, FrameworkVersion, VotingPolicy, MemberConfiguration		Creates a new blockchain network using Amazon Managed Blockchain. 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
network_id	string	The unique identifier of the network to get information about.
region	string	AWS region (default: us-east-1)
framework	string	An optional framework specifier. If provided, only networks of this framework type are listed.
maxResults	integer	The maximum number of networks to list.
name	string	The name of the network.
nextToken	string	The pagination token that indicates the next set of results to retrieve.
status	string	An optional status specifier. If provided, only networks currently in this status are listed. Applies only to Hyperledger Fabric.

SELECT examples

get_network

Returns detailed information about a network. Applies to Hyperledger Fabric and Ethereum.

SELECT
arn,
creation_date,
description,
framework,
framework_attributes,
framework_version,
id,
name,
status,
tags,
voting_policy,
vpc_endpoint_service_name
FROM aws.managedblockchain.networks
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
;

list_networks

Returns information about the networks in which the current Amazon Web Services account participates. Applies to Hyperledger Fabric and Ethereum.

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

INSERT examples

create_network

Creates a new blockchain network using Amazon Managed Blockchain. Applies only to Hyperledger Fabric.

INSERT INTO aws.managedblockchain.networks (
ClientRequestToken,
Name,
Description,
Framework,
FrameworkVersion,
FrameworkConfiguration,
VotingPolicy,
MemberConfiguration,
Tags,
region
)
SELECT 
'{{ ClientRequestToken }}' /* required */,
'{{ Name }}' /* required */,
'{{ Description }}',
'{{ Framework }}' /* required */,
'{{ FrameworkVersion }}' /* required */,
'{{ FrameworkConfiguration }}',
'{{ VotingPolicy }}' /* required */,
'{{ MemberConfiguration }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
member_id,
network_id
;

Manifest

# Description fields are for documentation purposes
- name: networks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the networks resource.
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: Framework
    value: "{{ Framework }}"
    valid_values: ['HYPERLEDGER_FABRIC', 'ETHEREUM']
  - name: FrameworkVersion
    value: "{{ FrameworkVersion }}"
  - name: FrameworkConfiguration
    description: |
      Configuration properties relevant to the network for the blockchain framework that the network uses.
    value:
      Fabric:
        Edition: "{{ Edition }}"
  - name: VotingPolicy
    description: |
      The voting rules for the network to decide if a proposal is accepted Applies only to Hyperledger Fabric.
    value:
      ApprovalThresholdPolicy:
        ThresholdPercentage: {{ ThresholdPercentage }}
        ProposalDurationInHours: {{ ProposalDurationInHours }}
        ThresholdComparator: "{{ ThresholdComparator }}"
  - 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 }}"
  - name: Tags
    value: "{{ Tags }}"