Node - Amazon Managed Blockchain

Node

Configuration properties of a node.

Contents

Arn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn:.+:.+:.+:.+:.+

Required: No

AvailabilityZone

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

Type: String

Required: No

CreationDate

The date and time that the node was created.

Type: Timestamp

Required: No

FrameworkAttributes

Attributes of the blockchain framework being used.

Type: NodeFrameworkAttributes object

Required: No

Id

The unique identifier of the node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

InstanceType

The instance type of the node.

Type: String

Required: No

KmsKeyArn

The Amazon Resource Name (ARN) of the customer managed key in AWS Key Management Service (AWS KMS) that the node uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the node uses an AWS 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.

Type: String

Required: No

LogPublishingConfiguration

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

Type: NodeLogPublishingConfiguration object

Required: No

MemberId

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

Applies only to Hyperledger Fabric.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

NetworkId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

StateDB

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

Applies only to Hyperledger Fabric.

Type: String

Valid Values: LevelDB | CouchDB

Required: No

Status

The status of the node.

  • CREATING - The AWS 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 AWS 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 AWS 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 is not 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.

Type: String

Valid Values: CREATING | AVAILABLE | UNHEALTHY | CREATE_FAILED | UPDATING | DELETING | DELETED | FAILED | INACCESSIBLE_ENCRYPTION_KEY

Required: No

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.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: