Package software.amazon.awssdk.services.managedblockchain.model

Interface Node.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Node.Builder,Node>, SdkBuilder<Node.Builder,Node>, SdkPojo
Enclosing class:
Node
public static interface Node.Builder extends SdkPojo, CopyableBuilder<Node.Builder,Node>

  • Method Details

    • networkId

      Node.Builder networkId(String networkId)

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

      Parameters:
      networkId - The unique identifier of the network that the node is on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memberId

      Node.Builder memberId(String memberId)

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

      Applies only to Hyperledger Fabric.

      Parameters:
      memberId - The unique identifier of the member to which the node belongs.

      Applies only to Hyperledger Fabric.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      Node.Builder id(String id)

      The unique identifier of the node.

      Parameters:
      id - The unique identifier of the node.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      Node.Builder instanceType(String instanceType)

      The instance type of the node.

      Parameters:
      instanceType - The instance type of the node.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZone

      Node.Builder availabilityZone(String availabilityZone)

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

      Parameters:
      availabilityZone - The Availability Zone in which the node exists. Required for Ethereum nodes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • frameworkAttributes

      Node.Builder frameworkAttributes(NodeFrameworkAttributes frameworkAttributes)

      Attributes of the blockchain framework being used.

      Parameters:
      frameworkAttributes - Attributes of the blockchain framework being used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • frameworkAttributes

      default Node.Builder frameworkAttributes(Consumer<NodeFrameworkAttributes.Builder> frameworkAttributes)

      Attributes of the blockchain framework being used.

      This is a convenience method that creates an instance of the NodeFrameworkAttributes.Builder avoiding the need to create one manually via NodeFrameworkAttributes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to frameworkAttributes(NodeFrameworkAttributes).

      Parameters:
      frameworkAttributes - a consumer that will call methods on NodeFrameworkAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logPublishingConfiguration

      Node.Builder logPublishingConfiguration(NodeLogPublishingConfiguration logPublishingConfiguration)

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

      Parameters:
      logPublishingConfiguration - Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPublishingConfiguration

      default Node.Builder logPublishingConfiguration(Consumer<NodeLogPublishingConfiguration.Builder> logPublishingConfiguration)

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

      This is a convenience method that creates an instance of the NodeLogPublishingConfiguration.Builder avoiding the need to create one manually via NodeLogPublishingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logPublishingConfiguration(NodeLogPublishingConfiguration).

      Parameters:
      logPublishingConfiguration - a consumer that will call methods on NodeLogPublishingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stateDB

      Node.Builder stateDB(String stateDB)

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

      Applies only to Hyperledger Fabric.

      Parameters:
      stateDB - The state database that the node uses. Values are LevelDB or CouchDB.

      Applies only to Hyperledger Fabric.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stateDB

      Node.Builder stateDB(StateDBType stateDB)

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

      Applies only to Hyperledger Fabric.

      Parameters:
      stateDB - The state database that the node uses. Values are LevelDB or CouchDB.

      Applies only to Hyperledger Fabric.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Node.Builder status(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Node.Builder status(NodeStatus 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationDate

      Node.Builder creationDate(Instant creationDate)

      The date and time that the node was created.

      Parameters:
      creationDate - The date and time that the node was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Node.Builder tags(Map<String,String> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Node.Builder arn(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyArn

      Node.Builder kmsKeyArn(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.