« blib/lib/Paws/DocDB/CreateGlobalClusterResult.pm
↑ Summary
blib/lib/Paws/DocDB/DBClusterMember.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DocDB::DBCluster; | ||
| 3 | use Moose; | ||
| 4 | has AssociatedRoles => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::DBClusterRole]', request_name => 'DBClusterRole', traits => ['NameInRequest']); | ||
| 5 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'AvailabilityZone', traits => ['NameInRequest']); | ||
| 6 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 7 | has ClusterCreateTime => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBClusterArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 10 | has DBClusterMembers => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::DBClusterMember]', request_name => 'DBClusterMember', traits => ['NameInRequest']); | ||
| 11 | has DBClusterParameterGroup => (is => 'ro', isa => 'Str'); | ||
| 12 | has DbClusterResourceId => (is => 'ro', isa => 'Str'); | ||
| 13 | has DBSubnetGroup => (is => 'ro', isa => 'Str'); | ||
| 14 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 15 | has EarliestRestorableTime => (is => 'ro', isa => 'Str'); | ||
| 16 | has EnabledCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 17 | has Endpoint => (is => 'ro', isa => 'Str'); | ||
| 18 | has Engine => (is => 'ro', isa => 'Str'); | ||
| 19 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 20 | has HostedZoneId => (is => 'ro', isa => 'Str'); | ||
| 21 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 22 | has LatestRestorableTime => (is => 'ro', isa => 'Str'); | ||
| 23 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 24 | has MultiAZ => (is => 'ro', isa => 'Bool'); | ||
| 25 | has PercentProgress => (is => 'ro', isa => 'Str'); | ||
| 26 | has Port => (is => 'ro', isa => 'Int'); | ||
| 27 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | ||
| 28 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 29 | has ReaderEndpoint => (is => 'ro', isa => 'Str'); | ||
| 30 | has ReadReplicaIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaIdentifier', traits => ['NameInRequest']); | ||
| 31 | has ReplicationSourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 32 | has Status => (is => 'ro', isa => 'Str'); | ||
| 33 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 34 | has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroupMembership', traits => ['NameInRequest']); | ||
| 35 | |||
| 36 | 1; | ||
| 37 | |||
| 38 | ### main pod documentation begin ### | ||
| 39 | |||
| 40 | =head1 NAME | ||
| 41 | |||
| 42 | Paws::DocDB::DBCluster | ||
| 43 | |||
| 44 | =head1 USAGE | ||
| 45 | |||
| 46 | This class represents one of two things: | ||
| 47 | |||
| 48 | =head3 Arguments in a call to a service | ||
| 49 | |||
| 50 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 51 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 52 | |||
| 53 | As an example, if Att1 is expected to be a Paws::DocDB::DBCluster object: | ||
| 54 | |||
| 55 | $service_obj->Method(Att1 => { AssociatedRoles => $value, ..., VpcSecurityGroups => $value }); | ||
| 56 | |||
| 57 | =head3 Results returned from an API call | ||
| 58 | |||
| 59 | Use accessors for each attribute. If Att1 is expected to be an Paws::DocDB::DBCluster object: | ||
| 60 | |||
| 61 | $result = $service_obj->Method(...); | ||
| 62 | $result->Att1->AssociatedRoles | ||
| 63 | |||
| 64 | =head1 DESCRIPTION | ||
| 65 | |||
| 66 | Detailed information about a cluster. | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 AssociatedRoles => ArrayRef[L<Paws::DocDB::DBClusterRole>] | ||
| 72 | |||
| 73 | Provides a list of the Identity and Access Management (IAM) roles that | ||
| 74 | are associated with the cluster. (IAM) roles that are associated with a | ||
| 75 | cluster grant permission for the cluster to access other Amazon Web | ||
| 76 | Services services on your behalf. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 80 | |||
| 81 | Provides the list of Amazon EC2 Availability Zones that instances in | ||
| 82 | the cluster can be created in. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 BackupRetentionPeriod => Int | ||
| 86 | |||
| 87 | Specifies the number of days for which automatic snapshots are | ||
| 88 | retained. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ClusterCreateTime => Str | ||
| 92 | |||
| 93 | Specifies the time when the cluster was created, in Universal | ||
| 94 | Coordinated Time (UTC). | ||
| 95 | |||
| 96 | |||
| 97 | =head2 DBClusterArn => Str | ||
| 98 | |||
| 99 | The Amazon Resource Name (ARN) for the cluster. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 DBClusterIdentifier => Str | ||
| 103 | |||
| 104 | Contains a user-supplied cluster identifier. This identifier is the | ||
| 105 | unique key that identifies a cluster. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 DBClusterMembers => ArrayRef[L<Paws::DocDB::DBClusterMember>] | ||
| 109 | |||
| 110 | Provides the list of instances that make up the cluster. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 DBClusterParameterGroup => Str | ||
| 114 | |||
| 115 | Specifies the name of the cluster parameter group for the cluster. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 DbClusterResourceId => Str | ||
| 119 | |||
| 120 | The Region-unique, immutable identifier for the cluster. This | ||
| 121 | identifier is found in CloudTrail log entries whenever the KMS key for | ||
| 122 | the cluster is accessed. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 DBSubnetGroup => Str | ||
| 126 | |||
| 127 | Specifies information on the subnet group that is associated with the | ||
| 128 | cluster, including the name, description, and subnets in the subnet | ||
| 129 | group. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 DeletionProtection => Bool | ||
| 133 | |||
| 134 | Specifies whether this cluster can be deleted. If C<DeletionProtection> | ||
| 135 | is enabled, the cluster cannot be deleted unless it is modified and | ||
| 136 | C<DeletionProtection> is disabled. C<DeletionProtection> protects | ||
| 137 | clusters from being accidentally deleted. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 EarliestRestorableTime => Str | ||
| 141 | |||
| 142 | The earliest time to which a database can be restored with | ||
| 143 | point-in-time restore. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 EnabledCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 147 | |||
| 148 | A list of log types that this cluster is configured to export to Amazon | ||
| 149 | CloudWatch Logs. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 Endpoint => Str | ||
| 153 | |||
| 154 | Specifies the connection endpoint for the primary instance of the | ||
| 155 | cluster. | ||
| 156 | |||
| 157 | |||
| 158 | =head2 Engine => Str | ||
| 159 | |||
| 160 | Provides the name of the database engine to be used for this cluster. | ||
| 161 | |||
| 162 | |||
| 163 | =head2 EngineVersion => Str | ||
| 164 | |||
| 165 | Indicates the database engine version. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 HostedZoneId => Str | ||
| 169 | |||
| 170 | Specifies the ID that Amazon Route 53 assigns when you create a hosted | ||
| 171 | zone. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 KmsKeyId => Str | ||
| 175 | |||
| 176 | If C<StorageEncrypted> is C<true>, the KMS key identifier for the | ||
| 177 | encrypted cluster. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 LatestRestorableTime => Str | ||
| 181 | |||
| 182 | Specifies the latest time to which a database can be restored with | ||
| 183 | point-in-time restore. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 MasterUsername => Str | ||
| 187 | |||
| 188 | Contains the master user name for the cluster. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 MultiAZ => Bool | ||
| 192 | |||
| 193 | Specifies whether the cluster has instances in multiple Availability | ||
| 194 | Zones. | ||
| 195 | |||
| 196 | |||
| 197 | =head2 PercentProgress => Str | ||
| 198 | |||
| 199 | Specifies the progress of the operation as a percentage. | ||
| 200 | |||
| 201 | |||
| 202 | =head2 Port => Int | ||
| 203 | |||
| 204 | Specifies the port that the database engine is listening on. | ||
| 205 | |||
| 206 | |||
| 207 | =head2 PreferredBackupWindow => Str | ||
| 208 | |||
| 209 | Specifies the daily time range during which automated backups are | ||
| 210 | created if automated backups are enabled, as determined by the | ||
| 211 | C<BackupRetentionPeriod>. | ||
| 212 | |||
| 213 | |||
| 214 | =head2 PreferredMaintenanceWindow => Str | ||
| 215 | |||
| 216 | Specifies the weekly time range during which system maintenance can | ||
| 217 | occur, in Universal Coordinated Time (UTC). | ||
| 218 | |||
| 219 | |||
| 220 | =head2 ReaderEndpoint => Str | ||
| 221 | |||
| 222 | The reader endpoint for the cluster. The reader endpoint for a cluster | ||
| 223 | load balances connections across the Amazon DocumentDB replicas that | ||
| 224 | are available in a cluster. As clients request new connections to the | ||
| 225 | reader endpoint, Amazon DocumentDB distributes the connection requests | ||
| 226 | among the Amazon DocumentDB replicas in the cluster. This functionality | ||
| 227 | can help balance your read workload across multiple Amazon DocumentDB | ||
| 228 | replicas in your cluster. | ||
| 229 | |||
| 230 | If a failover occurs, and the Amazon DocumentDB replica that you are | ||
| 231 | connected to is promoted to be the primary instance, your connection is | ||
| 232 | dropped. To continue sending your read workload to other Amazon | ||
| 233 | DocumentDB replicas in the cluster, you can then reconnect to the | ||
| 234 | reader endpoint. | ||
| 235 | |||
| 236 | |||
| 237 | =head2 ReadReplicaIdentifiers => ArrayRef[Str|Undef] | ||
| 238 | |||
| 239 | Contains one or more identifiers of the secondary clusters that are | ||
| 240 | associated with this cluster. | ||
| 241 | |||
| 242 | |||
| 243 | =head2 ReplicationSourceIdentifier => Str | ||
| 244 | |||
| 245 | Contains the identifier of the source cluster if this cluster is a | ||
| 246 | secondary cluster. | ||
| 247 | |||
| 248 | |||
| 249 | =head2 Status => Str | ||
| 250 | |||
| 251 | Specifies the current state of this cluster. | ||
| 252 | |||
| 253 | |||
| 254 | =head2 StorageEncrypted => Bool | ||
| 255 | |||
| 256 | Specifies whether the cluster is encrypted. | ||
| 257 | |||
| 258 | |||
| 259 | =head2 VpcSecurityGroups => ArrayRef[L<Paws::DocDB::VpcSecurityGroupMembership>] | ||
| 260 | |||
| 261 | Provides a list of virtual private cloud (VPC) security groups that the | ||
| 262 | cluster belongs to. | ||
| 263 | |||
| 264 | |||
| 265 | |||
| 266 | =head1 SEE ALSO | ||
| 267 | |||
| 268 | This class forms part of L<Paws>, describing an object used in L<Paws::DocDB> | ||
| 269 | |||
| 270 | =head1 BUGS and CONTRIBUTIONS | ||
| 271 | |||
| 272 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 273 | |||
| 274 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 275 | |||
| 276 | =cut | ||
| 277 |