NAME

Paws::DocDB::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::DocDB::DBCluster object:

  $service_obj->Method(Att1 => { AssociatedRoles => $value, ..., VpcSecurityGroups => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::DocDB::DBCluster object:

  $result = $service_obj->Method(...);
  $result->Att1->AssociatedRoles

DESCRIPTION

Detailed information about a cluster.

ATTRIBUTES

AssociatedRoles => ArrayRef[Paws::DocDB::DBClusterRole]

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

AvailabilityZones => ArrayRef[Str|Undef]

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

BackupRetentionPeriod => Int

Specifies the number of days for which automatic snapshots are retained.

ClusterCreateTime => Str

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

DBClusterArn => Str

The Amazon Resource Name (ARN) for the cluster.

DBClusterIdentifier => Str

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

DBClusterMembers => ArrayRef[Paws::DocDB::DBClusterMember]

Provides the list of instances that make up the cluster.

DBClusterParameterGroup => Str

Specifies the name of the cluster parameter group for the cluster.

DbClusterResourceId => Str

The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

DBSubnetGroup => Str

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

DeletionProtection => Bool

Specifies whether this cluster can be deleted. If "DeletionProtection" is enabled, the cluster cannot be deleted unless it is modified and "DeletionProtection" is disabled. "DeletionProtection" protects clusters from being accidentally deleted.

EarliestRestorableTime => Str

The earliest time to which a database can be restored with point-in-time restore.

EnabledCloudwatchLogsExports => ArrayRef[Str|Undef]

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

Endpoint => Str

Specifies the connection endpoint for the primary instance of the cluster.

Engine => Str

Provides the name of the database engine to be used for this cluster.

EngineVersion => Str

Indicates the database engine version.

HostedZoneId => Str

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

KmsKeyId => Str

If "StorageEncrypted" is "true", the KMS key identifier for the encrypted cluster.

LatestRestorableTime => Str

Specifies the latest time to which a database can be restored with point-in-time restore.

MasterUsername => Str

Contains the master user name for the cluster.

MultiAZ => Bool

Specifies whether the 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 "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 cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

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>