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

Class Node

java.lang.Object
software.amazon.awssdk.services.managedblockchain.model.Node
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Node.Builder,Node>
@Generated("software.amazon.awssdk:codegen") public final class Node extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Node.Builder,Node>

Configuration properties of a node.

See Also:

  • Method Details

    • networkId

      public final String networkId()

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

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

    • memberId

      public final String memberId()

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

      Applies only to Hyperledger Fabric.

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

      Applies only to Hyperledger Fabric.

    • id

      public final String id()

      The unique identifier of the node.

      Returns:
      The unique identifier of the node.

    • instanceType

      public final String instanceType()

      The instance type of the node.

      Returns:
      The instance type of the node.

    • availabilityZone

      public final String availabilityZone()

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

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

    • frameworkAttributes

      public final NodeFrameworkAttributes frameworkAttributes()

      Attributes of the blockchain framework being used.

      Returns:
      Attributes of the blockchain framework being used.

    • logPublishingConfiguration

      public final NodeLogPublishingConfiguration logPublishingConfiguration()

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

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

    • stateDB

      public final StateDBType stateDB()

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

      Applies only to Hyperledger Fabric.

      If the service returns an enum value that is not available in the current SDK version, stateDB will return StateDBType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateDBAsString().

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

      Applies only to Hyperledger Fabric.

      See Also:

    • stateDBAsString

      public final String stateDBAsString()

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

      Applies only to Hyperledger Fabric.

      If the service returns an enum value that is not available in the current SDK version, stateDB will return StateDBType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateDBAsString().

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

      Applies only to Hyperledger Fabric.

      See Also:

    • status

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, status will return NodeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return NodeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

      See Also:

    • creationDate

      public final Instant creationDate()

      The date and time that the node was created.

      Returns:
      The date and time that the node was created.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • arn

      public final 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.

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

    • kmsKeyArn

      public final 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.

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

    • toBuilder

      public Node.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Node.Builder,Node>
      Returns:
      a builder for type T

    • builder

      public static Node.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Node.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.