Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Node = Node' {
- arn :: Maybe Text
- availabilityZone :: Maybe Text
- creationDate :: Maybe ISO8601
- frameworkAttributes :: Maybe NodeFrameworkAttributes
- id :: Maybe Text
- instanceType :: Maybe Text
- kmsKeyArn :: Maybe Text
- logPublishingConfiguration :: Maybe NodeLogPublishingConfiguration
- memberId :: Maybe Text
- networkId :: Maybe Text
- stateDB :: Maybe StateDBType
- status :: Maybe NodeStatus
- tags :: Maybe (HashMap Text Text)
- newNode :: Node
- node_arn :: Lens' Node (Maybe Text)
- node_availabilityZone :: Lens' Node (Maybe Text)
- node_creationDate :: Lens' Node (Maybe UTCTime)
- node_frameworkAttributes :: Lens' Node (Maybe NodeFrameworkAttributes)
- node_id :: Lens' Node (Maybe Text)
- node_instanceType :: Lens' Node (Maybe Text)
- node_kmsKeyArn :: Lens' Node (Maybe Text)
- node_logPublishingConfiguration :: Lens' Node (Maybe NodeLogPublishingConfiguration)
- node_memberId :: Lens' Node (Maybe Text)
- node_networkId :: Lens' Node (Maybe Text)
- node_stateDB :: Lens' Node (Maybe StateDBType)
- node_status :: Lens' Node (Maybe NodeStatus)
- node_tags :: Lens' Node (Maybe (HashMap Text Text))
Documentation
Configuration properties of a node.
See: newNode
smart constructor.
Node' | |
|
Instances
Create a value of Node
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Node'
, node_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.
$sel:availabilityZone:Node'
, node_availabilityZone
- The Availability Zone in which the node exists. Required for Ethereum
nodes.
$sel:creationDate:Node'
, node_creationDate
- The date and time that the node was created.
$sel:frameworkAttributes:Node'
, node_frameworkAttributes
- Attributes of the blockchain framework being used.
$sel:id:Node'
, node_id
- The unique identifier of the node.
$sel:instanceType:Node'
, node_instanceType
- The instance type of the node.
$sel:kmsKeyArn:Node'
, node_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.
$sel:logPublishingConfiguration:Node'
, node_logPublishingConfiguration
- Configuration properties for logging events associated with a peer node
on a Hyperledger Fabric network on Managed Blockchain.
$sel:memberId:Node'
, node_memberId
- The unique identifier of the member to which the node belongs.
Applies only to Hyperledger Fabric.
$sel:networkId:Node'
, node_networkId
- The unique identifier of the network that the node is on.
$sel:stateDB:Node'
, node_stateDB
- The state database that the node uses. Values are LevelDB
or
CouchDB
.
Applies only to Hyperledger Fabric.
$sel:status:Node'
, node_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 toAVAILABLE
. Otherwise, it moves toFAILED
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.
$sel:tags:Node'
, node_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.
node_arn :: Lens' Node (Maybe Text) Source #
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.
node_availabilityZone :: Lens' Node (Maybe Text) Source #
The Availability Zone in which the node exists. Required for Ethereum nodes.
node_creationDate :: Lens' Node (Maybe UTCTime) Source #
The date and time that the node was created.
node_frameworkAttributes :: Lens' Node (Maybe NodeFrameworkAttributes) Source #
Attributes of the blockchain framework being used.
node_kmsKeyArn :: Lens' Node (Maybe Text) Source #
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.
node_logPublishingConfiguration :: Lens' Node (Maybe NodeLogPublishingConfiguration) Source #
Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.
node_memberId :: Lens' Node (Maybe Text) Source #
The unique identifier of the member to which the node belongs.
Applies only to Hyperledger Fabric.
node_networkId :: Lens' Node (Maybe Text) Source #
The unique identifier of the network that the node is on.
node_stateDB :: Lens' Node (Maybe StateDBType) Source #
The state database that the node uses. Values are LevelDB
or
CouchDB
.
Applies only to Hyperledger Fabric.
node_status :: Lens' Node (Maybe NodeStatus) Source #
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 toAVAILABLE
. Otherwise, it moves toFAILED
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.
node_tags :: Lens' Node (Maybe (HashMap Text Text)) Source #
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.