
# Generated by default/object.tt
package Paws::RDS::DBCluster;
  use Moose;
  has ActivityStreamKinesisStreamName => (is => 'ro', isa => 'Str');
  has ActivityStreamKmsKeyId => (is => 'ro', isa => 'Str');
  has ActivityStreamMode => (is => 'ro', isa => 'Str');
  has ActivityStreamStatus => (is => 'ro', isa => 'Str');
  has AllocatedStorage => (is => 'ro', isa => 'Int');
  has AssociatedRoles => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBClusterRole]', request_name => 'DBClusterRole', traits => ['NameInRequest']);
  has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'AvailabilityZone', traits => ['NameInRequest']);
  has BacktrackConsumedChangeRecords => (is => 'ro', isa => 'Int');
  has BacktrackWindow => (is => 'ro', isa => 'Int');
  has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
  has Capacity => (is => 'ro', isa => 'Int');
  has CharacterSetName => (is => 'ro', isa => 'Str');
  has CloneGroupId => (is => 'ro', isa => 'Str');
  has ClusterCreateTime => (is => 'ro', isa => 'Str');
  has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
  has CrossAccountClone => (is => 'ro', isa => 'Bool');
  has CustomEndpoints => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
  has DatabaseName => (is => 'ro', isa => 'Str');
  has DBClusterArn => (is => 'ro', isa => 'Str');
  has DBClusterIdentifier => (is => 'ro', isa => 'Str');
  has DBClusterMembers => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBClusterMember]', request_name => 'DBClusterMember', traits => ['NameInRequest']);
  has DBClusterOptionGroupMemberships => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBClusterOptionGroupStatus]', request_name => 'DBClusterOptionGroup', traits => ['NameInRequest']);
  has DBClusterParameterGroup => (is => 'ro', isa => 'Str');
  has DbClusterResourceId => (is => 'ro', isa => 'Str');
  has DBSubnetGroup => (is => 'ro', isa => 'Str');
  has DeletionProtection => (is => 'ro', isa => 'Bool');
  has DomainMemberships => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DomainMembership]', request_name => 'DomainMembership', traits => ['NameInRequest']);
  has EarliestBacktrackTime => (is => 'ro', isa => 'Str');
  has EarliestRestorableTime => (is => 'ro', isa => 'Str');
  has EnabledCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
  has Endpoint => (is => 'ro', isa => 'Str');
  has Engine => (is => 'ro', isa => 'Str');
  has EngineMode => (is => 'ro', isa => 'Str');
  has EngineVersion => (is => 'ro', isa => 'Str');
  has GlobalWriteForwardingRequested => (is => 'ro', isa => 'Bool');
  has GlobalWriteForwardingStatus => (is => 'ro', isa => 'Str');
  has HostedZoneId => (is => 'ro', isa => 'Str');
  has HttpEndpointEnabled => (is => 'ro', isa => 'Bool');
  has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool');
  has KmsKeyId => (is => 'ro', isa => 'Str');
  has LatestRestorableTime => (is => 'ro', isa => 'Str');
  has MasterUsername => (is => 'ro', isa => 'Str');
  has MultiAZ => (is => 'ro', isa => 'Bool');
  has PendingModifiedValues => (is => 'ro', isa => 'Paws::RDS::ClusterPendingModifiedValues');
  has PercentProgress => (is => 'ro', isa => 'Str');
  has Port => (is => 'ro', isa => 'Int');
  has PreferredBackupWindow => (is => 'ro', isa => 'Str');
  has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
  has ReaderEndpoint => (is => 'ro', isa => 'Str');
  has ReadReplicaIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaIdentifier', traits => ['NameInRequest']);
  has ReplicationSourceIdentifier => (is => 'ro', isa => 'Str');
  has ScalingConfigurationInfo => (is => 'ro', isa => 'Paws::RDS::ScalingConfigurationInfo');
  has Status => (is => 'ro', isa => 'Str');
  has StorageEncrypted => (is => 'ro', isa => 'Bool');
  has TagList => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]', request_name => 'Tag', traits => ['NameInRequest']);
  has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RDS::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroupMembership', traits => ['NameInRequest']);

