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