« blib/lib/Paws/ManagedBlockchain/NetworkSummary.pm
↑ Summary
blib/lib/Paws/ManagedBlockchain/NodeConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ManagedBlockchain::Node; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 6 | has CreationDate => (is => 'ro', isa => 'Str'); | ||
| 7 | has FrameworkAttributes => (is => 'ro', isa => 'Paws::ManagedBlockchain::NodeFrameworkAttributes'); | ||
| 8 | has Id => (is => 'ro', isa => 'Str'); | ||
| 9 | has InstanceType => (is => 'ro', isa => 'Str'); | ||
| 10 | has KmsKeyArn => (is => 'ro', isa => 'Str'); | ||
| 11 | has LogPublishingConfiguration => (is => 'ro', isa => 'Paws::ManagedBlockchain::NodeLogPublishingConfiguration'); | ||
| 12 | has MemberId => (is => 'ro', isa => 'Str'); | ||
| 13 | has NetworkId => (is => 'ro', isa => 'Str'); | ||
| 14 | has StateDB => (is => 'ro', isa => 'Str'); | ||
| 15 | has Status => (is => 'ro', isa => 'Str'); | ||
| 16 | has Tags => (is => 'ro', isa => 'Paws::ManagedBlockchain::OutputTagMap'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::ManagedBlockchain::Node | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::ManagedBlockchain::Node object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { Arn => $value, ..., Tags => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::ManagedBlockchain::Node object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->Arn | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Configuration properties of a node. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Arn => Str | ||
| 54 | |||
| 55 | The Amazon Resource Name (ARN) of the node. For more information about | ||
| 56 | ARNs and their format, see Amazon Resource Names (ARNs) | ||
| 57 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 58 | in the I<AWS General Reference>. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 AvailabilityZone => Str | ||
| 62 | |||
| 63 | The Availability Zone in which the node exists. Required for Ethereum | ||
| 64 | nodes. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 CreationDate => Str | ||
| 68 | |||
| 69 | The date and time that the node was created. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 FrameworkAttributes => L<Paws::ManagedBlockchain::NodeFrameworkAttributes> | ||
| 73 | |||
| 74 | Attributes of the blockchain framework being used. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Id => Str | ||
| 78 | |||
| 79 | The unique identifier of the node. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 InstanceType => Str | ||
| 83 | |||
| 84 | The instance type of the node. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 KmsKeyArn => Str | ||
| 88 | |||
| 89 | The Amazon Resource Name (ARN) of the customer managed key in AWS Key | ||
| 90 | Management Service (AWS KMS) that the node uses for encryption at rest. | ||
| 91 | If the value of this parameter is C<"AWS Owned KMS Key">, the node uses | ||
| 92 | an AWS owned KMS key for encryption. The node inherits this parameter | ||
| 93 | from the member that it belongs to. | ||
| 94 | |||
| 95 | Applies only to Hyperledger Fabric. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 LogPublishingConfiguration => L<Paws::ManagedBlockchain::NodeLogPublishingConfiguration> | ||
| 99 | |||
| 100 | Configuration properties for logging events associated with a peer node | ||
| 101 | on a Hyperledger Fabric network on Managed Blockchain. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 MemberId => Str | ||
| 105 | |||
| 106 | The unique identifier of the member to which the node belongs. | ||
| 107 | |||
| 108 | Applies only to Hyperledger Fabric. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 NetworkId => Str | ||
| 112 | |||
| 113 | The unique identifier of the network that the node is on. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 StateDB => Str | ||
| 117 | |||
| 118 | The state database that the node uses. Values are C<LevelDB> or | ||
| 119 | C<CouchDB>. | ||
| 120 | |||
| 121 | Applies only to Hyperledger Fabric. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 Status => Str | ||
| 125 | |||
| 126 | The status of the node. | ||
| 127 | |||
| 128 | =over | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | C<CREATING> - The AWS account is in the process of creating a node. | ||
| 133 | |||
| 134 | =item * | ||
| 135 | |||
| 136 | C<AVAILABLE> - The node has been created and can participate in the | ||
| 137 | network. | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | C<UNHEALTHY> - The node is impaired and might not function as expected. | ||
| 142 | Amazon Managed Blockchain automatically finds nodes in this state and | ||
| 143 | tries to recover them. If a node is recoverable, it returns to | ||
| 144 | C<AVAILABLE>. Otherwise, it moves to C<FAILED> status. | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | C<CREATE_FAILED> - The AWS account attempted to create a node and | ||
| 149 | creation failed. | ||
| 150 | |||
| 151 | =item * | ||
| 152 | |||
| 153 | C<UPDATING> - The node is in the process of being updated. | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<DELETING> - The node is in the process of being deleted. | ||
| 158 | |||
| 159 | =item * | ||
| 160 | |||
| 161 | C<DELETED> - The node can no longer participate on the network. | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | C<FAILED> - The node is no longer functional, cannot be recovered, and | ||
| 166 | must be deleted. | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | C<INACCESSIBLE_ENCRYPTION_KEY> - The node is impaired and might not | ||
| 171 | function as expected because it cannot access the specified customer | ||
| 172 | managed key in AWS KMS for encryption at rest. Either the KMS key was | ||
| 173 | disabled or deleted, or the grants on the key were revoked. | ||
| 174 | |||
| 175 | The effect of disabling or deleting a key, or revoking a grant is not | ||
| 176 | immediate. The node resource might take some time to find that the key | ||
| 177 | is inaccessible. When a resource is in this state, we recommend | ||
| 178 | deleting and recreating the resource. | ||
| 179 | |||
| 180 | =back | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | =head2 Tags => L<Paws::ManagedBlockchain::OutputTagMap> | ||
| 185 | |||
| 186 | Tags assigned to the node. Each tag consists of a key and optional | ||
| 187 | value. | ||
| 188 | |||
| 189 | For more information about tags, see Tagging Resources | ||
| 190 | (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) | ||
| 191 | in the I<Amazon Managed Blockchain Ethereum Developer Guide>, or | ||
| 192 | Tagging Resources | ||
| 193 | (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) | ||
| 194 | in the I<Amazon Managed Blockchain Hyperledger Fabric Developer Guide>. | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head1 SEE ALSO | ||
| 199 | |||
| 200 | This class forms part of L<Paws>, describing an object used in L<Paws::ManagedBlockchain> | ||
| 201 | |||
| 202 | =head1 BUGS and CONTRIBUTIONS | ||
| 203 | |||
| 204 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 205 | |||
| 206 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 207 | |||
| 208 | =cut | ||
| 209 |