1;

### main pod documentation begin ###

=head1 NAME

Paws::RDS::DBCluster

=head1 USAGE

This class represents one of two things:

=head3 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 => { ActivityStreamKinesisStreamName => $value, ..., VpcSecurityGroups => $value  });

=head3 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->ActivityStreamKinesisStreamName

=head1 DESCRIPTION

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the
C<DescribeDBClusters>, C<StopDBCluster>, and C<StartDBCluster> actions.

=head1 ATTRIBUTES


=head2 ActivityStreamKinesisStreamName => Str

The name of the Amazon Kinesis data stream used for the database
activity stream.


=head2 ActivityStreamKmsKeyId => Str

The Amazon Web Services KMS key identifier used for encrypting messages
in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS customer
master key (CMK).


=head2 ActivityStreamMode => Str

The mode of the database activity stream. Database events such as a
change or access generate an activity stream event. The database
session can handle these events either synchronously or asynchronously.


=head2 ActivityStreamStatus => Str

The status of the database activity stream.


=head2 AllocatedStorage => Int

For all database engines except Amazon Aurora, C<AllocatedStorage>
specifies the allocated storage size in gibibytes (GiB). For Aurora,
C<AllocatedStorage> always returns 1, because Aurora DB cluster storage
size isn't fixed, but instead automatically adjusts as needed.


=head2 AssociatedRoles => ArrayRef[L<Paws::RDS::DBClusterRole>]

Provides a list of the Amazon Web Services 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 Amazon Web Services on your behalf.


=head2 AvailabilityZones => ArrayRef[Str|Undef]

Provides the list of Availability Zones (AZs) where instances in the DB
cluster can be created.


=head2 BacktrackConsumedChangeRecords => Int

The number of change records stored for Backtrack.


=head2 BacktrackWindow => Int

The target backtrack window, in seconds. If this value is set to 0,
backtracking is disabled for the DB cluster. Otherwise, backtracking is
enabled.


=head2 BackupRetentionPeriod => Int

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


=head2 Capacity => Int

