class Aws::RDS::Types::DBCluster

Contains the details of an Amazon Aurora DB cluster.

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

@!attribute [rw] allocated_storage

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

@!attribute [rw] availability_zones

Provides the list of Availability Zones (AZs) where instances in the
DB cluster can be created.
@return [Array<String>]

@!attribute [rw] backup_retention_period

Specifies the number of days for which automatic DB snapshots are
retained.
@return [Integer]

@!attribute [rw] character_set_name

If present, specifies the name of the character set that this
cluster is associated with.
@return [String]

@!attribute [rw] database_name

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.
@return [String]

@!attribute [rw] db_cluster_identifier

Contains a user-supplied DB cluster identifier. This identifier is
the unique key that identifies a DB cluster.
@return [String]

@!attribute [rw] db_cluster_parameter_group

Specifies the name of the DB cluster parameter group for the DB
cluster.
@return [String]

@!attribute [rw] db_subnet_group

Specifies information on the subnet group associated with the DB
cluster, including the name, description, and subnets in the subnet
group.
@return [String]

@!attribute [rw] status

Specifies the current state of this DB cluster.
@return [String]

@!attribute [rw] automatic_restart_time

The time when a stopped DB cluster is restarted automatically.
@return [Time]

@!attribute [rw] percent_progress

Specifies the progress of the operation as a percentage.
@return [String]

@!attribute [rw] earliest_restorable_time

The earliest time to which a database can be restored with
point-in-time restore.
@return [Time]

@!attribute [rw] endpoint

Specifies the connection endpoint for the primary instance of the DB
cluster.
@return [String]

@!attribute [rw] reader_endpoint

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.
@return [String]

@!attribute [rw] custom_endpoints

Identifies all custom endpoints associated with the cluster.
@return [Array<String>]

@!attribute [rw] multi_az

Specifies whether the DB cluster has instances in multiple
Availability Zones.
@return [Boolean]

@!attribute [rw] engine

The name of the database engine to be used for this DB cluster.
@return [String]

@!attribute [rw] engine_version

Indicates the database engine version.
@return [String]

@!attribute [rw] latest_restorable_time

Specifies the latest time to which a database can be restored with
point-in-time restore.
@return [Time]

@!attribute [rw] port

Specifies the port that the database engine is listening on.
@return [Integer]

@!attribute [rw] master_username

Contains the master username for the DB cluster.
@return [String]

@!attribute [rw] db_cluster_option_group_memberships

Provides the list of option group memberships for this DB cluster.
@return [Array<Types::DBClusterOptionGroupStatus>]

@!attribute [rw] preferred_backup_window

Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
`BackupRetentionPeriod`.
@return [String]

@!attribute [rw] preferred_maintenance_window

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

@!attribute [rw] replication_source_identifier

Contains the identifier of the source DB cluster if this DB cluster
is a read replica.
@return [String]

@!attribute [rw] read_replica_identifiers

Contains one or more identifiers of the read replicas associated
with this DB cluster.
@return [Array<String>]

@!attribute [rw] db_cluster_members

Provides the list of instances that make up the DB cluster.
@return [Array<Types::DBClusterMember>]

@!attribute [rw] vpc_security_groups

Provides a list of VPC security groups that the DB cluster belongs
to.
@return [Array<Types::VpcSecurityGroupMembership>]

@!attribute [rw] hosted_zone_id

Specifies the ID that Amazon Route 53 assigns when you create a
hosted zone.
@return [String]

@!attribute [rw] storage_encrypted

Specifies whether the DB cluster is encrypted.
@return [Boolean]

@!attribute [rw] kms_key_id

If `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).
@return [String]

@!attribute [rw] db_cluster_resource_id

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.
@return [String]

@!attribute [rw] db_cluster_arn

The Amazon Resource Name (ARN) for the DB cluster.
@return [String]

@!attribute [rw] associated_roles

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.
@return [Array<Types::DBClusterRole>]

@!attribute [rw] iam_database_authentication_enabled

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

@!attribute [rw] clone_group_id

Identifies the clone group to which the DB cluster is associated.
@return [String]

@!attribute [rw] cluster_create_time

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

@!attribute [rw] earliest_backtrack_time

The earliest time to which a DB cluster can be backtracked.
@return [Time]

@!attribute [rw] backtrack_window

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

@!attribute [rw] backtrack_consumed_change_records

The number of change records stored for Backtrack.
@return [Integer]

@!attribute [rw] enabled_cloudwatch_logs_exports

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][1] in the
*Amazon Aurora User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html
@return [Array<String>]

@!attribute [rw] capacity

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][1] in the *Amazon Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html
@return [Integer]

@!attribute [rw] engine_mode

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

For more information, see [ CreateDBCluster][1].

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
@return [String]

@!attribute [rw] scaling_configuration_info

Shows the scaling configuration for an Aurora DB cluster in
`serverless` DB engine mode.

For more information, see [Using Amazon Aurora Serverless][1] in the
*Amazon Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html
@return [Types::ScalingConfigurationInfo]

@!attribute [rw] deletion_protection

Indicates if the DB cluster has deletion protection enabled. The
database can't be deleted when deletion protection is enabled.
@return [Boolean]

@!attribute [rw] http_endpoint_enabled

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][1] in the *Amazon Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
@return [Boolean]

@!attribute [rw] activity_stream_mode

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.
@return [String]

@!attribute [rw] activity_stream_status

The status of the database activity stream.
@return [String]

@!attribute [rw] activity_stream_kms_key_id

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).
@return [String]

@!attribute [rw] activity_stream_kinesis_stream_name

The name of the Amazon Kinesis data stream used for the database
activity stream.
@return [String]

@!attribute [rw] copy_tags_to_snapshot

Specifies whether tags are copied from the DB cluster to snapshots
of the DB cluster.
@return [Boolean]

@!attribute [rw] cross_account_clone

Specifies whether the DB cluster is a clone of a DB cluster owned by
a different Amazon Web Services account.
@return [Boolean]

@!attribute [rw] domain_memberships

The Active Directory Domain membership records associated with the
DB cluster.
@return [Array<Types::DomainMembership>]

@!attribute [rw] tag_list

A list of tags. For more information, see [Tagging Amazon RDS
Resources][1] in the *Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
@return [Array<Types::Tag>]

@!attribute [rw] global_write_forwarding_status

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

@!attribute [rw] global_write_forwarding_requested

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
`GlobalWriteForwardingStatus` to confirm that the request has
completed before using the write forwarding feature for this
cluster.
@return [Boolean]

@!attribute [rw] pending_modified_values

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.
@return [Types::ClusterPendingModifiedValues]

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBCluster AWS API Documentation

Constants

SENSITIVE