Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime
for up to BackupRetentionPeriod
days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
Note
For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance
action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after the RestoreDBClusterToPointInTime
action has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Note
The Multi-AZ DB clusters feature is in preview and is subject to change.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
restore-db-cluster-to-point-in-time
--db-cluster-identifier <value>
[--restore-type <value>]
--source-db-cluster-identifier <value>
[--restore-to-time <value>]
[--use-latest-restorable-time | --no-use-latest-restorable-time]
[--port <value>]
[--db-subnet-group-name <value>]
[--option-group-name <value>]
[--vpc-security-group-ids <value>]
[--tags <value>]
[--kms-key-id <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--backtrack-window <value>]
[--enable-cloudwatch-logs-exports <value>]
[--db-cluster-parameter-group-name <value>]
[--deletion-protection | --no-deletion-protection]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--domain <value>]
[--domain-iam-role-name <value>]
[--scaling-configuration <value>]
[--engine-mode <value>]
[--db-cluster-instance-class <value>]
[--storage-type <value>]
[--publicly-accessible | --no-publicly-accessible]
[--iops <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--db-cluster-identifier
(string)
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can’t end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
--restore-type
(string)
The type of restore to be performed. You can specify one of the following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.Constraints: You can’t specify
copy-on-write
if the engine version of the source DB cluster is earlier than 1.11.If you don’t specify a
RestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.Valid for: Aurora DB clusters and Multi-AZ DB clusters
--source-db-cluster-identifier
(string)
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
--restore-to-time
(timestamp)
The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if
UseLatestRestorableTime
parameter isn’t providedCan’t be specified if the
UseLatestRestorableTime
parameter is enabledCan’t be specified if the
RestoreType
parameter iscopy-on-write
Example:
2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
--use-latest-restorable-time
| --no-use-latest-restorable-time
(boolean)
A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn’t restored to the latest restorable backup time.
Constraints: Can’t be specified if
RestoreToTime
parameter is provided.Valid for: Aurora DB clusters and Multi-AZ DB clusters
--port
(integer)
The port number on which the new DB cluster accepts connections.
Constraints: A value from
1150-65535
.Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
--db-subnet-group-name
(string)
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
--option-group-name
(string)
The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can’t be modified.
--vpc-security-group-ids
(list)
A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
(string)
Syntax:
"string" "string" ...
--tags
(list)
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(structure)
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key -> (string)
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).Value -> (string)
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--kms-key-id
(string)
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an 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. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyId
parameter.If you don’t specify a value for the
KmsKeyId
parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn’t encrypted, then the restored DB cluster isn’t encrypted.
If
DBClusterIdentifier
refers to a DB cluster that isn’t encrypted, then the restore request is rejected.Valid for: Aurora DB clusters and Multi-AZ DB clusters
--enable-iam-database-authentication
| --no-enable-iam-database-authentication
(boolean)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
--backtrack-window
(long)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
--enable-cloudwatch-logs-exports
(list)
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
(string)
Syntax:
"string" "string" ...
--db-cluster-parameter-group-name
(string)
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can’t end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
--deletion-protection
| --no-deletion-protection
(boolean)
A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
--copy-tags-to-snapshot
| --no-copy-tags-to-snapshot
(boolean)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters only
--domain
(string)
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
--domain-iam-role-name
(string)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
--scaling-configuration
(structure)
For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
MinCapacity -> (integer)
The minimum capacity for an Aurora DB cluster in
serverless
DB engine mode.For Aurora MySQL, valid capacity values are
1
,2
,4
,8
,16
,32
,64
,128
, and256
.For Aurora PostgreSQL, valid capacity values are
2
,4
,8
,16
,32
,64
,192
, and384
.The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity -> (integer)
The maximum capacity for an Aurora DB cluster in
serverless
DB engine mode.For Aurora MySQL, valid capacity values are
1
,2
,4
,8
,16
,32
,64
,128
, and256
.For Aurora PostgreSQL, valid capacity values are
2
,4
,8
,16
,32
,64
,192
, and384
.The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause -> (boolean)
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in
serverless
DB engine mode. A DB cluster can be paused only when it’s idle (it has no connections).Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
SecondsUntilAutoPause -> (integer)
The time, in seconds, before an Aurora DB cluster in
serverless
mode is paused.Specify a value between 300 and 86,400 seconds.
TimeoutAction -> (string)
The action to take when the timeout is reached, either
ForceApplyCapacityChange
orRollbackCapacityChange
.
ForceApplyCapacityChange
sets the capacity to the specified value as soon as possible.
RollbackCapacityChange
, the default, ignores the capacity change if a scaling point isn’t found in the timeout period.Warning
If you specify
ForceApplyCapacityChange
, connections that prevent Aurora Serverless from finding a scaling point might be dropped.For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide .
SecondsBeforeTimeout -> (integer)
The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
Shorthand Syntax:
MinCapacity=integer,MaxCapacity=integer,AutoPause=boolean,SecondsUntilAutoPause=integer,TimeoutAction=string,SecondsBeforeTimeout=integer
JSON Syntax:
{
"MinCapacity": integer,
"MaxCapacity": integer,
"AutoPause": true|false,
"SecondsUntilAutoPause": integer,
"TimeoutAction": "string",
"SecondsBeforeTimeout": integer
}
--engine-mode
(string)
The engine mode of the new cluster. Specify
provisioned
orserverless
, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.Valid for: Aurora DB clusters only
--db-cluster-instance-class
(string)
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
--storage-type
(string)
Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values:
io1
When specified, a value for the
Iops
parameter is required.Default:
io1
Valid for: Multi-AZ DB clusters only
--publicly-accessible
| --no-publicly-accessible
(boolean)
A value that 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 is not 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.
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn’t specified, andPubliclyAccessible
isn’t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If
DBSubnetGroupName
is specified, andPubliclyAccessible
isn’t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
--iops
(integer)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid
Iops
values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide .Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To restore a DB cluster to a specified time
The following restore-db-cluster-to-point-in-time
example restores the DB cluster named database-4
to the latest possible time. Using copy-on-write
as the restore type restores the new DB cluster as a clone of the source DB cluster.
aws rds restore-db-cluster-to-point-in-time \
--source-db-cluster-identifier database-4 \
--db-cluster-identifier sample-cluster-clone \
--restore-type copy-on-write \
--use-latest-restorable-time
Output:
{
"DBCluster": {
"AllocatedStorage": 1,
"AvailabilityZones": [
"us-west-2c",
"us-west-2a",
"us-west-2b"
],
"BackupRetentionPeriod": 7,
"DatabaseName": "",
"DBClusterIdentifier": "sample-cluster-clone",
"DBClusterParameterGroup": "default.aurora-postgresql10",
"DBSubnetGroup": "default",
"Status": "creating",
"Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com",
"ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com",
"MultiAZ": false,
"Engine": "aurora-postgresql",
"EngineVersion": "10.7",
"Port": 5432,
"MasterUsername": "postgres",
"PreferredBackupWindow": "09:33-10:03",
"PreferredMaintenanceWindow": "sun:12:22-sun:12:52",
"ReadReplicaIdentifiers": [],
"DBClusterMembers": [],
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-########",
"Status": "active"
}
],
"HostedZoneId": "Z1PVIF0EXAMPLE",
"StorageEncrypted": true,
"KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6",
"DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE",
"DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone",
"AssociatedRoles": [],
"IAMDatabaseAuthenticationEnabled": false,
"CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd",
"ClusterCreateTime": "2020-03-10T19:57:38.967Z",
"EngineMode": "provisioned",
"DeletionProtection": false,
"HttpEndpointEnabled": false,
"CopyTagsToSnapshot": false,
"CrossAccountClone": false
}
}
For more information, see Restoring a DB Cluster to a Specified Time in the Amazon Aurora User Guide.
DBCluster -> (structure)
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Note
The Multi-AZ DB clusters feature is in preview and is subject to change.
AllocatedStorage -> (integer)
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.AvailabilityZones -> (list)
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
(string)
BackupRetentionPeriod -> (integer)
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName -> (string)
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName -> (string)
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.
DBClusterIdentifier -> (string)
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup -> (string)
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup -> (string)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status -> (string)
Specifies the current state of this DB cluster.
AutomaticRestartTime -> (timestamp)
The time when a stopped DB cluster is restarted automatically.
PercentProgress -> (string)
Specifies the progress of the operation as a percentage.
EarliestRestorableTime -> (timestamp)
The earliest time to which a database can be restored with point-in-time restore.
Endpoint -> (string)
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint -> (string)
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.
CustomEndpoints -> (list)
Identifies all custom endpoints associated with the cluster.
(string)
MultiAZ -> (boolean)
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine -> (string)
The name of the database engine to be used for this DB cluster.
EngineVersion -> (string)
Indicates the database engine version.
LatestRestorableTime -> (timestamp)
Specifies the latest time to which a database can be restored with point-in-time restore.
Port -> (integer)
Specifies the port that the database engine is listening on.
MasterUsername -> (string)
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships -> (list)
Provides the list of option group memberships for this DB cluster.
(structure)
Contains status information for a DB cluster option group.
DBClusterOptionGroupName -> (string)
Specifies the name of the DB cluster option group.
Status -> (string)
Specifies the status of the DB cluster option group.
PreferredBackupWindow -> (string)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.PreferredMaintenanceWindow -> (string)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier -> (string)
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers -> (list)
Contains one or more identifiers of the read replicas associated with this DB cluster.
(string)
DBClusterMembers -> (list)
Provides the list of instances that make up the DB cluster.
(structure)
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier -> (string)
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter -> (boolean)
Value that is
true
if the cluster member is the primary instance for the DB cluster andfalse
otherwise.DBClusterParameterGroupStatus -> (string)
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier -> (integer)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups -> (list)
Provides a list of VPC security groups that the DB cluster belongs to.
(structure)
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId -> (string)
The name of the VPC security group.
Status -> (string)
The status of the VPC security group.
HostedZoneId -> (string)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted -> (boolean)
Specifies whether the DB cluster is encrypted.
KmsKeyId -> (string)
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.
DbClusterResourceId -> (string)
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.
DBClusterArn -> (string)
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles -> (list)
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.
(structure)
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status -> (string)
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE
- the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
PENDING
- the IAM role ARN is being associated with the DB cluster.
INVALID
- the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName -> (string)
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled -> (boolean)
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId -> (string)
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime -> (timestamp)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime -> (timestamp)
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow -> (long)
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords -> (long)
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports -> (list)
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.
(string)
Capacity -> (integer)
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 in the Amazon Aurora User Guide .
EngineMode -> (string)
The DB engine mode of the DB cluster, either
provisioned
,serverless
,parallelquery
,global
, ormultimaster
.For more information, see CreateDBCluster .
ScalingConfigurationInfo -> (structure)
Shows the scaling configuration for an Aurora DB cluster in
serverless
DB engine mode.For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity -> (integer)
The maximum capacity for the Aurora DB cluster in
serverless
DB engine mode.MaxCapacity -> (integer)
The maximum capacity for an Aurora DB cluster in
serverless
DB engine mode.AutoPause -> (boolean)
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in
serverless
DB engine mode.When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause -> (integer)
The remaining amount of time, in seconds, before the Aurora DB cluster in
serverless
mode is paused. A DB cluster can be paused only when it’s idle (it has no connections).TimeoutAction -> (string)
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless cluster. The value is either
ForceApplyCapacityChange
orRollbackCapacityChange
.
ForceApplyCapacityChange
, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange
ignores the capacity change if a scaling point isn’t found in the timeout period.SecondsBeforeTimeout -> (integer)
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the
TimeoutAction
setting.DeletionProtection -> (boolean)
Indicates if the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.
HttpEndpointEnabled -> (boolean)
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 in the Amazon Aurora User Guide .
ActivityStreamMode -> (string)
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.
ActivityStreamStatus -> (string)
The status of the database activity stream.
ActivityStreamKmsKeyId -> (string)
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.
ActivityStreamKinesisStreamName -> (string)
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot -> (boolean)
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone -> (boolean)
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships -> (list)
The Active Directory Domain membership records associated with the DB cluster.
(structure)
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain -> (string)
The identifier of the Active Directory Domain.
Status -> (string)
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN -> (string)
The fully qualified domain name of the Active Directory Domain.
IAMRoleName -> (string)
The name of the IAM role to be used when making API calls to the Directory Service.
TagList -> (list)
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(structure)
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key -> (string)
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).Value -> (string)
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).GlobalWriteForwardingStatus -> (string)
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested -> (boolean)
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.PendingModifiedValues -> (structure)
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.
PendingCloudwatchLogsExports -> (structure)
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable -> (list)
Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.
(string)
LogTypesToDisable -> (list)
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
(string)
DBClusterIdentifier -> (string)
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword -> (string)
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled -> (boolean)
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion -> (string)
The database engine version.
DBClusterInstanceClass -> (string)
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType -> (string)
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops -> (integer)
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible -> (boolean)
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance’s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn’t permit it.
When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade -> (boolean)
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval -> (integer)
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.
MonitoringRoleArn -> (string)
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.
PerformanceInsightsEnabled -> (boolean)
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId -> (string)
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.
PerformanceInsightsRetentionPeriod -> (integer)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
This setting is only for non-Aurora Multi-AZ DB clusters.