The current capacity of an Aurora Serverless DB cluster. The capacity
is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora
Serverless
(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
in the I<Amazon Aurora User Guide>.


=head2 CharacterSetName => Str

If present, specifies the name of the character set that this cluster
is associated with.


=head2 CloneGroupId => Str

Identifies the clone group to which the DB cluster is associated.


=head2 ClusterCreateTime => Str

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


=head2 CopyTagsToSnapshot => Bool

Specifies whether tags are copied from the DB cluster to snapshots of
the DB cluster.


=head2 CrossAccountClone => Bool

Specifies whether the DB cluster is a clone of a DB cluster owned by a
different Amazon Web Services account.


=head2 CustomEndpoints => ArrayRef[Str|Undef]

Identifies all custom endpoints associated with the cluster.


=head2 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.


=head2 DBClusterArn => Str

The Amazon Resource Name (ARN) for the DB cluster.


=head2 DBClusterIdentifier => Str

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


=head2 DBClusterMembers => ArrayRef[L<Paws::RDS::DBClusterMember>]

Provides the list of instances that make up the DB cluster.


=head2 DBClusterOptionGroupMemberships => ArrayRef[L<Paws::RDS::DBClusterOptionGroupStatus>]

Provides the list of option group memberships for this DB cluster.


=head2 DBClusterParameterGroup => Str

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


=head2 DbClusterResourceId => Str

The Amazon Web Services Region-unique, immutable identifier for the DB
cluster. This identifier is found in Amazon Web Services CloudTrail log
entries whenever the Amazon Web Services KMS CMK for the DB cluster is
accessed.


=head2 DBSubnetGroup => Str

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


=head2 DeletionProtection => Bool

Indicates if the DB cluster has deletion protection enabled. The
database can't be deleted when deletion protection is enabled.


=head2 DomainMemberships => ArrayRef[L<Paws::RDS::DomainMembership>]

The Active Directory Domain membership records associated with the DB
cluster.


=head2 EarliestBacktrackTime => Str

The earliest time to which a DB cluster can be backtracked.


=head2 EarliestRestorableTime => Str

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


=head2 EnabledCloudwatchLogsExports => ArrayRef[Str|Undef]

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

Log types vary by DB engine. For information about the log types for
each DB engine, see Amazon RDS Database Log Files
(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html)
in the I<Amazon Aurora User Guide.>


=head2 Endpoint => Str

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


=head2 Engine => Str

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


=head2 EngineMode => Str

The DB engine mode of the DB cluster, either C<provisioned>,
C<serverless>, C<parallelquery>, C<global>, or C<multimaster>.

For more information, see CreateDBCluster
(https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html).


=head2 EngineVersion => Str

Indicates the database engine version.


=head2 GlobalWriteForwardingRequested => Bool

Specifies whether you have requested to enable write forwarding for a
secondary cluster in an Aurora global database. Because write
forwarding takes time to enable, check the value of
C<GlobalWriteForwardingStatus> to confirm that the request has
completed before using the write forwarding feature for this cluster.


=head2 GlobalWriteForwardingStatus => Str

Specifies whether a secondary cluster in an Aurora global database has
write forwarding enabled, not enabled, or is in the process of enabling
it.


=head2 HostedZoneId => Str

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


=head2 HttpEndpointEnabled => Bool

A value that indicates whether the HTTP endpoint for an Aurora
Serverless DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service
API for running SQL queries on the Aurora Serverless DB cluster. You
can also query your database from inside the RDS console with the query
editor.

For more information, see Using the Data API for Aurora Serverless
(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
in the I<Amazon Aurora User Guide>.


=head2 IAMDatabaseAuthenticationEnabled => Bool

A value that indicates whether the mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts is
enabled.


=head2 KmsKeyId => Str

If C<StorageEncrypted> is enabled, the Amazon Web Services KMS key
identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS customer
master key (CMK).


=head2 LatestRestorableTime => Str

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


=head2 MasterUsername => Str

Contains the master username for the DB cluster.


=head2 MultiAZ => Bool

Specifies whether the DB cluster has instances in multiple Availability
Zones.


=head2 PendingModifiedValues => L<Paws::RDS::ClusterPendingModifiedValues>

A value that specifies that changes to the DB cluster are pending. This
element is only included when changes are pending. Specific changes are
identified by subelements.


=head2 PercentProgress => Str

Specifies the progress of the operation as a percentage.


=head2 Port => Int

Specifies the port that the database engine is listening on.


=head2 PreferredBackupWindow => Str

Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
C<BackupRetentionPeriod>.


=head2 PreferredMaintenanceWindow => Str

Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).


=head2 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 is dropped. To
continue sending your read workload to other Aurora Replicas in the
cluster, you can then reconnect to the reader endpoint.


=head2 ReadReplicaIdentifiers => ArrayRef[Str|Undef]

Contains one or more identifiers of the read replicas associated with
this DB cluster.


=head2 ReplicationSourceIdentifier => Str

Contains the identifier of the source DB cluster if this DB cluster is
a read replica.


=head2 ScalingConfigurationInfo => L<Paws::RDS::ScalingConfigurationInfo>


=head2 Status => Str

Specifies the current state of this DB cluster.


=head2 StorageEncrypted => Bool

Specifies whether the DB cluster is encrypted.


=head2 TagList => ArrayRef[L<Paws::RDS::Tag>]


=head2 VpcSecurityGroups => ArrayRef[L<Paws::RDS::VpcSecurityGroupMembership>]

Provides a list of VPC security groups that the DB cluster belongs to.


=head1 SEE ALSO

This class forms part of L<Paws>, describing an object used in L<Paws::RDS>

=head1 BUGS and CONTRIBUTIONS

The source code is located here: L<https://github.com/pplu/aws-sdk-perl>

Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>

=cut