Skip to content

/AWS1/CL_MBCNODE

Configuration properties of a node.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_networkid TYPE /AWS1/MBCRESOURCEIDSTRING /AWS1/MBCRESOURCEIDSTRING

The unique identifier of the network that the node is on.

iv_memberid TYPE /AWS1/MBCRESOURCEIDSTRING /AWS1/MBCRESOURCEIDSTRING

The unique identifier of the member to which the node belongs.

Applies only to Hyperledger Fabric.

iv_id TYPE /AWS1/MBCRESOURCEIDSTRING /AWS1/MBCRESOURCEIDSTRING

The unique identifier of the node.

iv_instancetype TYPE /AWS1/MBCINSTANCETYPESTRING /AWS1/MBCINSTANCETYPESTRING

The instance type of the node.

iv_availabilityzone TYPE /AWS1/MBCAZSTRING /AWS1/MBCAZSTRING

The Availability Zone in which the node exists. Required for Ethereum nodes.

io_frameworkattributes TYPE REF TO /AWS1/CL_MBCNODEFRAMEWORKATTRS /AWS1/CL_MBCNODEFRAMEWORKATTRS

Attributes of the blockchain framework being used.

io_logpublishingconf TYPE REF TO /AWS1/CL_MBCNODELOGPUBINGCONF /AWS1/CL_MBCNODELOGPUBINGCONF

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

iv_statedb TYPE /AWS1/MBCSTATEDBTYPE /AWS1/MBCSTATEDBTYPE

The state database that the node uses. Values are LevelDB or CouchDB.

Applies only to Hyperledger Fabric.

iv_status TYPE /AWS1/MBCNODESTATUS /AWS1/MBCNODESTATUS

The status of the node.

  • CREATING - The Amazon Web Services account is in the process of creating a node.

  • AVAILABLE - The node has been created and can participate in the network.

  • UNHEALTHY - The node is impaired and might not function as expected. Amazon Managed Blockchain automatically finds nodes in this state and tries to recover them. If a node is recoverable, it returns to AVAILABLE. Otherwise, it moves to FAILED status.

  • CREATE_FAILED - The Amazon Web Services account attempted to create a node and creation failed.

  • UPDATING - The node is in the process of being updated.

  • DELETING - The node is in the process of being deleted.

  • DELETED - The node can no longer participate on the network.

  • FAILED - The node is no longer functional, cannot be recovered, and must be deleted.

  • INACCESSIBLE_ENCRYPTION_KEY - The node 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 node resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

iv_creationdate TYPE /AWS1/MBCTIMESTAMP /AWS1/MBCTIMESTAMP

The date and time that the node was created.

it_tags TYPE /AWS1/CL_MBCOUTPUTTAGMAP_W=>TT_OUTPUTTAGMAP TT_OUTPUTTAGMAP

Tags assigned to the node. 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.

iv_arn TYPE /AWS1/MBCARNSTRING /AWS1/MBCARNSTRING

The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

iv_kmskeyarn TYPE /AWS1/MBCSTRING /AWS1/MBCSTRING

The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the node uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the node uses an Amazon Web Services owned KMS key for encryption. The node inherits this parameter from the member that it belongs to.

For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

Applies only to Hyperledger Fabric.

Queryable Attributes

NetworkId

The unique identifier of the network that the node is on.

Accessible with the following methods

Method Description
GET_NETWORKID() Getter for NETWORKID, with configurable default
ASK_NETWORKID() Getter for NETWORKID w/ exceptions if field has no value
HAS_NETWORKID() Determine if NETWORKID has a value

MemberId

The unique identifier of the member to which the node belongs.

Applies only to Hyperledger Fabric.

Accessible with the following methods

Method Description
GET_MEMBERID() Getter for MEMBERID, with configurable default
ASK_MEMBERID() Getter for MEMBERID w/ exceptions if field has no value
HAS_MEMBERID() Determine if MEMBERID has a value

Id

The unique identifier of the node.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

InstanceType

The instance type of the node.

Accessible with the following methods

Method Description
GET_INSTANCETYPE() Getter for INSTANCETYPE, with configurable default
ASK_INSTANCETYPE() Getter for INSTANCETYPE w/ exceptions if field has no value
HAS_INSTANCETYPE() Determine if INSTANCETYPE has a value

AvailabilityZone

The Availability Zone in which the node exists. Required for Ethereum nodes.

Accessible with the following methods

Method Description
GET_AVAILABILITYZONE() Getter for AVAILABILITYZONE, with configurable default
ASK_AVAILABILITYZONE() Getter for AVAILABILITYZONE w/ exceptions if field has no va
HAS_AVAILABILITYZONE() Determine if AVAILABILITYZONE has a value

FrameworkAttributes

Attributes of the blockchain framework being used.

Accessible with the following methods

Method Description
GET_FRAMEWORKATTRIBUTES() Getter for FRAMEWORKATTRIBUTES

LogPublishingConfiguration

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

Accessible with the following methods

Method Description
GET_LOGPUBLISHINGCONF() Getter for LOGPUBLISHINGCONFIGURATION

StateDB

The state database that the node uses. Values are LevelDB or CouchDB.

Applies only to Hyperledger Fabric.

Accessible with the following methods

Method Description
GET_STATEDB() Getter for STATEDB, with configurable default
ASK_STATEDB() Getter for STATEDB w/ exceptions if field has no value
HAS_STATEDB() Determine if STATEDB has a value

Status

The status of the node.

  • CREATING - The Amazon Web Services account is in the process of creating a node.

  • AVAILABLE - The node has been created and can participate in the network.

  • UNHEALTHY - The node is impaired and might not function as expected. Amazon Managed Blockchain automatically finds nodes in this state and tries to recover them. If a node is recoverable, it returns to AVAILABLE. Otherwise, it moves to FAILED status.

  • CREATE_FAILED - The Amazon Web Services account attempted to create a node and creation failed.

  • UPDATING - The node is in the process of being updated.

  • DELETING - The node is in the process of being deleted.

  • DELETED - The node can no longer participate on the network.

  • FAILED - The node is no longer functional, cannot be recovered, and must be deleted.

  • INACCESSIBLE_ENCRYPTION_KEY - The node 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 node resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

CreationDate

The date and time that the node was created.

Accessible with the following methods

Method Description
GET_CREATIONDATE() Getter for CREATIONDATE, with configurable default
ASK_CREATIONDATE() Getter for CREATIONDATE w/ exceptions if field has no value
HAS_CREATIONDATE() Determine if CREATIONDATE has a value

Tags

Tags assigned to the node. 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.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

Arn

The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Accessible with the following methods

Method Description
GET_ARN() Getter for ARN, with configurable default
ASK_ARN() Getter for ARN w/ exceptions if field has no value
HAS_ARN() Determine if ARN has a value

KmsKeyArn

The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the node uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the node uses an Amazon Web Services owned KMS key for encryption. The node inherits this parameter from the member that it belongs to.

For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

Applies only to Hyperledger Fabric.

Accessible with the following methods

Method Description
GET_KMSKEYARN() Getter for KMSKEYARN, with configurable default
ASK_KMSKEYARN() Getter for KMSKEYARN w/ exceptions if field has no value
HAS_KMSKEYARN() Determine if KMSKEYARN has a value