DBCluster

Gets and sets the property ActivityStreamKinesisStreamName.

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

Gets and sets the property ActivityStreamKmsKeyId.

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 KMS key.

Gets and sets the property ActivityStreamMode.

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.

Gets and sets the property ActivityStreamStatus.

The status of the database activity stream.

Gets and sets the property AllocatedStorage.

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.

Gets and sets the property AssociatedRoles.

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.

Gets and sets the property AutomaticRestartTime.

The time when a stopped DB cluster is restarted automatically.

Gets and sets the property AutoMinorVersionUpgrade.

Indicates whether minor version patches are applied automatically.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property AvailabilityZones.

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

Gets and sets the property AwsBackupRecoveryPointArn.

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Gets and sets the property BacktrackConsumedChangeRecords.

The number of change records stored for Backtrack.

Gets and sets the property BacktrackWindow.

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

Gets and sets the property BackupRetentionPeriod.

The number of days for which automatic DB snapshots are retained.

Gets and sets the property Capacity.

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

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

Gets and sets the property CertificateDetails.

Gets and sets the property CharacterSetName.

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

Gets and sets the property CloneGroupId.

The ID of the clone group with which the DB cluster is associated.

Gets and sets the property ClusterCreateTime.

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

Gets and sets the property CopyTagsToSnapshot.

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

Gets and sets the property CrossAccountClone.

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

Gets and sets the property CustomEndpoints.

The custom endpoints associated with the DB cluster.

Gets and sets the property DatabaseName.

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

Gets and sets the property DBClusterArn.

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

Gets and sets the property DBClusterIdentifier.

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

Gets and sets the property DBClusterInstanceClass.

The name of the compute and memory capacity class of the DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property DBClusterMembers.

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

Gets and sets the property DBClusterOptionGroupMemberships.

The list of option group memberships for this DB cluster.

Gets and sets the property DBClusterParameterGroup.

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

Gets and sets the property DbClusterResourceId.

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 KMS key for the DB cluster is accessed.

Gets and sets the property DBSubnetGroup.

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Gets and sets the property DBSystemId.

Reserved for future use.

Gets and sets the property DeletionProtection.

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

Gets and sets the property DomainMemberships.

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

Gets and sets the property EarliestBacktrackTime.

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

Gets and sets the property EarliestRestorableTime.

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

Gets and sets the property EnabledCloudwatchLogsExports.

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 in the Amazon Aurora User Guide.

Gets and sets the property Endpoint.

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

Gets and sets the property Engine.

The database engine used for this DB cluster.

Gets and sets the property EngineMode.

The DB engine mode of the DB cluster, either provisioned or serverless.

For more information, see CreateDBCluster.

Gets and sets the property EngineVersion.

The version of the database engine.

Gets and sets the property GlobalWriteForwardingRequested.

Indicates whether write forwarding is enabled 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.

Gets and sets the property GlobalWriteForwardingStatus.

The status of write forwarding for a secondary cluster in an Aurora global database.

Gets and sets the property HostedZoneId.

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

Gets and sets the property HttpEndpointEnabled.

Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.

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

For more information, see Using RDS Data API in the Amazon Aurora User Guide.

Gets and sets the property IAMDatabaseAuthenticationEnabled.

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

Gets and sets the property IOOptimizedNextAllowedModificationTime.

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

This setting is only for Aurora DB clusters.

Gets and sets the property Iops.

The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property KmsKeyId.

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 KMS key.

Gets and sets the property LatestRestorableTime.

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

Gets and sets the property LimitlessDatabase.

The details for Aurora Limitless Database.

Gets and sets the property LocalWriteForwardingStatus.

Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

Gets and sets the property MasterUsername.

The master username for the DB cluster.

Gets and sets the property MasterUserSecret.

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Gets and sets the property MonitoringInterval.

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property MonitoringRoleArn.

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property MultiAZ.

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

Gets and sets the property NetworkType.

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

This setting is only for Aurora DB clusters.

Valid Values: IPV4 | DUAL

Gets and sets the property PendingModifiedValues.

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

Gets and sets the property PercentProgress.

The progress of the operation as a percentage.

Gets and sets the property PerformanceInsightsEnabled.

Indicates whether Performance Insights is enabled for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property PerformanceInsightsKMSKeyId.

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property PerformanceInsightsRetentionPeriod.

The number of days to retain Performance Insights data.

This setting is only for non-Aurora Multi-AZ DB clusters.

Valid Values:

• 7

• month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

• 731

Default: 7 days

Gets and sets the property Port.

The port that the database engine is listening on.

Gets and sets the property PreferredBackupWindow.

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Gets and sets the property PreferredMaintenanceWindow.

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

Gets and sets the property PubliclyAccessible.

Indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

For more information, see CreateDBCluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property RdsCustomClusterConfiguration.

Reserved for future use.

Gets and sets the property ReaderEndpoint.

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.

Gets and sets the property ReadReplicaIdentifiers.

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

Gets and sets the property ReplicationSourceIdentifier.

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

Gets and sets the property ScalingConfigurationInfo.

Gets and sets the property ServerlessV2ScalingConfiguration.

Gets and sets the property Status.

The current state of this DB cluster.

Gets and sets the property StatusInfos.

Reserved for future use.

Gets and sets the property StorageEncrypted.

Indicates whether the DB cluster is encrypted.

Gets and sets the property StorageThroughput.

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

Gets and sets the property StorageType.

The storage type associated with the DB cluster.

Gets and sets the property TagList.

Gets and sets the property VpcSecurityGroups.

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