NAME
Paws::RDS::DBCluster
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::RDS::DBCluster object:
$service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcSecurityGroups => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBCluster object:
$result = $service_obj->Method(...);
$result->Att1->AllocatedStorageDESCRIPTION
Contains the result of a successful invocation of the following actions:
CreateDBCluster
DeleteDBCluster
FailoverDBCluster
ModifyDBCluster
RestoreDBClusterFromSnapshot
RestoreDBClusterToPointInTime
This data type is used as a response element in the DescribeDBClusters action.
ATTRIBUTES
AllocatedStorage => Int
For all database engines except Amazon Aurora, C<AllocatedStorage>
specifies the allocated storage size in gigabytes (GB). For Aurora,
C<AllocatedStorage> always returns 1, because Aurora DB cluster storage
size is not fixed, but instead automatically adjusts as needed.AssociatedRoles => ArrayRef[Paws::RDS::DBClusterRole]
Provides a list of the AWS Identity and Access Management (IAM) roles
that are associated with the DB cluster. IAM roles that are associated
with a DB cluster grant permission for the DB cluster to access other
AWS services on your behalf.AvailabilityZones => ArrayRef[Str|Undef]
Provides the list of EC2 Availability Zones that instances in the DB
cluster can be created in.BackupRetentionPeriod => Int
Specifies the number of days for which automatic DB snapshots are
retained.CharacterSetName => Str
If present, specifies the name of the character set that this cluster
is associated with.CloneGroupId => Str
Identifies the clone group to which the DB cluster is associated.ClusterCreateTime => Str
Specifies the time when the DB cluster was created, in Universal
Coordinated Time (UTC).DatabaseName => Str
Contains the name of the initial database of this DB cluster that was
provided at create time, if one was specified when the DB cluster was
created. This same name is returned for the life of the DB cluster.DBClusterArn => Str
The Amazon Resource Name (ARN) for the DB cluster.DBClusterIdentifier => Str
Contains a user-supplied DB cluster identifier. This identifier is the
unique key that identifies a DB cluster.DBClusterMembers => ArrayRef[Paws::RDS::DBClusterMember]
Provides the list of instances that make up the DB cluster.DBClusterOptionGroupMemberships => ArrayRef[Paws::RDS::DBClusterOptionGroupStatus]
Provides the list of option group memberships for this DB cluster.DBClusterParameterGroup => Str
Specifies the name of the DB cluster parameter group for the DB
cluster.DbClusterResourceId => Str
The region-unique, immutable identifier for the DB cluster. This
identifier is found in AWS CloudTrail log entries whenever the KMS key
for the DB cluster is accessed.DBSubnetGroup => Str
Specifies information on the subnet group associated with the DB
cluster, including the name, description, and subnets in the subnet
group.EarliestRestorableTime => Str
Specifies the earliest time to which a database can be restored with
point-in-time restore.Endpoint => Str
Specifies the connection endpoint for the primary instance of the DB
cluster.Engine => Str
Provides the name of the database engine to be used for this DB
cluster.EngineVersion => Str
Indicates the database engine version.HostedZoneId => Str
Specifies the ID that Amazon Route 53 assigns when you create a hosted
zone.IAMDatabaseAuthenticationEnabled => Bool
True if mapping of AWS Identity and Access Management (IAM) accounts to
database accounts is enabled; otherwise false.KmsKeyId => Str
If C<StorageEncrypted> is true, the KMS key identifier for the
encrypted DB cluster.LatestRestorableTime => Str
Specifies the latest time to which a database can be restored with
point-in-time restore.MasterUsername => Str
Contains the master username for the DB cluster.MultiAZ => Bool
Specifies whether the DB cluster has instances in multiple Availability
Zones.PercentProgress => Str
Specifies the progress of the operation as a percentage.Port => Int
Specifies the port that the database engine is listening on.PreferredBackupWindow => Str
Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
C<BackupRetentionPeriod>.PreferredMaintenanceWindow => Str
Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).ReaderEndpoint => Str
The reader endpoint for the DB cluster. The reader endpoint for a DB
cluster load-balances connections across the Aurora Replicas that are
available in a DB cluster. As clients request new connections to the
reader endpoint, Aurora distributes the connection requests among the
Aurora Replicas in the DB cluster. This functionality can help balance
your read workload across multiple Aurora Replicas in your DB cluster.If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
ReadReplicaIdentifiers => ArrayRef[Str|Undef]
Contains one or more identifiers of the Read Replicas associated with
this DB cluster.ReplicationSourceIdentifier => Str
Contains the identifier of the source DB cluster if this DB cluster is
a Read Replica.Status => Str
Specifies the current state of this DB cluster.StorageEncrypted => Bool
Specifies whether the DB cluster is encrypted.VpcSecurityGroups => ArrayRef[Paws::RDS::VpcSecurityGroupMembership]
Provides a list of VPC security groups that the DB cluster belongs to.SEE ALSO
This class forms part of Paws, describing an object used in Paws::RDS
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues