| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DocDB::GlobalCluster; | ||
| 3 | use Moose; | ||
| 4 | has DatabaseName => (is => 'ro', isa => 'Str'); | ||
| 5 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Engine => (is => 'ro', isa => 'Str'); | ||
| 7 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 8 | has GlobalClusterArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has GlobalClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 10 | has GlobalClusterMembers => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::GlobalClusterMember]', request_name => 'GlobalClusterMember', traits => ['NameInRequest']); | ||
| 11 | has GlobalClusterResourceId => (is => 'ro', isa => 'Str'); | ||
| 12 | has Status => (is => 'ro', isa => 'Str'); | ||
| 13 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::DocDB::GlobalCluster | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::DocDB::GlobalCluster object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { DatabaseName => $value, ..., StorageEncrypted => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::DocDB::GlobalCluster object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->DatabaseName | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | A data type representing an Amazon DocumentDB global cluster. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 DatabaseName => Str | ||
| 51 | |||
| 52 | The default database name within the new global cluster. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 DeletionProtection => Bool | ||
| 56 | |||
| 57 | The deletion protection setting for the new global cluster. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Engine => Str | ||
| 61 | |||
| 62 | The Amazon DocumentDB database engine used by the global cluster. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 EngineVersion => Str | ||
| 66 | |||
| 67 | Indicates the database engine version. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 GlobalClusterArn => Str | ||
| 71 | |||
| 72 | The Amazon Resource Name (ARN) for the global cluster. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 GlobalClusterIdentifier => Str | ||
| 76 | |||
| 77 | Contains a user-supplied global cluster identifier. This identifier is | ||
| 78 | the unique key that identifies a global cluster. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 GlobalClusterMembers => ArrayRef[L<Paws::DocDB::GlobalClusterMember>] | ||
| 82 | |||
| 83 | The list of cluster IDs for secondary clusters within the global | ||
| 84 | cluster. Currently limited to one item. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 GlobalClusterResourceId => Str | ||
| 88 | |||
| 89 | The Region-unique, immutable identifier for the global database | ||
| 90 | cluster. This identifier is found in AWS CloudTrail log entries | ||
| 91 | whenever the AWS KMS customer master key (CMK) for the cluster is | ||
| 92 | accessed. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 Status => Str | ||
| 96 | |||
| 97 | Specifies the current state of this global cluster. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 StorageEncrypted => Bool | ||
| 101 | |||
| 102 | The storage encryption setting for the global cluster. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::DocDB> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |