« blib/lib/Paws/ManagedBlockchain/Member.pm
↑ Summary
blib/lib/Paws/ManagedBlockchain/MemberFabricAttributes.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ManagedBlockchain::MemberConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has FrameworkConfiguration => (is => 'ro', isa => 'Paws::ManagedBlockchain::MemberFrameworkConfiguration', required => 1); | ||
| 6 | has KmsKeyArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has LogPublishingConfiguration => (is => 'ro', isa => 'Paws::ManagedBlockchain::MemberLogPublishingConfiguration'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'Paws::ManagedBlockchain::InputTagMap'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::ManagedBlockchain::MemberConfiguration | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::ManagedBlockchain::MemberConfiguration object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Description => $value, ..., Tags => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::ManagedBlockchain::MemberConfiguration object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Description | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Configuration properties of the member. | ||
| 42 | |||
| 43 | Applies only to Hyperledger Fabric. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Description => Str | ||
| 49 | |||
| 50 | An optional description of the member. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> FrameworkConfiguration => L<Paws::ManagedBlockchain::MemberFrameworkConfiguration> | ||
| 54 | |||
| 55 | Configuration properties of the blockchain framework relevant to the | ||
| 56 | member. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 KmsKeyArn => Str | ||
| 60 | |||
| 61 | The Amazon Resource Name (ARN) of the customer managed key in AWS Key | ||
| 62 | Management Service (AWS KMS) to use for encryption at rest in the | ||
| 63 | member. This parameter is inherited by any nodes that this member | ||
| 64 | creates. | ||
| 65 | |||
| 66 | Use one of the following options to specify this parameter: | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | B<Undefined or empty string> - The member uses an AWS owned KMS key for | ||
| 73 | encryption by default. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | B<A valid symmetric customer managed KMS key> - The member uses the | ||
| 78 | specified key for encryption. | ||
| 79 | |||
| 80 | Amazon Managed Blockchain doesn't support asymmetric keys. For more | ||
| 81 | information, see Using symmetric and asymmetric keys | ||
| 82 | (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) | ||
| 83 | in the I<AWS Key Management Service Developer Guide>. | ||
| 84 | |||
| 85 | The following is an example of a KMS key ARN: | ||
| 86 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 LogPublishingConfiguration => L<Paws::ManagedBlockchain::MemberLogPublishingConfiguration> | ||
| 93 | |||
| 94 | Configuration properties for logging events associated with a member of | ||
| 95 | a Managed Blockchain network. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> Name => Str | ||
| 99 | |||
| 100 | The name of the member. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 Tags => L<Paws::ManagedBlockchain::InputTagMap> | ||
| 104 | |||
| 105 | Tags assigned to the member. Tags consist of a key and optional value. | ||
| 106 | For more information about tags, see Tagging Resources | ||
| 107 | (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) | ||
| 108 | in the I<Amazon Managed Blockchain Hyperledger Fabric Developer Guide>. | ||
| 109 | |||
| 110 | When specifying tags during creation, you can specify multiple | ||
| 111 | key-value pairs in a single request, with an overall maximum of 50 tags | ||
| 112 | added to each resource. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, describing an object used in L<Paws::ManagedBlockchain> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |