Amazon Relational Database Service 2014-10-31
- Client: Aws\Rds\RdsClient
- Service ID: rds
- Version: 2014-10-31
This page describes the parameters and results for the operations of the Amazon Relational Database Service (2014-10-31), and shows how to use the Aws\Rds\RdsClient object to call the described operations. This documentation is specific to the 2014-10-31 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AddRoleToDBCluster ( array $params = [] )
- Associates an Identity and Access Management (IAM) role with a DB cluster.
- AddRoleToDBInstance ( array $params = [] )
- Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
- AddSourceIdentifierToSubscription ( array $params = [] )
- Adds a source identifier to an existing RDS event notification subscription.
- AddTagsToResource ( array $params = [] )
- Adds metadata tags to an Amazon RDS resource.
- ApplyPendingMaintenanceAction ( array $params = [] )
- Applies a pending maintenance action to a resource (for example, to a DB instance).
- AuthorizeDBSecurityGroupIngress ( array $params = [] )
- Enables ingress to a DBSecurityGroup using one of two forms of authorization.
- BacktrackDBCluster ( array $params = [] )
- Backtracks a DB cluster to a specific time, without creating a new DB cluster.
- CancelExportTask ( array $params = [] )
- Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.
- CopyDBClusterParameterGroup ( array $params = [] )
- Copies the specified DB cluster parameter group.
- CopyDBClusterSnapshot ( array $params = [] )
- Copies a snapshot of a DB cluster.
- CopyDBParameterGroup ( array $params = [] )
- Copies the specified DB parameter group.
- CopyDBSnapshot ( array $params = [] )
- Copies the specified DB snapshot.
- CopyOptionGroup ( array $params = [] )
- Copies the specified option group.
- CreateBlueGreenDeployment ( array $params = [] )
- Creates a blue/green deployment.
- CreateCustomDBEngineVersion ( array $params = [] )
- Creates a custom DB engine version (CEV).
- CreateDBCluster ( array $params = [] )
- Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
- CreateDBClusterEndpoint ( array $params = [] )
- Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
- CreateDBClusterParameterGroup ( array $params = [] )
- Creates a new DB cluster parameter group.
- CreateDBClusterSnapshot ( array $params = [] )
- Creates a snapshot of a DB cluster.
- CreateDBInstance ( array $params = [] )
- Creates a new DB instance.
- CreateDBInstanceReadReplica ( array $params = [] )
- Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster.
- CreateDBParameterGroup ( array $params = [] )
- Creates a new DB parameter group.
- CreateDBProxy ( array $params = [] )
- Creates a new DB proxy.
- CreateDBProxyEndpoint ( array $params = [] )
- Creates a DBProxyEndpoint.
- CreateDBSecurityGroup ( array $params = [] )
- Creates a new DB security group.
- CreateDBShardGroup ( array $params = [] )
- Creates a new DB shard group for Aurora Limitless Database.
- CreateDBSnapshot ( array $params = [] )
- Creates a snapshot of a DB instance.
- CreateDBSubnetGroup ( array $params = [] )
- Creates a new DB subnet group.
- CreateEventSubscription ( array $params = [] )
- Creates an RDS event notification subscription.
- CreateGlobalCluster ( array $params = [] )
- Creates an Aurora global database spread across multiple Amazon Web Services Regions.
- CreateIntegration ( array $params = [] )
- Creates a zero-ETL integration with Amazon Redshift.
- CreateOptionGroup ( array $params = [] )
- Creates a new option group.
- CreateTenantDatabase ( array $params = [] )
- Creates a tenant database in a DB instance that uses the multi-tenant configuration.
- DeleteBlueGreenDeployment ( array $params = [] )
- Deletes a blue/green deployment.
- DeleteCustomDBEngineVersion ( array $params = [] )
- Deletes a custom engine version.
- DeleteDBCluster ( array $params = [] )
- The DeleteDBCluster action deletes a previously provisioned DB cluster.
- DeleteDBClusterAutomatedBackup ( array $params = [] )
- Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.
- DeleteDBClusterEndpoint ( array $params = [] )
- Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
- DeleteDBClusterParameterGroup ( array $params = [] )
- Deletes a specified DB cluster parameter group.
- DeleteDBClusterSnapshot ( array $params = [] )
- Deletes a DB cluster snapshot.
- DeleteDBInstance ( array $params = [] )
- Deletes a previously provisioned DB instance.
- DeleteDBInstanceAutomatedBackup ( array $params = [] )
- Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
- DeleteDBParameterGroup ( array $params = [] )
- Deletes a specified DB parameter group.
- DeleteDBProxy ( array $params = [] )
- Deletes an existing DB proxy.
- DeleteDBProxyEndpoint ( array $params = [] )
- Deletes a DBProxyEndpoint.
- DeleteDBSecurityGroup ( array $params = [] )
- Deletes a DB security group.
- DeleteDBShardGroup ( array $params = [] )
- Deletes an Aurora Limitless Database DB shard group.
- DeleteDBSnapshot ( array $params = [] )
- Deletes a DB snapshot.
- DeleteDBSubnetGroup ( array $params = [] )
- Deletes a DB subnet group.
- DeleteEventSubscription ( array $params = [] )
- Deletes an RDS event notification subscription.
- DeleteGlobalCluster ( array $params = [] )
- Deletes a global database cluster.
- DeleteIntegration ( array $params = [] )
- Deletes a zero-ETL integration with Amazon Redshift.
- DeleteOptionGroup ( array $params = [] )
- Deletes an existing option group.
- DeleteTenantDatabase ( array $params = [] )
- Deletes a tenant database from your DB instance.
- DeregisterDBProxyTargets ( array $params = [] )
- Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
- DescribeAccountAttributes ( array $params = [] )
- Lists all of the attributes for a customer account.
- DescribeBlueGreenDeployments ( array $params = [] )
- Describes one or more blue/green deployments.
- DescribeCertificates ( array $params = [] )
- Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
- DescribeDBClusterAutomatedBackups ( array $params = [] )
- Displays backups for both current and deleted DB clusters.
- DescribeDBClusterBacktracks ( array $params = [] )
- Returns information about backtracks for a DB cluster.
- DescribeDBClusterEndpoints ( array $params = [] )
- Returns information about endpoints for an Amazon Aurora DB cluster.
- DescribeDBClusterParameterGroups ( array $params = [] )
- Returns a list of DBClusterParameterGroup descriptions.
- DescribeDBClusterParameters ( array $params = [] )
- Returns the detailed parameter list for a particular DB cluster parameter group.
- DescribeDBClusterSnapshotAttributes ( array $params = [] )
- Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
- DescribeDBClusterSnapshots ( array $params = [] )
- Returns information about DB cluster snapshots.
- DescribeDBClusters ( array $params = [] )
- Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.
- DescribeDBEngineVersions ( array $params = [] )
- Describes the properties of specific versions of DB engines.
- DescribeDBInstanceAutomatedBackups ( array $params = [] )
- Displays backups for both current and deleted instances.
- DescribeDBInstances ( array $params = [] )
- Describes provisioned RDS instances.
- DescribeDBLogFiles ( array $params = [] )
- Returns a list of DB log files for the DB instance.
- DescribeDBParameterGroups ( array $params = [] )
- Returns a list of DBParameterGroup descriptions.
- DescribeDBParameters ( array $params = [] )
- Returns the detailed parameter list for a particular DB parameter group.
- DescribeDBProxies ( array $params = [] )
- Returns information about DB proxies.
- DescribeDBProxyEndpoints ( array $params = [] )
- Returns information about DB proxy endpoints.
- DescribeDBProxyTargetGroups ( array $params = [] )
- Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
- DescribeDBProxyTargets ( array $params = [] )
- Returns information about DBProxyTarget objects.
- DescribeDBRecommendations ( array $params = [] )
- Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
- DescribeDBSecurityGroups ( array $params = [] )
- Returns a list of DBSecurityGroup descriptions.
- DescribeDBShardGroups ( array $params = [] )
- Describes existing Aurora Limitless Database DB shard groups.
- DescribeDBSnapshotAttributes ( array $params = [] )
- Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
- DescribeDBSnapshotTenantDatabases ( array $params = [] )
- Describes the tenant databases that exist in a DB snapshot.
- DescribeDBSnapshots ( array $params = [] )
- Returns information about DB snapshots.
- DescribeDBSubnetGroups ( array $params = [] )
- Returns a list of DBSubnetGroup descriptions.
- DescribeEngineDefaultClusterParameters ( array $params = [] )
- Returns the default engine and system parameter information for the cluster database engine.
- DescribeEngineDefaultParameters ( array $params = [] )
- Returns the default engine and system parameter information for the specified database engine.
- DescribeEventCategories ( array $params = [] )
- Displays a list of categories for all event source types, or, if specified, for a specified source type.
- DescribeEventSubscriptions ( array $params = [] )
- Lists all the subscription descriptions for a customer account.
- DescribeEvents ( array $params = [] )
- Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.
- DescribeExportTasks ( array $params = [] )
- Returns information about a snapshot or cluster export to Amazon S3.
- DescribeGlobalClusters ( array $params = [] )
- Returns information about Aurora global database clusters.
- DescribeIntegrations ( array $params = [] )
- Describe one or more zero-ETL integrations with Amazon Redshift.
- DescribeOptionGroupOptions ( array $params = [] )
- Describes all available options for the specified engine.
- DescribeOptionGroups ( array $params = [] )
- Describes the available option groups.
- DescribeOrderableDBInstanceOptions ( array $params = [] )
- Describes the orderable DB instance options for a specified DB engine.
- DescribePendingMaintenanceActions ( array $params = [] )
- Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- DescribeReservedDBInstances ( array $params = [] )
- Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
- DescribeReservedDBInstancesOfferings ( array $params = [] )
- Lists available reserved DB instance offerings.
- DescribeSourceRegions ( array $params = [] )
- Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
- DescribeTenantDatabases ( array $params = [] )
- Describes the tenant databases in a DB instance that uses the multi-tenant configuration.
- DescribeValidDBInstanceModifications ( array $params = [] )
- You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.
- DisableHttpEndpoint ( array $params = [] )
- Disables the HTTP endpoint for the specified DB cluster.
- DownloadDBLogFilePortion ( array $params = [] )
- Downloads all or a portion of the specified log file, up to 1 MB in size.
- EnableHttpEndpoint ( array $params = [] )
- Enables the HTTP endpoint for the DB cluster.
- FailoverDBCluster ( array $params = [] )
- Forces a failover for a DB cluster.
- FailoverGlobalCluster ( array $params = [] )
- Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database.
- ListTagsForResource ( array $params = [] )
- Lists all tags on an Amazon RDS resource.
- ModifyActivityStream ( array $params = [] )
- Changes the audit policy state of a database activity stream to either locked (default) or unlocked.
- ModifyCertificates ( array $params = [] )
- Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
- ModifyCurrentDBClusterCapacity ( array $params = [] )
- Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
- ModifyCustomDBEngineVersion ( array $params = [] )
- Modifies the status of a custom engine version (CEV).
- ModifyDBCluster ( array $params = [] )
- Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.
- ModifyDBClusterEndpoint ( array $params = [] )
- Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
- ModifyDBClusterParameterGroup ( array $params = [] )
- Modifies the parameters of a DB cluster parameter group.
- ModifyDBClusterSnapshotAttribute ( array $params = [] )
- Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
- ModifyDBInstance ( array $params = [] )
- Modifies settings for a DB instance.
- ModifyDBParameterGroup ( array $params = [] )
- Modifies the parameters of a DB parameter group.
- ModifyDBProxy ( array $params = [] )
- Changes the settings for an existing DB proxy.
- ModifyDBProxyEndpoint ( array $params = [] )
- Changes the settings for an existing DB proxy endpoint.
- ModifyDBProxyTargetGroup ( array $params = [] )
- Modifies the properties of a DBProxyTargetGroup.
- ModifyDBRecommendation ( array $params = [] )
- Updates the recommendation status and recommended action status for the specified recommendation.
- ModifyDBShardGroup ( array $params = [] )
- Modifies the settings of an Aurora Limitless Database DB shard group.
- ModifyDBSnapshot ( array $params = [] )
- Updates a manual DB snapshot with a new engine version.
- ModifyDBSnapshotAttribute ( array $params = [] )
- Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
- ModifyDBSubnetGroup ( array $params = [] )
- Modifies an existing DB subnet group.
- ModifyEventSubscription ( array $params = [] )
- Modifies an existing RDS event notification subscription.
- ModifyGlobalCluster ( array $params = [] )
- Modifies a setting for an Amazon Aurora global database cluster.
- ModifyIntegration ( array $params = [] )
- Modifies a zero-ETL integration with Amazon Redshift.
- ModifyOptionGroup ( array $params = [] )
- Modifies an existing option group.
- ModifyTenantDatabase ( array $params = [] )
- Modifies an existing tenant database in a DB instance.
- PromoteReadReplica ( array $params = [] )
- Promotes a read replica DB instance to a standalone DB instance.
- PromoteReadReplicaDBCluster ( array $params = [] )
- Promotes a read replica DB cluster to a standalone DB cluster.
- PurchaseReservedDBInstancesOffering ( array $params = [] )
- Purchases a reserved DB instance offering.
- RebootDBCluster ( array $params = [] )
- You might need to reboot your DB cluster, usually for maintenance reasons.
- RebootDBInstance ( array $params = [] )
- You might need to reboot your DB instance, usually for maintenance reasons.
- RebootDBShardGroup ( array $params = [] )
- You might need to reboot your DB shard group, usually for maintenance reasons.
- RegisterDBProxyTargets ( array $params = [] )
- Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
- RemoveFromGlobalCluster ( array $params = [] )
- Detaches an Aurora secondary cluster from an Aurora global database cluster.
- RemoveRoleFromDBCluster ( array $params = [] )
- Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
- RemoveRoleFromDBInstance ( array $params = [] )
- Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
- RemoveSourceIdentifierFromSubscription ( array $params = [] )
- Removes a source identifier from an existing RDS event notification subscription.
- RemoveTagsFromResource ( array $params = [] )
- Removes metadata tags from an Amazon RDS resource.
- ResetDBClusterParameterGroup ( array $params = [] )
- Modifies the parameters of a DB cluster parameter group to the default value.
- ResetDBParameterGroup ( array $params = [] )
- Modifies the parameters of a DB parameter group to the engine/system default value.
- RestoreDBClusterFromS3 ( array $params = [] )
- Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.
- RestoreDBClusterFromSnapshot ( array $params = [] )
- Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
- RestoreDBClusterToPointInTime ( array $params = [] )
- Restores a DB cluster to an arbitrary point in time.
- RestoreDBInstanceFromDBSnapshot ( array $params = [] )
- Creates a new DB instance from a DB snapshot.
- RestoreDBInstanceFromS3 ( array $params = [] )
- Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.
- RestoreDBInstanceToPointInTime ( array $params = [] )
- Restores a DB instance to an arbitrary point in time.
- RevokeDBSecurityGroupIngress ( array $params = [] )
- Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups.
- StartActivityStream ( array $params = [] )
- Starts a database activity stream to monitor activity on the database.
- StartDBCluster ( array $params = [] )
- Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation.
- StartDBInstance ( array $params = [] )
- Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.
- StartDBInstanceAutomatedBackupsReplication ( array $params = [] )
- Enables replication of automated backups to a different Amazon Web Services Region.
- StartExportTask ( array $params = [] )
- Starts an export of DB snapshot or DB cluster data to Amazon S3.
- StopActivityStream ( array $params = [] )
- Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation.
- StopDBCluster ( array $params = [] )
- Stops an Amazon Aurora DB cluster.
- StopDBInstance ( array $params = [] )
- Stops an Amazon RDS DB instance.
- StopDBInstanceAutomatedBackupsReplication ( array $params = [] )
- Stops automated backup replication for a DB instance.
- SwitchoverBlueGreenDeployment ( array $params = [] )
- Switches over a blue/green deployment.
- SwitchoverGlobalCluster ( array $params = [] )
- Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.
- SwitchoverReadReplica ( array $params = [] )
- Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeBlueGreenDeployments
- DescribeCertificates
- DescribeDBClusterAutomatedBackups
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusterParameterGroups
- DescribeDBClusterParameters
- DescribeDBClusterSnapshots
- DescribeDBClusters
- DescribeDBEngineVersions
- DescribeDBInstanceAutomatedBackups
- DescribeDBInstances
- DescribeDBLogFiles
- DescribeDBParameterGroups
- DescribeDBParameters
- DescribeDBProxies
- DescribeDBProxyEndpoints
- DescribeDBProxyTargetGroups
- DescribeDBProxyTargets
- DescribeDBRecommendations
- DescribeDBSecurityGroups
- DescribeDBSnapshotTenantDatabases
- DescribeDBSnapshots
- DescribeDBSubnetGroups
- DescribeEngineDefaultParameters
- DescribeEventSubscriptions
- DescribeEvents
- DescribeExportTasks
- DescribeGlobalClusters
- DescribeIntegrations
- DescribeOptionGroupOptions
- DescribeOptionGroups
- DescribeOrderableDBInstanceOptions
- DescribePendingMaintenanceActions
- DescribeReservedDBInstances
- DescribeReservedDBInstancesOfferings
- DescribeSourceRegions
- DescribeTenantDatabases
- DownloadDBLogFilePortion
- ListTagsForResource
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Waiter name | API Operation | Delay | Max Attempts |
---|---|---|---|
DBInstanceAvailable | DescribeDBInstances | 30 | 60 |
DBInstanceDeleted | DescribeDBInstances | 30 | 60 |
DBSnapshotAvailable | DescribeDBSnapshots | 30 | 60 |
DBSnapshotDeleted | DescribeDBSnapshots | 30 | 60 |
DBClusterSnapshotAvailable | DescribeDBClusterSnapshots | 30 | 60 |
DBClusterSnapshotDeleted | DescribeDBClusterSnapshots | 30 | 60 |
DBClusterAvailable | DescribeDBClusters | 30 | 60 |
DBClusterDeleted | DescribeDBClusters | 30 | 60 |
TenantDatabaseAvailable | DescribeTenantDatabases | 30 | 60 |
TenantDatabaseDeleted | DescribeTenantDatabases | 30 | 60 |
Operations
AddRoleToDBCluster
$result = $client->addRoleToDBCluster
([/* ... */]); $promise = $client->addRoleToDBClusterAsync
([/* ... */]);
Associates an Identity and Access Management (IAM) role with a DB cluster.
Parameter Syntax
$result = $client->addRoleToDBCluster([ 'DBClusterIdentifier' => '<string>', // REQUIRED 'FeatureName' => '<string>', 'RoleArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The name of the DB cluster to associate the IAM role with.
- FeatureName
-
- Type: string
The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole
.
Result Syntax
[]
Result Details
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBClusterRoleAlreadyExistsFault:
The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBClusterRoleQuotaExceededFault:
You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
Examples
Example 1: To associate an AWS Identity and Access Management (IAM) role with a DB cluster
The following example associates a role with a DB cluster.
$result = $client->addRoleToDBCluster([ 'DBClusterIdentifier' => 'mydbcluster', 'RoleArn' => 'arn:aws:iam::123456789012:role/RDSLoadFromS3', ]);
AddRoleToDBInstance
$result = $client->addRoleToDBInstance
([/* ... */]); $promise = $client->addRoleToDBInstanceAsync
([/* ... */]);
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be available
.
This command doesn't apply to RDS Custom.
Parameter Syntax
$result = $client->addRoleToDBInstance([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'FeatureName' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The name of the DB instance to associate the IAM role with.
- FeatureName
-
- Required: Yes
- Type: string
The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example
arn:aws:iam::123456789012:role/AccessRole
.
Result Syntax
[]
Result Details
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBInstanceRoleAlreadyExistsFault:
The specified
RoleArn
orFeatureName
value is already associated with the DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- DBInstanceRoleQuotaExceededFault:
You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
Examples
Example 1: To associate an AWS Identity and Access Management (IAM) role with a DB instance
The following example adds the role to a DB instance named test-instance.
$result = $client->addRoleToDBInstance([ 'DBInstanceIdentifier' => 'test-instance', 'FeatureName' => 'S3_INTEGRATION', 'RoleArn' => 'arn:aws:iam::111122223333:role/rds-s3-integration-role', ]);
AddSourceIdentifierToSubscription
$result = $client->addSourceIdentifierToSubscription
([/* ... */]); $promise = $client->addSourceIdentifierToSubscriptionAsync
([/* ... */]);
Adds a source identifier to an existing RDS event notification subscription.
Parameter Syntax
$result = $client->addSourceIdentifierToSubscription([ 'SourceIdentifier' => '<string>', // REQUIRED 'SubscriptionName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SourceIdentifier
-
- Required: Yes
- Type: string
The identifier of the event source to be added.
Constraints:
-
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.
- SubscriptionName
-
- Required: Yes
- Type: string
The name of the RDS event notification subscription you want to add a source identifier to.
Result Syntax
[ 'EventSubscription' => [ 'CustSubscriptionId' => '<string>', 'CustomerAwsId' => '<string>', 'Enabled' => true || false, 'EventCategoriesList' => ['<string>', ...], 'EventSubscriptionArn' => '<string>', 'SnsTopicArn' => '<string>', 'SourceIdsList' => ['<string>', ...], 'SourceType' => '<string>', 'Status' => '<string>', 'SubscriptionCreationTime' => '<string>', ], ]
Result Details
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
Errors
- SubscriptionNotFoundFault:
The subscription name does not exist.
- SourceNotFoundFault:
The requested source could not be found.
Examples
Example 1: To add a source identifier to a subscription
The following example adds another source identifier to an existing subscription.
$result = $client->addSourceIdentifierToSubscription([ 'SourceIdentifier' => 'test-instance-repl', 'SubscriptionName' => 'my-instance-events', ]);
Result syntax:
[ 'EventSubscription' => [ 'CustSubscriptionId' => 'my-instance-events', 'CustomerAwsId' => '123456789012', 'Enabled' => , 'EventCategoriesList' => [ 'backup', 'recovery', ], 'EventSubscriptionArn' => 'arn:aws:rds:us-east-1:123456789012:es:my-instance-events', 'SnsTopicArn' => 'arn:aws:sns:us-east-1:123456789012:interesting-events', 'SourceIdsList' => [ 'test-instance', 'test-instance-repl', ], 'SourceType' => 'db-instance', 'Status' => 'modifying', 'SubscriptionCreationTime' => 'Tue Jul 31 23:22:01 UTC 2018', ], ]
AddTagsToResource
$result = $client->addTagsToResource
([/* ... */]); $promise = $client->addTagsToResourceAsync
([/* ... */]);
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging your relational database resources, see Tagging Amazon RDS Resources or Tagging Amazon Aurora and Amazon RDS Resources.
Parameter Syntax
$result = $client->addTagsToResource([ 'ResourceName' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- ResourceName
-
- Required: Yes
- Type: string
The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
- Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags to be assigned to the Amazon RDS resource.
Result Syntax
[]
Result Details
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetGroupNotFoundFault:
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundFault:
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.- IntegrationNotFoundFault:
The specified integration could not be found.
- TenantDatabaseNotFoundFault:
The specified tenant database wasn't found in the DB instance.
- DBSnapshotTenantDatabaseNotFoundFault:
The specified snapshot tenant database wasn't found.
Examples
Example 1: To add tags to a resource
This example adds a tag to an option group.
$result = $client->addTagsToResource([ 'ResourceName' => 'arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup', 'Tags' => [ [ 'Key' => 'Staging', 'Value' => 'LocationDB', ], ], ]);
ApplyPendingMaintenanceAction
$result = $client->applyPendingMaintenanceAction
([/* ... */]); $promise = $client->applyPendingMaintenanceActionAsync
([/* ... */]);
Applies a pending maintenance action to a resource (for example, to a DB instance).
Parameter Syntax
$result = $client->applyPendingMaintenanceAction([ 'ApplyAction' => '<string>', // REQUIRED 'OptInType' => '<string>', // REQUIRED 'ResourceIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ApplyAction
-
- Required: Yes
- Type: string
The pending maintenance action to apply to this resource.
Valid Values:
-
ca-certificate-rotation
-
db-upgrade
-
hardware-maintenance
-
os-upgrade
-
system-update
For more information about these actions, see Maintenance actions for Amazon Aurora or Maintenance actions for Amazon RDS.
- OptInType
-
- Required: Yes
- Type: string
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type
immediate
can't be undone.Valid Values:
-
immediate
- Apply the maintenance action immediately. -
next-maintenance
- Apply the maintenance action during the next maintenance window for the resource. -
undo-opt-in
- Cancel any existingnext-maintenance
opt-in requests.
- ResourceIdentifier
-
- Required: Yes
- Type: string
The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
Result Syntax
[ 'ResourcePendingMaintenanceActions' => [ 'PendingMaintenanceActionDetails' => [ [ 'Action' => '<string>', 'AutoAppliedAfterDate' => <DateTime>, 'CurrentApplyDate' => <DateTime>, 'Description' => '<string>', 'ForcedApplyDate' => <DateTime>, 'OptInStatus' => '<string>', ], // ... ], 'ResourceIdentifier' => '<string>', ], ]
Result Details
Members
- ResourcePendingMaintenanceActions
-
- Type: ResourcePendingMaintenanceActions structure
Describes the pending maintenance actions for a resource.
Errors
- ResourceNotFoundFault:
The specified resource ID was not found.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To apply pending maintenance actions
The following example applies the pending maintenance actions for a DB cluster.
$result = $client->applyPendingMaintenanceAction([ 'ApplyAction' => 'system-update', 'OptInType' => 'immediate', 'ResourceIdentifier' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster', ]);
Result syntax:
[ 'ResourcePendingMaintenanceActions' => [ 'PendingMaintenanceActionDetails' => [ [ 'Action' => 'system-update', 'CurrentApplyDate' =>, 'Description' => 'Upgrade to Aurora PostgreSQL 3.3.2', 'OptInStatus' => 'immediate', ], ], 'ResourceIdentifier' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster', ], ]
AuthorizeDBSecurityGroupIngress
$result = $client->authorizeDBSecurityGroupIngress
([/* ... */]); $promise = $client->authorizeDBSecurityGroupIngressAsync
([/* ... */]);
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->authorizeDBSecurityGroupIngress([ 'CIDRIP' => '<string>', 'DBSecurityGroupName' => '<string>', // REQUIRED 'EC2SecurityGroupId' => '<string>', 'EC2SecurityGroupName' => '<string>', 'EC2SecurityGroupOwnerId' => '<string>', ]);
Parameter Details
Members
- CIDRIP
-
- Type: string
The IP range to authorize.
- DBSecurityGroupName
-
- Required: Yes
- Type: string
The name of the DB security group to add authorization to.
- EC2SecurityGroupId
-
- Type: string
Id of the EC2 security group to authorize. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided. - EC2SecurityGroupName
-
- Type: string
Name of the EC2 security group to authorize. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided. - EC2SecurityGroupOwnerId
-
- Type: string
Amazon Web Services account number of the owner of the EC2 security group specified in the
EC2SecurityGroupName
parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups,EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.
Result Syntax
[ 'DBSecurityGroup' => [ 'DBSecurityGroupArn' => '<string>', 'DBSecurityGroupDescription' => '<string>', 'DBSecurityGroupName' => '<string>', 'EC2SecurityGroups' => [ [ 'EC2SecurityGroupId' => '<string>', 'EC2SecurityGroupName' => '<string>', 'EC2SecurityGroupOwnerId' => '<string>', 'Status' => '<string>', ], // ... ], 'IPRanges' => [ [ 'CIDRIP' => '<string>', 'Status' => '<string>', ], // ... ], 'OwnerId' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSecurityGroup
-
- Type: DBSecurityGroup structure
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
Errors
- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.- InvalidDBSecurityGroupStateFault:
The state of the DB security group doesn't allow deletion.
- AuthorizationAlreadyExistsFault:
The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
- AuthorizationQuotaExceededFault:
The DB security group authorization quota has been reached.
Examples
Example 1: To authorize DB security group integress
This example authorizes access to the specified security group by the specified CIDR block.
$result = $client->authorizeDBSecurityGroupIngress([ 'CIDRIP' => '203.0.113.5/32', 'DBSecurityGroupName' => 'mydbsecuritygroup', ]);
Result syntax:
[ 'DBSecurityGroup' => [ ], ]
BacktrackDBCluster
$result = $client->backtrackDBCluster
([/* ... */]); $promise = $client->backtrackDBClusterAsync
([/* ... */]);
Backtracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action applies only to Aurora MySQL DB clusters.
Parameter Syntax
$result = $client->backtrackDBCluster([ 'BacktrackTo' => <integer || string || DateTime>, // REQUIRED 'DBClusterIdentifier' => '<string>', // REQUIRED 'Force' => true || false, 'UseEarliestTimeOnPointInTimeUnavailable' => true || false, ]);
Parameter Details
Members
- BacktrackTo
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.
If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:
-
Must contain a valid ISO 8601 timestamp.
-
Can't contain a timestamp set in the future.
Example:
2017-07-08T18:00Z
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
- Force
-
- Type: boolean
Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
- UseEarliestTimeOnPointInTimeUnavailable
-
- Type: boolean
Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
Result Syntax
[ 'BacktrackIdentifier' => '<string>', 'BacktrackRequestCreationTime' => <DateTime>, 'BacktrackTo' => <DateTime>, 'BacktrackedFrom' => <DateTime>, 'DBClusterIdentifier' => '<string>', 'Status' => '<string>', ]
Result Details
Members
- BacktrackIdentifier
-
- Type: string
Contains the backtrack identifier.
- BacktrackRequestCreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the time at which the backtrack was requested.
- BacktrackTo
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the time to which the DB cluster was backtracked.
- BacktrackedFrom
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the time from which the DB cluster was backtracked.
- DBClusterIdentifier
-
- Type: string
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
- Status
-
- Type: string
The status of the backtrack. This property returns one of the following values:
-
applying
- The backtrack is currently being applied to or rolled back from the DB cluster. -
completed
- The backtrack has successfully been applied to or rolled back from the DB cluster. -
failed
- An error occurred while the backtrack was applied to or rolled back from the DB cluster. -
pending
- The backtrack is currently pending application to or rollback from the DB cluster.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
CancelExportTask
$result = $client->cancelExportTask
([/* ... */]); $promise = $client->cancelExportTaskAsync
([/* ... */]);
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
Parameter Syntax
$result = $client->cancelExportTask([ 'ExportTaskIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ExportTaskIdentifier
-
- Required: Yes
- Type: string
The identifier of the snapshot or cluster export task to cancel.
Result Syntax
[ 'ExportOnly' => ['<string>', ...], 'ExportTaskIdentifier' => '<string>', 'FailureCause' => '<string>', 'IamRoleArn' => '<string>', 'KmsKeyId' => '<string>', 'PercentProgress' => <integer>, 'S3Bucket' => '<string>', 'S3Prefix' => '<string>', 'SnapshotTime' => <DateTime>, 'SourceArn' => '<string>', 'SourceType' => 'SNAPSHOT|CLUSTER', 'Status' => '<string>', 'TaskEndTime' => <DateTime>, 'TaskStartTime' => <DateTime>, 'TotalExtractedDataInGB' => <integer>, 'WarningMessage' => '<string>', ]
Result Details
Members
- ExportOnly
-
- Type: Array of strings
The data exported from the snapshot or cluster.
Valid Values:
-
database
- Export all the data from a specified database. -
database.table
table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schema
schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
- ExportTaskIdentifier
-
- Type: string
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
- FailureCause
-
- Type: string
The reason the export failed, if it failed.
- IamRoleArn
-
- Type: string
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
- KmsKeyId
-
- Type: string
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
- PercentProgress
-
- Type: int
The progress of the snapshot or cluster export task as a percentage.
- S3Bucket
-
- Type: string
The Amazon S3 bucket where the snapshot or cluster is exported to.
- S3Prefix
-
- Type: string
The Amazon S3 bucket prefix that is the file name and path of the exported data.
- SnapshotTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot was created.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
- SourceType
-
- Type: string
The type of source for the export.
- Status
-
- Type: string
The progress status of the export task. The status can be one of the following:
-
CANCELED
-
CANCELING
-
COMPLETE
-
FAILED
-
IN_PROGRESS
-
STARTING
- TaskEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot or cluster export task ended.
- TaskStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot or cluster export task started.
- TotalExtractedDataInGB
-
- Type: int
The total amount of data exported, in gigabytes.
- WarningMessage
-
- Type: string
A warning about the snapshot or cluster export task.
Errors
- ExportTaskNotFoundFault:
The export task doesn't exist.
- InvalidExportTaskStateFault:
You can't cancel an export task that has completed.
Examples
Example 1: To cancel a snapshot export to Amazon S3
The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.
$result = $client->cancelExportTask([ 'ExportTaskIdentifier' => 'my-s3-export-1', ]);
Result syntax:
[ 'ExportTaskIdentifier' => 'my-s3-export-1', 'IamRoleArn' => 'arn:aws:iam::123456789012:role/service-role/export-snap-S3-role', 'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff', 'PercentProgress' => 0, 'S3Bucket' => 'mybucket', 'S3Prefix' => '', 'SnapshotTime' =>, 'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot', 'Status' => 'CANCELING', 'TotalExtractedDataInGB' => 0, ]
CopyDBClusterParameterGroup
$result = $client->copyDBClusterParameterGroup
([/* ... */]); $promise = $client->copyDBClusterParameterGroupAsync
([/* ... */]);
Copies the specified DB cluster parameter group.
You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.
Parameter Syntax
$result = $client->copyDBClusterParameterGroup([ 'SourceDBClusterParameterGroupIdentifier' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetDBClusterParameterGroupDescription' => '<string>', // REQUIRED 'TargetDBClusterParameterGroupIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SourceDBClusterParameterGroupIdentifier
-
- Required: Yes
- Type: string
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
Constraints:
-
Must specify a valid DB cluster parameter group.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetDBClusterParameterGroupDescription
-
- Required: Yes
- Type: string
A description for the copied DB cluster parameter group.
- TargetDBClusterParameterGroupIdentifier
-
- Required: Yes
- Type: string
The identifier for the copied DB cluster parameter group.
Constraints:
-
Can't be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
Example:
my-cluster-param-group1
Result Syntax
[ 'DBClusterParameterGroup' => [ 'DBClusterParameterGroupArn' => '<string>', 'DBClusterParameterGroupName' => '<string>', 'DBParameterGroupFamily' => '<string>', 'Description' => '<string>', ], ]
Result Details
Members
- DBClusterParameterGroup
-
- Type: DBClusterParameterGroup structure
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the
DescribeDBClusterParameterGroups
action.
Errors
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- DBParameterGroupQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB parameter groups.
- DBParameterGroupAlreadyExistsFault:
A DB parameter group with the same name exists.
Examples
Example 1: To copy a DB cluster parameter group
This example copies a DB cluster parameter group.
$result = $client->copyDBClusterParameterGroup([ 'SourceDBClusterParameterGroupIdentifier' => 'mydbclusterparametergroup', 'TargetDBClusterParameterGroupDescription' => 'My DB cluster parameter group copy', 'TargetDBClusterParameterGroupIdentifier' => 'mydbclusterparametergroup-copy', ]);
Result syntax:
[ 'DBClusterParameterGroup' => [ 'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy', 'DBClusterParameterGroupName' => 'mydbclusterparametergroup-copy', 'DBParameterGroupFamily' => 'aurora-mysql5.7', 'Description' => 'My DB cluster parameter group copy', ], ]
CopyDBClusterSnapshot
$result = $client->copyDBClusterSnapshot
([/* ... */]); $promise = $client->copyDBClusterSnapshotAsync
([/* ... */]);
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot
operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:
-
KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->copyDBClusterSnapshot([ 'CopyTags' => true || false, 'DestinationRegion' => '<string>', 'KmsKeyId' => '<string>', 'PreSignedUrl' => '<string>', 'SourceDBClusterSnapshotIdentifier' => '<string>', // REQUIRED 'SourceRegion' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetDBClusterSnapshotIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- CopyTags
-
- Type: boolean
Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
- DestinationRegion
-
- Type: string
The SDK will populate this parameter on your behalf using the configured region value of the client. - KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for
KmsKeyId
to encrypt the copy with a new KMS key. If you don't specify a value forKmsKeyId
, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for
KmsKeyId
.To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set
KmsKeyId
to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.If you copy an unencrypted DB cluster snapshot and specify a value for the
KmsKeyId
parameter, an error is returned. - PreSignedUrl
-
- Type: string
The SDK will compute this value for you on your behalf. - SourceDBClusterSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
Constraints:
-
Must specify a valid system snapshot in the "available" state.
-
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
-
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
Example:
my-cluster-snapshot1
- SourceRegion
-
- Type: string
A required parameter that indicates the region that the DB snapshot will be copied from. - Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetDBClusterSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.
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.
Example:
my-cluster-snapshot2
Result Syntax
[ 'DBClusterSnapshot' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZones' => ['<string>', ...], 'ClusterCreateTime' => <DateTime>, 'DBClusterIdentifier' => '<string>', 'DBClusterSnapshotArn' => '<string>', 'DBClusterSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbClusterResourceId' => '<string>', 'Engine' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'PercentProgress' => <integer>, 'Port' => <integer>, 'SnapshotCreateTime' => <DateTime>, 'SnapshotType' => '<string>', 'SourceDBClusterSnapshotArn' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcId' => '<string>', ], ]
Result Details
Members
- DBClusterSnapshot
-
- Type: DBClusterSnapshot structure
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
Errors
- DBClusterSnapshotAlreadyExistsFault:
The user already has a DB cluster snapshot with the given identifier.
- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBClusterSnapshotStateFault:
The supplied value isn't a valid DB cluster snapshot state.
- SnapshotQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB snapshots.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
Examples
Example 1: To copy a DB cluster snapshot
The following example creates a copy of a DB cluster snapshot, including its tags.
$result = $client->copyDBClusterSnapshot([ 'CopyTags' => 1, 'SourceDBClusterSnapshotIdentifier' => 'arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16', 'TargetDBClusterSnapshotIdentifier' => 'myclustersnapshotcopy', ]);
Result syntax:
[ 'DBClusterSnapshot' => [ 'AllocatedStorage' => 0, 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1b', 'us-east-1e', ], 'ClusterCreateTime' =>, 'DBClusterIdentifier' => 'myaurora', 'DBClusterSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy', 'DBClusterSnapshotIdentifier' => 'myclustersnapshotcopy', 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.04.2', 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', 'LicenseModel' => 'aurora-mysql', 'MasterUsername' => 'myadmin', 'PercentProgress' => 100, 'Port' => 0, 'SnapshotCreateTime' => , 'SnapshotType' => 'manual', 'Status' => 'available', 'StorageEncrypted' => 1, 'VpcId' => 'vpc-123example', ], ]
CopyDBParameterGroup
$result = $client->copyDBParameterGroup
([/* ... */]); $promise = $client->copyDBParameterGroupAsync
([/* ... */]);
Copies the specified DB parameter group.
You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.
Parameter Syntax
$result = $client->copyDBParameterGroup([ 'SourceDBParameterGroupIdentifier' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetDBParameterGroupDescription' => '<string>', // REQUIRED 'TargetDBParameterGroupIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SourceDBParameterGroupIdentifier
-
- Required: Yes
- Type: string
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
-
Must specify a valid DB parameter group.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetDBParameterGroupDescription
-
- Required: Yes
- Type: string
A description for the copied DB parameter group.
- TargetDBParameterGroupIdentifier
-
- Required: Yes
- Type: string
The identifier for the copied DB parameter group.
Constraints:
-
Can't be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
Example:
my-db-parameter-group
Result Syntax
[ 'DBParameterGroup' => [ 'DBParameterGroupArn' => '<string>', 'DBParameterGroupFamily' => '<string>', 'DBParameterGroupName' => '<string>', 'Description' => '<string>', ], ]
Result Details
Members
- DBParameterGroup
-
- Type: DBParameterGroup structure
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the
DescribeDBParameterGroups
action.
Errors
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- DBParameterGroupAlreadyExistsFault:
A DB parameter group with the same name exists.
- DBParameterGroupQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB parameter groups.
Examples
Example 1: To copy a DB parameter group
The following example makes a copy of a DB parameter group.
$result = $client->copyDBParameterGroup([ 'SourceDBParameterGroupIdentifier' => 'mydbpg', 'TargetDBParameterGroupDescription' => 'Copy of mydbpg parameter group', 'TargetDBParameterGroupIdentifier' => 'mydbpgcopy', ]);
Result syntax:
[ 'DBParameterGroup' => [ 'DBParameterGroupArn' => 'arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy', 'DBParameterGroupFamily' => 'mysql5.7', 'DBParameterGroupName' => 'mydbpgcopy', 'Description' => 'Copy of mydbpg parameter group', ], ]
CopyDBSnapshot
$result = $client->copyDBSnapshot
([/* ... */]); $promise = $client->copyDBSnapshotAsync
([/* ... */]);
Copies the specified DB snapshot. The source DB snapshot must be in the available
state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot
operation is the destination Amazon Web Services Region for the DB snapshot copy.
This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->copyDBSnapshot([ 'CopyOptionGroup' => true || false, 'CopyTags' => true || false, 'DestinationRegion' => '<string>', 'KmsKeyId' => '<string>', 'OptionGroupName' => '<string>', 'PreSignedUrl' => '<string>', 'SourceDBSnapshotIdentifier' => '<string>', // REQUIRED 'SourceRegion' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetCustomAvailabilityZone' => '<string>', 'TargetDBSnapshotIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- CopyOptionGroup
-
- Type: boolean
Specifies whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
- CopyTags
-
- Type: boolean
Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.
- DestinationRegion
-
- Type: string
The SDK will populate this parameter on your behalf using the configured region value of the client. - KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
- OptionGroupName
-
- Type: string
The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.
- PreSignedUrl
-
- Type: string
The SDK will compute this value for you on your behalf. - SourceDBSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify
rds:mysql-instance1-snapshot-20130805
.If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
.If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
Constraints:
-
Must specify a valid system snapshot in the "available" state.
Example:
rds:mydb-2012-04-02-00-01
Example:
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
- SourceRegion
-
- Type: string
A required parameter that indicates the region that the DB snapshot will be copied from. - Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetCustomAvailabilityZone
-
- Type: string
The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example:
rds-caz-aiqhTgQv
. - TargetDBSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier for the copy of the snapshot.
Constraints:
-
Can't be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
Example:
my-db-snapshot
Result Syntax
[ 'DBSnapshot' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSnapshotArn' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'OriginalSnapshotCreateTime' => <DateTime>, 'PercentProgress' => <integer>, 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'SnapshotCreateTime' => <DateTime>, 'SnapshotDatabaseTime' => <DateTime>, 'SnapshotTarget' => '<string>', 'SnapshotType' => '<string>', 'SourceDBSnapshotIdentifier' => '<string>', 'SourceRegion' => '<string>', 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSnapshot
-
- Type: DBSnapshot structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
Errors
- DBSnapshotAlreadyExistsFault:
DBSnapshotIdentifier
is already used by an existing snapshot.- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.- InvalidDBSnapshotStateFault:
The state of the DB snapshot doesn't allow deletion.
- SnapshotQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB snapshots.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- CustomAvailabilityZoneNotFoundFault:
CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone identifier.
Examples
Example 1: To copy a DB snapshot
The following example creates a copy of a DB snapshot.
$result = $client->copyDBSnapshot([ 'SourceDBSnapshotIdentifier' => 'rds:database-mysql-2019-06-06-08-38', 'TargetDBSnapshotIdentifier' => 'mydbsnapshotcopy', ]);
Result syntax:
[ 'DBSnapshot' => [ 'AllocatedStorage' => 100, 'AvailabilityZone' => 'us-east-1f', 'DBInstanceIdentifier' => 'database-mysql', 'DBSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy', 'DBSnapshotIdentifier' => 'mydbsnapshotcopy', 'DbiResourceId' => 'db-ZI7UJ5BLKMBYFGX7FDENCKADC4', 'Encrypted' => 1, 'Engine' => 'mysql', 'EngineVersion' => '5.6.40', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'Iops' => 1000, 'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', 'LicenseModel' => 'general-public-license', 'MasterUsername' => 'admin', 'OptionGroupName' => 'default:mysql-5-6', 'PercentProgress' => 0, 'Port' => 3306, 'ProcessorFeatures' => [ ], 'SnapshotType' => 'manual', 'SourceDBSnapshotIdentifier' => 'arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38', 'SourceRegion' => 'us-east-1', 'Status' => 'creating', 'StorageType' => 'io1', 'VpcId' => 'vpc-6594f31c', ], ]
CopyOptionGroup
$result = $client->copyOptionGroup
([/* ... */]); $promise = $client->copyOptionGroupAsync
([/* ... */]);
Copies the specified option group.
Parameter Syntax
$result = $client->copyOptionGroup([ 'SourceOptionGroupIdentifier' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetOptionGroupDescription' => '<string>', // REQUIRED 'TargetOptionGroupIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SourceOptionGroupIdentifier
-
- Required: Yes
- Type: string
The identifier for the source option group.
Constraints:
-
Must specify a valid option group.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetOptionGroupDescription
-
- Required: Yes
- Type: string
The description for the copied option group.
- TargetOptionGroupIdentifier
-
- Required: Yes
- Type: string
The identifier for the copied option group.
Constraints:
-
Can't be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
Example:
my-option-group
Result Syntax
[ 'OptionGroup' => [ 'AllowsVpcAndNonVpcInstanceMemberships' => true || false, 'CopyTimestamp' => <DateTime>, 'EngineName' => '<string>', 'MajorEngineVersion' => '<string>', 'OptionGroupArn' => '<string>', 'OptionGroupDescription' => '<string>', 'OptionGroupName' => '<string>', 'Options' => [ [ 'DBSecurityGroupMemberships' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'OptionDescription' => '<string>', 'OptionName' => '<string>', 'OptionSettings' => [ [ 'AllowedValues' => '<string>', 'ApplyType' => '<string>', 'DataType' => '<string>', 'DefaultValue' => '<string>', 'Description' => '<string>', 'IsCollection' => true || false, 'IsModifiable' => true || false, 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'OptionVersion' => '<string>', 'Permanent' => true || false, 'Persistent' => true || false, 'Port' => <integer>, 'VpcSecurityGroupMemberships' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], // ... ], 'SourceAccountId' => '<string>', 'SourceOptionGroup' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- OptionGroup
-
- Type: OptionGroup structure
Errors
- OptionGroupAlreadyExistsFault:
The option group you are trying to create already exists.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- OptionGroupQuotaExceededFault:
The quota of 20 option groups was exceeded for this Amazon Web Services account.
Examples
Example 1: To copy an option group
The following example makes a copy of an option group.
$result = $client->copyOptionGroup([ 'SourceOptionGroupIdentifier' => 'myoptiongroup', 'TargetOptionGroupDescription' => 'My option group copy', 'TargetOptionGroupIdentifier' => 'new-option-group', ]);
Result syntax:
[ 'OptionGroup' => [ 'AllowsVpcAndNonVpcInstanceMemberships' => 1, 'EngineName' => 'oracle-ee', 'MajorEngineVersion' => '11.2', 'OptionGroupArn' => 'arn:aws:rds:us-east-1:123456789012:og:new-option-group', 'OptionGroupDescription' => 'My option group copy', 'OptionGroupName' => 'new-option-group', 'Options' => [ ], ], ]
CreateBlueGreenDeployment
$result = $client->createBlueGreenDeployment
([/* ... */]); $promise = $client->createBlueGreenDeploymentAsync
([/* ... */]);
Creates a blue/green deployment.
A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment.
You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->createBlueGreenDeployment([ 'BlueGreenDeploymentName' => '<string>', // REQUIRED 'Source' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetAllocatedStorage' => <integer>, 'TargetDBClusterParameterGroupName' => '<string>', 'TargetDBInstanceClass' => '<string>', 'TargetDBParameterGroupName' => '<string>', 'TargetEngineVersion' => '<string>', 'TargetIops' => <integer>, 'TargetStorageThroughput' => <integer>, 'TargetStorageType' => '<string>', 'UpgradeTargetStorageConfig' => true || false, ]);
Parameter Details
Members
- BlueGreenDeploymentName
-
- Required: Yes
- Type: string
The name of the blue/green deployment.
Constraints:
-
Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
- Source
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the source production database.
Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.
- Tags
-
- Type: Array of Tag structures
Tags to assign to the blue/green deployment.
- TargetAllocatedStorage
-
- Type: int
The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance.
This setting doesn't apply to Amazon Aurora blue/green deployments.
- TargetDBClusterParameterGroupName
-
- Type: string
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.
- TargetDBInstanceClass
-
- Type: string
Specify the DB instance class for the databases in the green environment.
This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.
- TargetDBParameterGroupName
-
- Type: string
The DB parameter group associated with the DB instance in the green environment.
To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
- TargetEngineVersion
-
- Type: string
The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
- TargetIops
-
- Type: int
The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora blue/green deployments.
- TargetStorageThroughput
-
- Type: int
The storage throughput value for the green DB instance.
This setting applies only to the
gp3
storage type.This setting doesn't apply to Amazon Aurora blue/green deployments.
- TargetStorageType
-
- Type: string
The storage type to associate with the green DB instance.
Valid Values:
gp2 | gp3 | io1 | io2
This setting doesn't apply to Amazon Aurora blue/green deployments.
- UpgradeTargetStorageConfig
-
- Type: boolean
Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB instance.
Result Syntax
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => '<string>', 'BlueGreenDeploymentName' => '<string>', 'CreateTime' => <DateTime>, 'DeleteTime' => <DateTime>, 'Source' => '<string>', 'Status' => '<string>', 'StatusDetails' => '<string>', 'SwitchoverDetails' => [ [ 'SourceMember' => '<string>', 'Status' => '<string>', 'TargetMember' => '<string>', ], // ... ], 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Target' => '<string>', 'Tasks' => [ [ 'Name' => '<string>', 'Status' => '<string>', ], // ... ], ], ]
Result Details
Members
- BlueGreenDeployment
-
- Type: BlueGreenDeployment structure
Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- SourceDatabaseNotSupportedFault:
The source DB instance isn't supported for a blue/green deployment.
- SourceClusterNotSupportedFault:
The source DB cluster isn't supported for a blue/green deployment.
- BlueGreenDeploymentAlreadyExistsFault:
A blue/green deployment with the specified name already exists.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.- InstanceQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB instances.
- DBClusterQuotaExceededFault:
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
Examples
Example 1: To create a blue/green deployment for an RDS for MySQL DB instance
The following example creates a blue/green deployment for a MySQL DB instance.
$result = $client->createBlueGreenDeployment([ 'BlueGreenDeploymentName' => 'bgd-test-instance', 'Source' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', 'TargetDBParameterGroupName' => 'mysql-80-group', 'TargetEngineVersion' => '8.0', ]);
Result syntax:
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => 'bgd-v53303651eexfake', 'BlueGreenDeploymentName' => 'bgd-cli-test-instance', 'CreateTime' =>, 'Source' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', 'Status' => 'PROVISIONING', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3', ], ], 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'PENDING', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'PENDING', ], [ 'Name' => 'CONFIGURE_BACKUPS', 'Status' => 'PENDING', ], [ 'Name' => 'CREATING_TOPOLOGY_OF_SOURCE', 'Status' => 'PENDING', ], ], ], ]
Example 2: To create a blue/green deployment for an Aurora MySQL DB cluster
The following example creates a blue/green deployment for an Aurora MySQL DB cluster.
$result = $client->createBlueGreenDeployment([ 'BlueGreenDeploymentName' => 'my-blue-green-deployment', 'Source' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'TargetDBClusterParameterGroupName' => 'mysql-80-cluster-group', 'TargetDBParameterGroupName' => 'ams-80-binlog-enabled', 'TargetEngineVersion' => '8.0', ]);
Result syntax:
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', 'BlueGreenDeploymentName' => 'my-blue-green-deployment', 'CreateTime' =>, 'Source' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Status' => 'PROVISIONING', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Status' => 'PROVISIONING', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1', 'Status' => 'PROVISIONING', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2', 'Status' => 'PROVISIONING', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3', 'Status' => 'PROVISIONING', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint', 'Status' => 'PROVISIONING', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint', 'Status' => 'PROVISIONING', ], ], 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'PENDING', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'PENDING', ], [ 'Name' => 'CREATE_DB_INSTANCES_FOR_CLUSTER', 'Status' => 'PENDING', ], [ 'Name' => 'CREATE_CUSTOM_ENDPOINTS', 'Status' => 'PENDING', ], ], ], ]
CreateCustomDBEngineVersion
$result = $client->createCustomDBEngineVersion
([/* ... */]); $promise = $client->createCustomDBEngineVersionAsync
([/* ... */]);
Creates a custom DB engine version (CEV).
Parameter Syntax
$result = $client->createCustomDBEngineVersion([ 'DatabaseInstallationFilesS3BucketName' => '<string>', 'DatabaseInstallationFilesS3Prefix' => '<string>', 'Description' => '<string>', 'Engine' => '<string>', // REQUIRED 'EngineVersion' => '<string>', // REQUIRED 'ImageId' => '<string>', 'KMSKeyId' => '<string>', 'Manifest' => '<string>', 'SourceCustomDbEngineVersionIdentifier' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'UseAwsProvidedLatestImage' => true || false, ]);
Parameter Details
Members
- DatabaseInstallationFilesS3BucketName
-
- Type: string
The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is
my-custom-installation-files
. - DatabaseInstallationFilesS3Prefix
-
- Type: string
The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is
123456789012/cev1
. If this setting isn't specified, no prefix is assumed. - Description
-
- Type: string
An optional description of your CEV.
- Engine
-
- Required: Yes
- Type: string
The database engine. RDS Custom for Oracle supports the following values:
-
custom-oracle-ee
-
custom-oracle-ee-cdb
-
custom-oracle-se2
-
custom-oracle-se2-cdb
- EngineVersion
-
- Required: Yes
- Type: string
The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is
19.my_cev1
. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination ofEngine
andEngineVersion
is unique per customer per Region. - ImageId
-
- Type: string
The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
- KMSKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
- Manifest
-
- Type: string
The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
- MediaImportTemplateVersion
-
Version of the CEV manifest. The date is in the format
YYYY-MM-DD
. - databaseInstallationFileNames
-
Ordered list of installation files for the CEV.
- opatchFileNames
-
Ordered list of OPatch installers used for the Oracle DB engine.
- psuRuPatchFileNames
-
The PSU and RU patches for this CEV.
- OtherPatchFileNames
-
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
- SourceCustomDbEngineVersionIdentifier
-
- Type: string
The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either
Source
orUseAwsProvidedLatestImage
. You can't specify a different JSON manifest when you specifySourceCustomDbEngineVersionIdentifier
. - Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- UseAwsProvidedLatestImage
-
- Type: boolean
Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify
UseAwsProvidedLatestImage
, you can't also specifyImageId
.
Result Syntax
[ 'CreateTime' => <DateTime>, 'CustomDBEngineVersionManifest' => '<string>', 'DBEngineDescription' => '<string>', 'DBEngineMediaType' => '<string>', 'DBEngineVersionArn' => '<string>', 'DBEngineVersionDescription' => '<string>', 'DBParameterGroupFamily' => '<string>', 'DatabaseInstallationFilesS3BucketName' => '<string>', 'DatabaseInstallationFilesS3Prefix' => '<string>', 'DefaultCharacterSet' => [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], 'Engine' => '<string>', 'EngineVersion' => '<string>', 'ExportableLogTypes' => ['<string>', ...], 'Image' => [ 'ImageId' => '<string>', 'Status' => '<string>', ], 'KMSKeyId' => '<string>', 'MajorEngineVersion' => '<string>', 'ServerlessV2FeaturesSupport' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, ], 'Status' => '<string>', 'SupportedCACertificateIdentifiers' => ['<string>', ...], 'SupportedCharacterSets' => [ [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], // ... ], 'SupportedEngineModes' => ['<string>', ...], 'SupportedFeatureNames' => ['<string>', ...], 'SupportedNcharCharacterSets' => [ [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], // ... ], 'SupportedTimezones' => [ [ 'TimezoneName' => '<string>', ], // ... ], 'SupportsBabelfish' => true || false, 'SupportsCertificateRotationWithoutRestart' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIntegrations' => true || false, 'SupportsLimitlessDatabase' => true || false, 'SupportsLocalWriteForwarding' => true || false, 'SupportsLogExportsToCloudwatchLogs' => true || false, 'SupportsParallelQuery' => true || false, 'SupportsReadReplica' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ValidUpgradeTarget' => [ [ 'AutoUpgrade' => true || false, 'Description' => '<string>', 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IsMajorVersionUpgrade' => true || false, 'SupportedEngineModes' => ['<string>', ...], 'SupportsBabelfish' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIntegrations' => true || false, 'SupportsLimitlessDatabase' => true || false, 'SupportsLocalWriteForwarding' => true || false, 'SupportsParallelQuery' => true || false, ], // ... ], ]
Result Details
Members
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the DB engine version.
- CustomDBEngineVersionManifest
-
- Type: string
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
- DBEngineDescription
-
- Type: string
The description of the database engine.
- DBEngineMediaType
-
- Type: string
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
- DBEngineVersionArn
-
- Type: string
The ARN of the custom engine version.
- DBEngineVersionDescription
-
- Type: string
The description of the database engine version.
- DBParameterGroupFamily
-
- Type: string
The name of the DB parameter group family for the database engine.
- DatabaseInstallationFilesS3BucketName
-
- Type: string
The name of the Amazon S3 bucket that contains your database installation files.
- DatabaseInstallationFilesS3Prefix
-
- Type: string
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
- DefaultCharacterSet
-
- Type: CharacterSet structure
The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn't specified. - Engine
-
- Type: string
The name of the database engine.
- EngineVersion
-
- Type: string
The version number of the database engine.
- ExportableLogTypes
-
- Type: Array of strings
The types of logs that the database engine has available for export to CloudWatch Logs.
- Image
-
- Type: CustomDBEngineVersionAMI structure
The EC2 image
- KMSKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
- MajorEngineVersion
-
- Type: string
The major engine version of the CEV.
- ServerlessV2FeaturesSupport
-
- Type: ServerlessV2FeaturesSupport structure
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
- Status
-
- Type: string
The status of the DB engine version, either
available
ordeprecated
. - SupportedCACertificateIdentifiers
-
- Type: Array of strings
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- SupportedCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation. - SupportedEngineModes
-
- Type: Array of strings
A list of the supported DB engine modes.
- SupportedFeatureNames
-
- Type: Array of strings
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output. - SupportedNcharCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation. - SupportedTimezones
-
- Type: Array of Timezone structures
A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action. - SupportsBabelfish
-
- Type: boolean
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- SupportsCertificateRotationWithoutRestart
-
- Type: boolean
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
- SupportsGlobalDatabases
-
- Type: boolean
Indicates whether you can use Aurora global databases with a specific DB engine version.
- SupportsIntegrations
-
- Type: boolean
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
- SupportsLimitlessDatabase
-
- Type: boolean
Indicates whether the DB engine version supports Aurora Limitless Database.
- SupportsLocalWriteForwarding
-
- Type: boolean
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
- SupportsLogExportsToCloudwatchLogs
-
- Type: boolean
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
- SupportsParallelQuery
-
- Type: boolean
Indicates whether you can use Aurora parallel query with a specific DB engine version.
- SupportsReadReplica
-
- Type: boolean
Indicates whether the database engine version supports read replicas.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- ValidUpgradeTarget
-
- Type: Array of UpgradeTarget structures
A list of engine versions that this database engine version can be upgraded to.
Errors
- CustomDBEngineVersionAlreadyExistsFault:
A CEV with the specified name already exists.
- CustomDBEngineVersionQuotaExceededFault:
You have exceeded your CEV quota.
- Ec2ImagePropertiesNotSupportedFault:
The AMI configuration prerequisite has not been met.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- CreateCustomDBEngineVersionFault:
An error occurred while trying to create the CEV.
CreateDBCluster
$result = $client->createDBCluster
([/* ... */]); $promise = $client->createDBClusterAsync
([/* ... */]);
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier
parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
You can also use the ReplicationSourceIdentifier
parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->createDBCluster([ 'AllocatedStorage' => <integer>, 'AutoMinorVersionUpgrade' => true || false, 'AvailabilityZones' => ['<string>', ...], 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'CharacterSetName' => '<string>', 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'DBClusterIdentifier' => '<string>', // REQUIRED 'DBClusterInstanceClass' => '<string>', 'DBClusterParameterGroupName' => '<string>', 'DBSubnetGroupName' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'DestinationRegion' => '<string>', 'Domain' => '<string>', 'DomainIAMRoleName' => '<string>', 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableGlobalWriteForwarding' => true || false, 'EnableHttpEndpoint' => true || false, 'EnableIAMDatabaseAuthentication' => true || false, 'EnableLimitlessDatabase' => true || false, 'EnableLocalWriteForwarding' => true || false, 'EnablePerformanceInsights' => true || false, 'Engine' => '<string>', // REQUIRED 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'ManageMasterUserPassword' => true || false, 'MasterUserPassword' => '<string>', 'MasterUserSecretKmsKeyId' => '<string>', 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreSignedUrl' => '<string>', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfiguration' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'SourceRegion' => '<string>', 'StorageEncrypted' => true || false, 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AllocatedStorage
-
- Type: int
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
- AutoMinorVersionUpgrade
-
- Type: boolean
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
- AvailabilityZones
-
- Type: Array of strings
A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.
For information on AZs, see Availability Zones in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Constraints:
-
Can't specify more than three AZs.
- BacktrackWindow
-
- Type: long (int|float)
The target backtrack window, in seconds. To disable backtracking, set this value to
0
.Valid for Cluster Type: Aurora MySQL DB clusters only
Default:
0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
- BackupRetentionPeriod
-
- Type: int
The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default:
1
Constraints:
-
Must be a value from 1 to 35.
- CACertificateIdentifier
-
- Type: string
The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
- CharacterSetName
-
- Type: string
The name of the character set (
CharacterSet
) to associate the DB cluster with.Valid for Cluster Type: Aurora DB clusters only
- ClusterScalabilityType
-
- Type: string
Specifies the scalability mode of the Aurora DB cluster. When set to
limitless
, the cluster operates as an Aurora Limitless Database. When set tostandard
(the default), the cluster uses normal DB instance creation.Valid for: Aurora DB clusters only
You can't modify this setting after you create the DB cluster.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The identifier for this DB cluster. This parameter is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
- DBClusterInstanceClass
-
- Type: string
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.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.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
- DBClusterParameterGroupName
-
- Type: string
The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
If supplied, must match the name of an existing DB cluster parameter group.
- DBSubnetGroupName
-
- Type: string
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Must match the name of an existing DB subnet group.
Example:
mydbsubnetgroup
- DBSystemId
-
- Type: string
Reserved for future use.
- DatabaseInsightsMode
-
- Type: string
Specifies the mode of Database Insights to enable for the cluster.
- DatabaseName
-
- Type: string
The name for your database of up to 64 alphanumeric characters. A database named
postgres
is always created. If this parameter is specified, an additional database with this name is created.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- DeletionProtection
-
- Type: boolean
Specifies 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- DestinationRegion
-
- Type: string
The SDK will populate this parameter on your behalf using the configured region value of the client. - Domain
-
- Type: string
The Active Directory directory ID to create the DB cluster in.
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 Cluster Type: Aurora DB clusters only
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of log types that need to be enabled for exporting to CloudWatch Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
-
Aurora MySQL -
audit | error | general | slowquery
-
Aurora PostgreSQL -
postgresql
-
RDS for MySQL -
error | general | slowquery
-
RDS for PostgreSQL -
postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
- EnableGlobalWriteForwarding
-
- Type: boolean
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
- EnableHttpEndpoint
-
- Type: boolean
Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
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.
RDS Data API is supported with the following DB clusters:
-
Aurora PostgreSQL Serverless v2 and provisioned
-
Aurora PostgreSQL and Aurora MySQL Serverless v1
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies 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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- EnableLimitlessDatabase
-
- Type: boolean
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
This setting is no longer used. Instead use the
ClusterScalabilityType
setting. - EnableLocalWriteForwarding
-
- Type: boolean
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
- EnablePerformanceInsights
-
- Type: boolean
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
- Engine
-
- Required: Yes
- Type: string
The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
-
aurora-mysql
-
aurora-postgresql
-
mysql
-
postgres
-
neptune
- For information about using Amazon Neptune, see the Amazon Neptune User Guide .
- EngineLifecycleSupport
-
- Type: string
The life cycle type for this DB cluster.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
-
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
-
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- EngineMode
-
- Type: string
The DB engine mode of the DB cluster, either
provisioned
orserverless
.The
serverless
engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use theprovisioned
engine mode.For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:
Valid for Cluster Type: Aurora DB clusters only
- EngineVersion
-
- Type: string
The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either
5.7
or8.0
to use the default engine version for Aurora MySQL version 2 or version 3, respectively.To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
For information about a specific engine, see the following topics:
-
Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
-
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
-
RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.
-
RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- GlobalClusterIdentifier
-
- Type: string
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for Cluster Type: Aurora DB clusters only
- Iops
-
- Type: int
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 Provisioned IOPS storage in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
-
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for 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.
When a KMS key isn't specified in
KmsKeyId
:-
If
ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key. -
If the
StorageEncrypted
parameter is enabled andReplicationSourceIdentifier
isn't specified, then Amazon RDS uses your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set
KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- ManageMasterUserPassword
-
- Type: boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
- MasterUserPassword
-
- Type: string
The password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Must contain from 8 to 41 characters.
-
Can contain any printable ASCII character except "/", """, or "@".
-
Can't be specified if
ManageMasterUserPassword
is turned on.
- MasterUserSecretKmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the 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.
If you don't specify
MasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- MasterUsername
-
- Type: string
The name of the master user for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Must be 1 to 16 letters or numbers.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify
0
.If
MonitoringRoleArn
is specified, also setMonitoringInterval
to a value other than0
.Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
0
- MonitoringRoleArn
-
- Type: string
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than0
, supply aMonitoringRoleArn
value.Valid for Cluster Type: Multi-AZ DB clusters only
- NetworkType
-
- Type: string
The network type of the DB cluster.
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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.
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
IPV4 | DUAL
- OptionGroupName
-
- Type: string
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
If you don't specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.Valid for Cluster Type: Multi-AZ DB clusters only
- PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
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
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS issues an error. - Port
-
- Type: int
The port number on which the instances in the DB cluster accept connections.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
1150-65535
Default:
-
RDS for MySQL and Aurora MySQL -
3306
-
RDS for PostgreSQL and Aurora PostgreSQL -
5432
- PreSignedUrl
-
- Type: string
The SDK will compute this value for you on your behalf. - PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
- PreferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
-
Must be in the format
ddd:hh24:mi-ddd:hh24:mi
. -
Days must be one of
Mon | Tue | Wed | Thu | Fri | Sat | Sun
. -
Must be in Universal Coordinated Time (UTC).
-
Must be at least 30 minutes.
- PubliclyAccessible
-
- Type: boolean
Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. 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.
Valid for Cluster Type: Multi-AZ DB clusters only
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.
- RdsCustomClusterConfiguration
-
- Type: RdsCustomClusterConfiguration structure
Reserved for future use.
- ReplicationSourceIdentifier
-
- Type: string
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- ScalingConfiguration
-
- Type: ScalingConfiguration structure
For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for Cluster Type: Aurora DB clusters only
- ServerlessV2ScalingConfiguration
-
- Type: ServerlessV2ScalingConfiguration structure
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- SourceRegion
-
- Type: string
A required parameter that indicates the region that the DB snapshot will be copied from. - StorageEncrypted
-
- Type: boolean
Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- StorageType
-
- Type: string
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the
Iops
parameter is required.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
-
Aurora DB clusters -
aurora | aurora-iopt1
-
Multi-AZ DB clusters -
io1 | io2 | gp3
Default:
-
Aurora DB clusters -
aurora
-
Multi-AZ DB clusters -
io1
When you create an Aurora DB cluster with the storage type set to
aurora-iopt1
, the storage type is returned in the response. The storage type isn't returned when you set it toaurora
. - Tags
-
- Type: Array of Tag structures
Tags to assign to the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterAlreadyExistsFault:
The user already has a DB cluster with the given identifier.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
- InsufficientStorageClusterCapacityFault:
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
- DBClusterQuotaExceededFault:
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBSubnetGroupFault:
The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
- InvalidDBSubnetGroupStateFault:
The DB subnet group cannot be deleted because it's in use.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- GlobalClusterNotFoundFault:
The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster.- InvalidGlobalClusterStateFault:
The global cluster is in an invalid state and can't perform the requested operation.
- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- OptionGroupNotFoundFault:
The specified option group could not be found.
Examples
Example 1: To create a MySQL 5.7-compatible DB cluster
The following example creates a MySQL 5.7-compatible Aurora DB cluster.
$result = $client->createDBCluster([ 'DBClusterIdentifier' => 'sample-cluster', 'DBSubnetGroupName' => 'default', 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.12', 'MasterUserPassword' => 'mypassword', 'MasterUsername' => 'admin', 'VpcSecurityGroupIds' => [ 'sg-0b91305example', ], ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 1, 'AssociatedRoles' => [ ], 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1b', 'us-east-1e', ], 'BackupRetentionPeriod' => 1, 'ClusterCreateTime' =>, 'CopyTagsToSnapshot' => , 'DBClusterArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster', 'DBClusterIdentifier' => 'sample-cluster', 'DBClusterMembers' => [ ], 'DBClusterParameterGroup' => 'default.aurora-mysql5.7', 'DBSubnetGroup' => 'default', 'DbClusterResourceId' => 'cluster-ANPAJ4AE5446DAEXAMPLE', 'DeletionProtection' => , 'Endpoint' => 'sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com', 'Engine' => 'aurora-mysql', 'EngineMode' => 'provisioned', 'EngineVersion' => '5.7.12', 'HostedZoneId' => 'Z2R2ITUGPM61AM', 'HttpEndpointEnabled' => , 'IAMDatabaseAuthenticationEnabled' => , 'MasterUsername' => 'master', 'MultiAZ' => , 'Port' => 3306, 'PreferredBackupWindow' => '09:12-09:42', 'PreferredMaintenanceWindow' => 'mon:04:31-mon:05:01', 'ReadReplicaIdentifiers' => [ ], 'ReaderEndpoint' => 'sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com', 'Status' => 'creating', 'StorageEncrypted' => , 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-0b91305example', ], ], ], ]
Example 2: To create a PostgreSQL-compatible DB cluster
The following example creates a PostgreSQL-compatible Aurora DB cluster.
$result = $client->createDBCluster([ 'DBClusterIdentifier' => 'sample-pg-cluster', 'DBSubnetGroupName' => 'default', 'Engine' => 'aurora-postgresql', 'MasterUserPassword' => 'mypassword', 'MasterUsername' => 'admin', 'VpcSecurityGroupIds' => [ 'sg-0b91305example', ], ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 1, 'AssociatedRoles' => [ ], 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1b', 'us-east-1c', ], 'BackupRetentionPeriod' => 1, 'ClusterCreateTime' =>, 'CopyTagsToSnapshot' => , 'DBClusterArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster', 'DBClusterIdentifier' => 'sample-pg-cluster', 'DBClusterMembers' => [ ], 'DBClusterParameterGroup' => 'default.aurora-postgresql9.6', 'DBSubnetGroup' => 'default', 'DbClusterResourceId' => 'cluster-ANPAJ4AE5446DAEXAMPLE', 'DeletionProtection' => , 'Endpoint' => 'sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com', 'Engine' => 'aurora-postgresql', 'EngineMode' => 'provisioned', 'EngineVersion' => '9.6.9', 'HostedZoneId' => 'Z2R2ITUGPM61AM', 'HttpEndpointEnabled' => , 'IAMDatabaseAuthenticationEnabled' => , 'MasterUsername' => 'master', 'MultiAZ' => , 'Port' => 5432, 'PreferredBackupWindow' => '09:56-10:26', 'PreferredMaintenanceWindow' => 'wed:03:33-wed:04:03', 'ReadReplicaIdentifiers' => [ ], 'ReaderEndpoint' => 'sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com', 'Status' => 'creating', 'StorageEncrypted' => , 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-0b91305example', ], ], ], ]
CreateDBClusterEndpoint
$result = $client->createDBClusterEndpoint
([/* ... */]); $promise = $client->createDBClusterEndpointAsync
([/* ... */]);
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
Parameter Syntax
$result = $client->createDBClusterEndpoint([ 'DBClusterEndpointIdentifier' => '<string>', // REQUIRED 'DBClusterIdentifier' => '<string>', // REQUIRED 'EndpointType' => '<string>', // REQUIRED 'ExcludedMembers' => ['<string>', ...], 'StaticMembers' => ['<string>', ...], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DBClusterEndpointIdentifier
-
- Required: Yes
- Type: string
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
- EndpointType
-
- Required: Yes
- Type: string
The type of the endpoint, one of:
READER
,WRITER
,ANY
. - ExcludedMembers
-
- Type: Array of strings
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
- StaticMembers
-
- Type: Array of strings
List of DB instance identifiers that are part of the custom endpoint group.
- Tags
-
- Type: Array of Tag structures
The tags to be assigned to the Amazon RDS resource.
Result Syntax
[ 'CustomEndpointType' => '<string>', 'DBClusterEndpointArn' => '<string>', 'DBClusterEndpointIdentifier' => '<string>', 'DBClusterEndpointResourceIdentifier' => '<string>', 'DBClusterIdentifier' => '<string>', 'Endpoint' => '<string>', 'EndpointType' => '<string>', 'ExcludedMembers' => ['<string>', ...], 'StaticMembers' => ['<string>', ...], 'Status' => '<string>', ]
Result Details
Members
- CustomEndpointType
-
- Type: string
The type associated with a custom endpoint. One of:
READER
,WRITER
,ANY
. - DBClusterEndpointArn
-
- Type: string
The Amazon Resource Name (ARN) for the endpoint.
- DBClusterEndpointIdentifier
-
- Type: string
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
- DBClusterEndpointResourceIdentifier
-
- Type: string
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
- DBClusterIdentifier
-
- Type: string
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
- Endpoint
-
- Type: string
The DNS address of the endpoint.
- EndpointType
-
- Type: string
The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
. - ExcludedMembers
-
- Type: Array of strings
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
- StaticMembers
-
- Type: Array of strings
List of DB instance identifiers that are part of the custom endpoint group.
- Status
-
- Type: string
The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that can't be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.
Errors
- DBClusterEndpointQuotaExceededFault:
The cluster already has the maximum number of custom endpoints.
- DBClusterEndpointAlreadyExistsFault:
The specified custom endpoint can't be created because it already exists.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To create a custom DB cluster endpoint
The following example creates a custom DB cluster endpoint and associate it with the specified Aurora DB cluster.
$result = $client->createDBClusterEndpoint([ 'DBClusterEndpointIdentifier' => 'mycustomendpoint', 'DBClusterIdentifier' => 'mydbcluster', 'EndpointType' => 'reader', 'StaticMembers' => [ 'dbinstance1', 'dbinstance2', ], ]);
Result syntax:
[ 'CustomEndpointType' => 'READER', 'DBClusterEndpointArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint', 'DBClusterEndpointIdentifier' => 'mycustomendpoint', 'DBClusterEndpointResourceIdentifier' => 'cluster-endpoint-ANPAJ4AE5446DAEXAMPLE', 'DBClusterIdentifier' => 'mydbcluster', 'Endpoint' => 'mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com', 'EndpointType' => 'CUSTOM', 'ExcludedMembers' => [ ], 'StaticMembers' => [ 'dbinstance1', 'dbinstance2', ], 'Status' => 'creating', ]
CreateDBClusterParameterGroup
$result = $client->createDBClusterParameterGroup
([/* ... */]); $promise = $client->createDBClusterParameterGroupAsync
([/* ... */]);
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup
. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster
.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters
operation to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->createDBClusterParameterGroup([ 'DBClusterParameterGroupName' => '<string>', // REQUIRED 'DBParameterGroupFamily' => '<string>', // REQUIRED 'Description' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DBClusterParameterGroupName
-
- Required: Yes
- Type: string
The name of the DB cluster parameter group.
Constraints:
-
Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
- DBParameterGroupFamily
-
- Required: Yes
- Type: string
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example:
aurora-mysql5.7
,aurora-mysql8.0
Aurora PostgreSQL
Example:
aurora-postgresql14
RDS for MySQL
Example:
mysql8.0
RDS for PostgreSQL
Example:
postgres13
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
-
aurora-mysql
-
aurora-postgresql
-
mysql
-
postgres
- Description
-
- Required: Yes
- Type: string
The description for the DB cluster parameter group.
- Tags
-
- Type: Array of Tag structures
Tags to assign to the DB cluster parameter group.
Result Syntax
[ 'DBClusterParameterGroup' => [ 'DBClusterParameterGroupArn' => '<string>', 'DBClusterParameterGroupName' => '<string>', 'DBParameterGroupFamily' => '<string>', 'Description' => '<string>', ], ]
Result Details
Members
- DBClusterParameterGroup
-
- Type: DBClusterParameterGroup structure
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the
DescribeDBClusterParameterGroups
action.
Errors
- DBParameterGroupQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB parameter groups.
- DBParameterGroupAlreadyExistsFault:
A DB parameter group with the same name exists.
Examples
Example 1: To create a DB cluster parameter group
The following example creates a DB cluster parameter group.
$result = $client->createDBClusterParameterGroup([ 'DBClusterParameterGroupName' => 'mydbclusterparametergroup', 'DBParameterGroupFamily' => 'aurora5.6', 'Description' => 'My new cluster parameter group', ]);
Result syntax:
[ 'DBClusterParameterGroup' => [ 'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup', 'DBClusterParameterGroupName' => 'mydbclusterparametergroup', 'DBParameterGroupFamily' => 'aurora5.6', 'Description' => 'My new cluster parameter group', ], ]
CreateDBClusterSnapshot
$result = $client->createDBClusterSnapshot
([/* ... */]); $promise = $client->createDBClusterSnapshotAsync
([/* ... */]);
Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->createDBClusterSnapshot([ 'DBClusterIdentifier' => '<string>', // REQUIRED 'DBClusterSnapshotIdentifier' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DBCluster.
Example:
my-cluster1
- DBClusterSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
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.
Example:
my-cluster1-snapshot1
- Tags
-
- Type: Array of Tag structures
The tags to be assigned to the DB cluster snapshot.
Result Syntax
[ 'DBClusterSnapshot' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZones' => ['<string>', ...], 'ClusterCreateTime' => <DateTime>, 'DBClusterIdentifier' => '<string>', 'DBClusterSnapshotArn' => '<string>', 'DBClusterSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbClusterResourceId' => '<string>', 'Engine' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'PercentProgress' => <integer>, 'Port' => <integer>, 'SnapshotCreateTime' => <DateTime>, 'SnapshotType' => '<string>', 'SourceDBClusterSnapshotArn' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcId' => '<string>', ], ]
Result Details
Members
- DBClusterSnapshot
-
- Type: DBClusterSnapshot structure
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
Errors
- DBClusterSnapshotAlreadyExistsFault:
The user already has a DB cluster snapshot with the given identifier.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- SnapshotQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDBClusterSnapshotStateFault:
The supplied value isn't a valid DB cluster snapshot state.
Examples
Example 1: To create a DB cluster snapshot
The following example creates a DB cluster snapshot.
$result = $client->createDBClusterSnapshot([ 'DBClusterIdentifier' => 'mydbclustersnapshot', 'DBClusterSnapshotIdentifier' => 'mydbcluster', ]);
Result syntax:
[ 'DBClusterSnapshot' => [ 'AllocatedStorage' => 1, 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1b', 'us-east-1e', ], 'ClusterCreateTime' =>, 'DBClusterIdentifier' => 'mydbcluster', 'DBClusterSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot', 'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot', 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.04.2', 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', 'LicenseModel' => 'aurora-mysql', 'MasterUsername' => 'myadmin', 'PercentProgress' => 0, 'Port' => 0, 'SnapshotCreateTime' => , 'SnapshotType' => 'manual', 'Status' => 'creating', 'StorageEncrypted' => 1, 'VpcId' => 'vpc-6594f31c', ], ]
CreateDBInstance
$result = $client->createDBInstance
([/* ... */]); $promise = $client->createDBInstanceAsync
([/* ... */]);
Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->createDBInstance([ 'AllocatedStorage' => <integer>, 'AutoMinorVersionUpgrade' => true || false, 'AvailabilityZone' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBInstanceClass' => '<string>', // REQUIRED 'DBInstanceIdentifier' => '<string>', // REQUIRED 'DBName' => '<string>', 'DBParameterGroupName' => '<string>', 'DBSecurityGroups' => ['<string>', ...], 'DBSubnetGroupName' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'Domain' => '<string>', 'DomainAuthSecretArn' => '<string>', 'DomainDnsIps' => ['<string>', ...], 'DomainFqdn' => '<string>', 'DomainIAMRoleName' => '<string>', 'DomainOu' => '<string>', 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableCustomerOwnedIp' => true || false, 'EnableIAMDatabaseAuthentication' => true || false, 'EnablePerformanceInsights' => true || false, 'Engine' => '<string>', // REQUIRED 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'ManageMasterUserPassword' => true || false, 'MasterUserPassword' => '<string>', 'MasterUserSecretKmsKeyId' => '<string>', 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'TdeCredentialPassword' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AllocatedStorage
-
- Type: int
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
- Amazon RDS Custom
-
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
-
Provisioned IOPS storage (io1, io2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
-
- RDS for Db2
-
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
-
- RDS for MariaDB
-
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
-
- RDS for MySQL
-
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
-
- RDS for Oracle
-
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 10 to 3072.
-
- RDS for PostgreSQL
-
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
-
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
-
- RDS for SQL Server
-
Constraints to the amount of storage for each storage type are the following:
-
General Purpose (SSD) storage (gp2, gp3):
-
Enterprise and Standard editions: Must be an integer from 20 to 16384.
-
Web and Express editions: Must be an integer from 20 to 16384.
-
-
Provisioned IOPS storage (io1, io2):
-
Enterprise and Standard editions: Must be an integer from 100 to 16384.
-
Web and Express editions: Must be an integer from 100 to 16384.
-
-
Magnetic storage (standard):
-
Enterprise and Standard editions: Must be an integer from 20 to 1024.
-
Web and Express editions: Must be an integer from 20 to 1024.
-
-
- AutoMinorVersionUpgrade
-
- Type: boolean
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set
AutoMinorVersionUpgrade
tofalse
. - AvailabilityZone
-
- Type: string
The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Constraints:
-
The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. -
The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
Example:
us-east-1d
- BackupRetentionPeriod
-
- Type: int
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to
0
disables automated backups.This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.
Default:
1
Constraints:
-
Must be a value from 0 to 35.
-
Can't be set to 0 if the DB instance is a source to read replicas.
-
Can't be set to 0 for an RDS Custom for Oracle DB instance.
- BackupTarget
-
- Type: string
The location for storing automated backups and manual snapshots.
Valid Values:
-
outposts
(Amazon Web Services Outposts) -
region
(Amazon Web Services Region)
Default:
region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- CACertificateIdentifier
-
- Type: string
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- CharacterSetName
-
- Type: string
For supported engines, the character set (
CharacterSet
) to associate the DB instance with.This setting doesn't apply to the following DB instances:
-
Amazon Aurora - The character set is managed by the DB cluster. For more information, see
CreateDBCluster
. -
RDS Custom - However, if you need to change the character set, you can change it on the database itself.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- CustomIamInstanceProfile
-
- Type: string
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
- DBClusterIdentifier
-
- Type: string
The identifier of the DB cluster that this DB instance will belong to.
This setting doesn't apply to RDS Custom DB instances.
- DBInstanceClass
-
- Required: Yes
- Type: string
The compute and memory capacity of the DB instance, for example
db.m5.large
. 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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - DBInstanceIdentifier
-
- Required: Yes
- Type: string
The identifier for this DB instance. This parameter is stored as a lowercase string.
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.
Example:
mydbinstance
- DBName
-
- Type: string
The meaning of this parameter differs according to the database engine you use.
- Amazon Aurora MySQL
-
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
-
Must contain 1 to 64 alphanumeric characters.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
-
Can't be a word reserved by the database engine.
-
- Amazon Aurora PostgreSQL
-
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. A database named
postgres
is always created. If this parameter is specified, an additional database with this name is created.Constraints:
-
It must contain 1 to 63 alphanumeric characters.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
-
Can't be a word reserved by the database engine.
-
- Amazon RDS Custom for Oracle
-
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is
ORCL
for non-CDBs andRDSCDB
for CDBs.Default:
ORCL
Constraints:
-
Must contain 1 to 8 alphanumeric characters.
-
Must contain a letter.
-
Can't be a word reserved by the database engine.
-
- Amazon RDS Custom for SQL Server
-
Not applicable. Must be null.
- RDS for Db2
-
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. In some cases, we recommend that you don't add a database name. For more information, see Additional considerations in the Amazon RDS User Guide.
Constraints:
-
Must contain 1 to 64 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
-
Can't be a word reserved by the specified database engine.
-
- RDS for MariaDB
-
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
-
Must contain 1 to 64 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
-
Can't be a word reserved by the specified database engine.
-
- RDS for MySQL
-
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
-
Must contain 1 to 64 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
-
Can't be a word reserved by the specified database engine.
-
- RDS for Oracle
-
The Oracle System ID (SID) of the created DB instance. If you don't specify a value, the default value is
ORCL
. You can't specify the stringnull
, or any other reserved word, forDBName
.Default:
ORCL
Constraints:
-
Can't be longer than 8 characters.
-
- RDS for PostgreSQL
-
The name of the database to create when the DB instance is created. A database named
postgres
is always created. If this parameter is specified, an additional database with this name is created.Constraints:
-
Must contain 1 to 63 letters, numbers, or underscores.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
-
Can't be a word reserved by the specified database engine.
-
- RDS for SQL Server
-
Not applicable. Must be null.
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
-
Must be 1 to 255 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
- DBSecurityGroups
-
- Type: Array of strings
A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the
VpcSecurityGroupIds
setting instead. - DBSubnetGroupName
-
- Type: string
A DB subnet group to associate with this DB instance.
Constraints:
-
Must match the name of an existing DB subnet group.
Example:
mydbsubnetgroup
- DBSystemId
-
- Type: string
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - DatabaseInsightsMode
-
- Type: string
Specifies the mode of Database Insights to enable for the instance.
- DedicatedLogVolume
-
- Type: boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- DeletionProtection
-
- Type: boolean
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - Domain
-
- Type: string
The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (The domain is managed by the DB cluster.)
-
RDS Custom
- DomainAuthSecretArn
-
- Type: string
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- DomainDnsIps
-
- Type: Array of strings
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
-
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example:
123.124.125.126,234.235.236.237
- DomainFqdn
-
- Type: string
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
-
Can't be longer than 64 characters.
Example:
mymanagedADtest.mymanagedAD.mydomain
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (The domain is managed by the DB cluster.)
-
RDS Custom
- DomainOu
-
- Type: string
The Active Directory organizational unit for your DB instance to join.
Constraints:
-
Must be in the distinguished name format.
-
Can't be longer than 64 characters.
Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of log types to enable for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
-
RDS Custom
The following values are valid for each DB engine:
-
RDS for Db2 -
diag.log | notify.log
-
RDS for MariaDB -
audit | error | general | slowquery
-
RDS for Microsoft SQL Server -
agent | error
-
RDS for MySQL -
audit | error | general | slowquery
-
RDS for Oracle -
alert | audit | listener | trace | oemagent
-
RDS for PostgreSQL -
postgresql | upgrade
- EnableCustomerOwnedIp
-
- Type: boolean
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies 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 for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)
-
RDS Custom
- EnablePerformanceInsights
-
- Type: boolean
Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- Engine
-
- Required: Yes
- Type: string
The database engine to use for this DB instance.
Not every database engine is available in every Amazon Web Services Region.
Valid Values:
-
aurora-mysql
(for Aurora MySQL DB instances) -
aurora-postgresql
(for Aurora PostgreSQL DB instances) -
custom-oracle-ee
(for RDS Custom for Oracle DB instances) -
custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) -
custom-oracle-se2
(for RDS Custom for Oracle DB instances) -
custom-oracle-se2-cdb
(for RDS Custom for Oracle DB instances) -
custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) -
custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) -
custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) -
custom-sqlserver-dev
(for RDS Custom for SQL Server DB instances) -
db2-ae
-
db2-se
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
- EngineLifecycleSupport
-
- Type: string
The life cycle type for this DB instance.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- EngineVersion
-
- Type: string
The version number of the database engine to use.
This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.
For a list of valid engine versions, use the
DescribeDBEngineVersions
operation.The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
- Amazon RDS Custom for Oracle
-
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is
19.my_cev1
. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide. - Amazon RDS Custom for SQL Server
-
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.
- RDS for Db2
-
For information, see Db2 on Amazon RDS versions in the Amazon RDS User Guide.
- RDS for MariaDB
-
For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide.
- RDS for Microsoft SQL Server
-
For information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide.
- RDS for MySQL
-
For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide.
- RDS for Oracle
-
For information, see Oracle Database Engine release notes in the Amazon RDS User Guide.
- RDS for PostgreSQL
-
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
- Iops
-
- Type: int
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Constraints:
-
For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
-
For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted DB instance.
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.
This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster
.If
StorageEncrypted
is enabled, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling
StorageEncrypted
, the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key. - LicenseModel
-
- Type: string
The license model information for this DB instance.
License models for RDS for Db2 require additional configuration. The Bring Your Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide.
The default for RDS for Db2 is
bring-your-own-license
.This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
-
RDS for Db2 -
bring-your-own-license | marketplace-license
-
RDS for MariaDB -
general-public-license
-
RDS for Microsoft SQL Server -
license-included
-
RDS for MySQL -
general-public-license
-
RDS for Oracle -
bring-your-own-license | license-included
-
RDS for PostgreSQL -
postgresql-license
- ManageMasterUserPassword
-
- Type: boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
- MasterUserPassword
-
- Type: string
The password for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.
Constraints:
-
Can't be specified if
ManageMasterUserPassword
is turned on. -
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
-
RDS for Db2 - Must contain from 8 to 255 characters.
-
RDS for MariaDB - Must contain from 8 to 41 characters.
-
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
-
RDS for MySQL - Must contain from 8 to 41 characters.
-
RDS for Oracle - Must contain from 8 to 30 characters.
-
RDS for PostgreSQL - Must contain from 8 to 128 characters.
- MasterUserSecretKmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
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.
If you don't specify
MasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
- MasterUsername
-
- Type: string
The name for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.
This setting is required for RDS DB instances.
Constraints:
-
Must be 1 to 16 letters, numbers, or underscores.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
- MaxAllocatedStorage
-
- Type: int
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (Storage is managed by the DB cluster.)
-
RDS Custom
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify
0
.If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than0
.This setting doesn't apply to RDS Custom DB instances.
Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
0
- MonitoringRoleArn
-
- Type: string
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value.This setting doesn't apply to RDS Custom DB instances.
- MultiAZ
-
- Type: boolean
Specifies whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.This setting doesn't apply to the following DB instances:
-
Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
-
RDS Custom
- MultiTenant
-
- Type: boolean
Specifies whether to use the multi-tenant configuration or the single-tenant configuration (default). This parameter only applies to RDS for Oracle container database (CDB) engines.
Note the following restrictions:
-
The DB engine that you specify in the request must support the multi-tenant configuration. If you attempt to enable the multi-tenant configuration on a DB engine that doesn't support it, the request fails.
-
If you specify the multi-tenant configuration when you create your DB instance, you can't later modify this DB instance to use the single-tenant configuration.
- NcharCharacterSetName
-
- Type: string
The name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
- NetworkType
-
- Type: string
The network type of the DB instance.
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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 RDS User Guide.
Valid Values:
IPV4 | DUAL
- OptionGroupName
-
- Type: string
The option group to associate the DB instance with.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
If you don't specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.This setting doesn't apply to RDS Custom DB instances.
- PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
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
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS returns an error. - Port
-
- Type: int
The port number on which the database accepts connections.
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values:
1150-65535
Default:
-
RDS for Db2 -
50000
-
RDS for MariaDB -
3306
-
RDS for Microsoft SQL Server -
1433
-
RDS for MySQL -
3306
-
RDS for Oracle -
1521
-
RDS for PostgreSQL -
5432
Constraints:
-
For RDS for Microsoft SQL Server, the value can't be
1234
,1434
,3260
,3343
,3389
,47001
, or49152-49156
.
- PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
- PreferredMaintenanceWindow
-
- Type: string
The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Constraints:
-
Must be in the format
ddd:hh24:mi-ddd:hh24:mi
. -
The day values must be
mon | tue | wed | thu | fri | sat | sun
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred backup window.
-
Must be at least 30 minutes.
- ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- PromotionTier
-
- Type: int
The order of priority 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.
This setting doesn't apply to RDS Custom DB instances.
Default:
1
Valid Values:
0 - 15
- PubliclyAccessible
-
- Type: boolean
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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.
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 instance is private.
-
If the default VPC in the target Region has an internet gateway attached to it, the DB instance 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 instance is private.
-
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
- StorageEncrypted
-
- Type: boolean
Specifes whether the DB instance is encrypted. By default, it isn't encrypted.
For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.
This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
- StorageThroughput
-
- Type: int
The storage throughput value for the DB instance.
This setting applies only to the
gp3
storage type.This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- StorageType
-
- Type: string
The storage type to associate with the DB instance.
If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter.This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values:
gp2 | gp3 | io1 | io2 | standard
Default:
io1
, if theIops
parameter is specified. Otherwise,gp2
. - Tags
-
- Type: Array of Tag structures
Tags to assign to the DB instance.
- TdeCredentialArn
-
- Type: string
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- TdeCredentialPassword
-
- Type: string
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom DB instances.
- Timezone
-
- Type: string
The time zone of the DB instance. The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server.
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of Amazon EC2 VPC security groups to associate with this DB instance.
This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceAlreadyExistsFault:
The user already has a DB instance with the given identifier.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.- InstanceQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAZFault:
Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- StorageTypeNotSupportedFault:
The specified
StorageType
can't be associated with the DB instance.- AuthorizationNotFoundFault:
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- BackupPolicyNotFoundFault:
- This error does not currently have a description.
- NetworkTypeNotSupported:
The network type is invalid for the DB instance. Valid nework type values are
IPV4
andDUAL
.- CertificateNotFoundFault:
CertificateIdentifier
doesn't refer to an existing certificate.- TenantDatabaseQuotaExceededFault:
You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
Examples
Example 1: To create a DB instance
The following example uses the required options to launch a new DB instance.
$result = $client->createDBInstance([ 'AllocatedStorage' => 20, 'DBInstanceClass' => 'db.t3.micro', 'DBInstanceIdentifier' => 'test-mysql-instance', 'Engine' => 'mysql', 'MasterUserPassword' => 'secret99', 'MasterUsername' => 'admin', ]);
Result syntax:
[ 'DBInstance' => [ 'AllocatedStorage' => 20, 'AssociatedRoles' => [ ], 'AutoMinorVersionUpgrade' => 1, 'BackupRetentionPeriod' => 1, 'CACertificateIdentifier' => 'rds-ca-2019', 'CopyTagsToSnapshot' => , 'DBInstanceArn' => 'arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance', 'DBInstanceClass' => 'db.t3.micro', 'DBInstanceIdentifier' => 'test-mysql-instance', 'DBInstanceStatus' => 'creating', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => 'default.mysql5.7', 'ParameterApplyStatus' => 'in-sync', ], ], 'DBSecurityGroups' => [ ], 'DBSubnetGroup' => [ 'DBSubnetGroupDescription' => 'default', 'DBSubnetGroupName' => 'default', 'SubnetGroupStatus' => 'Complete', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2c', ], 'SubnetIdentifier' => 'subnet-########', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2d', ], 'SubnetIdentifier' => 'subnet-########', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2a', ], 'SubnetIdentifier' => 'subnet-########', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2b', ], 'SubnetIdentifier' => 'subnet-########', 'SubnetStatus' => 'Active', ], ], 'VpcId' => 'vpc-2ff2ff2f', ], 'DbInstancePort' => 0, 'DbiResourceId' => 'db-5555EXAMPLE44444444EXAMPLE', 'DeletionProtection' => , 'DomainMemberships' => [ ], 'Engine' => 'mysql', 'EngineVersion' => '5.7.22', 'IAMDatabaseAuthenticationEnabled' => , 'LicenseModel' => 'general-public-license', 'MasterUsername' => 'admin', 'MonitoringInterval' => 0, 'MultiAZ' => , 'OptionGroupMemberships' => [ [ 'OptionGroupName' => 'default:mysql-5-7', 'Status' => 'in-sync', ], ], 'PendingModifiedValues' => [ 'MasterUserPassword' => '****', ], 'PerformanceInsightsEnabled' => , 'PreferredBackupWindow' => '12:55-13:25', 'PreferredMaintenanceWindow' => 'sun:08:07-sun:08:37', 'PubliclyAccessible' => 1, 'ReadReplicaDBInstanceIdentifiers' => [ ], 'StorageEncrypted' => , 'StorageType' => 'gp2', 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-12345abc', ], ], ], ]
CreateDBInstanceReadReplica
$result = $client->createDBInstanceReadReplica
([/* ... */]); $promise = $client->createDBInstanceReadReplicaAsync
([/* ... */]);
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance
operation.
All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
Parameter Syntax
$result = $client->createDBInstanceReadReplica([ 'AllocatedStorage' => <integer>, 'AutoMinorVersionUpgrade' => true || false, 'AvailabilityZone' => '<string>', 'CACertificateIdentifier' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', // REQUIRED 'DBParameterGroupName' => '<string>', 'DBSubnetGroupName' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DestinationRegion' => '<string>', 'Domain' => '<string>', 'DomainAuthSecretArn' => '<string>', 'DomainDnsIps' => ['<string>', ...], 'DomainFqdn' => '<string>', 'DomainIAMRoleName' => '<string>', 'DomainOu' => '<string>', 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableCustomerOwnedIp' => true || false, 'EnableIAMDatabaseAuthentication' => true || false, 'EnablePerformanceInsights' => true || false, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreSignedUrl' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PubliclyAccessible' => true || false, 'ReplicaMode' => 'open-read-only|mounted', 'SourceDBClusterIdentifier' => '<string>', 'SourceDBInstanceIdentifier' => '<string>', 'SourceRegion' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'UpgradeStorageConfig' => true || false, 'UseDefaultProcessorFeatures' => true || false, 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AllocatedStorage
-
- Type: int
The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in
CreateDBInstance
.Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
- AutoMinorVersionUpgrade
-
- Type: boolean
Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.
This setting doesn't apply to RDS Custom DB instances.
Default: Inherits the value from the source DB instance.
- AvailabilityZone
-
- Type: string
The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example:
us-east-1d
- CACertificateIdentifier
-
- Type: string
The CA certificate identifier to use for the read replica's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren't copied.
- CustomIamInstanceProfile
-
- Type: string
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom DB instances.
- DBInstanceClass
-
- Type: string
The compute and memory capacity of the read replica, for example db.m4.large. 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.
Default: Inherits the value from the source DB instance.
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group to associate with this read replica DB instance.
For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a value for
DBParameterGroupName
, then Amazon RDS uses theDBParameterGroup
of the source DB instance for a same Region read replica, or the defaultDBParameterGroup
for the specified DB engine for a cross-Region read replica.For Multi-AZ DB cluster same Region read replica instances, if you don't specify a value for
DBParameterGroupName
, then Amazon RDS uses the defaultDBParameterGroup
.Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas, for Multi-AZ DB cluster read replica instances, and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom.
Constraints:
-
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.
- DBSubnetGroupName
-
- Type: string
A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
Constraints:
-
If supplied, must match the name of an existing DB subnet group.
-
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
-
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:
-
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
-
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
-
Example:
mydbsubnetgroup
- DatabaseInsightsMode
-
- Type: string
Specifies the mode of Database Insights.
- DedicatedLogVolume
-
- Type: boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- DeletionProtection
-
- Type: boolean
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
- DestinationRegion
-
- Type: string
The SDK will populate this parameter on your behalf using the configured region value of the client. - Domain
-
- Type: string
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- DomainAuthSecretArn
-
- Type: string
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- DomainDnsIps
-
- Type: Array of strings
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
-
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example:
123.124.125.126,234.235.236.237
- DomainFqdn
-
- Type: string
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
-
Can't be longer than 64 characters.
Example:
mymanagedADtest.mymanagedAD.mydomain
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
- DomainOu
-
- Type: string
The Active Directory organizational unit for your DB instance to join.
Constraints:
-
Must be in the distinguished name format.
-
Can't be longer than 64 characters.
Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of logs that the new DB instance 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 RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- EnableCustomerOwnedIp
-
- Type: boolean
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies 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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- EnablePerformanceInsights
-
- Type: boolean
Specifies whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- Iops
-
- Type: int
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
- MaxAllocatedStorage
-
- Type: int
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify
0
. The default is0
.If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than0
.This setting doesn't apply to RDS Custom DB instances.
Valid Values:
0, 1, 5, 10, 15, 30, 60
Default:
0
- MonitoringRoleArn
-
- Type: string
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.This setting doesn't apply to RDS Custom DB instances.
- MultiAZ
-
- Type: boolean
Specifies whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom DB instances.
- NetworkType
-
- Type: string
The network type of the DB instance.
Valid Values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for read replica. ADBSubnetGroup
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 RDS User Guide.
- OptionGroupName
-
- Type: string
The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.
For SQL Server, you must use the option group associated with the source.
This setting doesn't apply to RDS Custom DB instances.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.This setting doesn't apply to RDS Custom DB instances.
- PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
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
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS returns an error. - Port
-
- Type: int
The port number that the DB instance uses for connections.
Valid Values:
1150-65535
Default: Inherits the value from the source DB instance.
- PreSignedUrl
-
- Type: string
The SDK will compute this value for you on your behalf. - ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom DB instances.
- PubliclyAccessible
-
- Type: boolean
Specifies whether the DB instance 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 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.
- ReplicaMode
-
- Type: string
The open mode of the replica database: mounted or read-only.
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
For RDS Custom, you must specify this parameter and set it to
mounted
. The value won't be set by default. After replica creation, you can manage the open mode manually. - SourceDBClusterIdentifier
-
- Type: string
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
-
Must be the identifier of an existing Multi-AZ DB cluster.
-
Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. -
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
-
The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported.
- SourceDBInstanceIdentifier
-
- Type: string
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
-
Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance.
-
Can't be specified if the
SourceDBClusterIdentifier
parameter is also specified. -
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
-
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
-
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
-
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
-
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
- SourceRegion
-
- Type: string
A required parameter that indicates the region that the DB snapshot will be copied from. - StorageThroughput
-
- Type: int
Specifies the storage throughput value for the read replica.
This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.
- StorageType
-
- Type: string
The storage type to associate with the read replica.
If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter.Valid Values:
gp2 | gp3 | io1 | io2 | standard
Default:
io1
if theIops
parameter is specified. Otherwise,gp2
. - Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- UpgradeStorageConfig
-
- Type: boolean
Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.
- UseDefaultProcessorFeatures
-
- Type: boolean
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn't apply to RDS Custom DB instances.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceAlreadyExistsFault:
The user already has a DB instance with the given identifier.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.- InstanceQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAZFault:
Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- DBSubnetGroupNotAllowedFault:
The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.
- InvalidDBSubnetGroupFault:
The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
- StorageTypeNotSupportedFault:
The specified
StorageType
can't be associated with the DB instance.- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- NetworkTypeNotSupported:
The network type is invalid for the DB instance. Valid nework type values are
IPV4
andDUAL
.- TenantDatabaseQuotaExceededFault:
You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- CertificateNotFoundFault:
CertificateIdentifier
doesn't refer to an existing certificate.
Examples
Example 1: To create a DB instance read replica
This example creates a read replica of an existing DB instance named test-instance. The read replica is named test-instance-repl.
$result = $client->createDBInstanceReadReplica([ 'DBInstanceIdentifier' => 'test-instance-repl', 'SourceDBInstanceIdentifier' => 'test-instance', ]);
Result syntax:
[ 'DBInstance' => [ 'DBInstanceArn' => 'arn:aws:rds:us-east-1:123456789012:db:test-instance-repl', 'DBInstanceIdentifier' => 'test-instance-repl', 'IAMDatabaseAuthenticationEnabled' => , 'MonitoringInterval' => 0, 'ReadReplicaSourceDBInstanceIdentifier' => 'test-instance', ], // Some output ommitted. ]
CreateDBParameterGroup
$result = $client->createDBParameterGroup
([/* ... */]); $promise = $client->createDBParameterGroupAsync
([/* ... */]);
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup
. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance
. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
This command doesn't apply to RDS Custom.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Parameter Syntax
$result = $client->createDBParameterGroup([ 'DBParameterGroupFamily' => '<string>', // REQUIRED 'DBParameterGroupName' => '<string>', // REQUIRED 'Description' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DBParameterGroupFamily
-
- Required: Yes
- Type: string
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
-
aurora-mysql
-
aurora-postgresql
-
db2-ae
-
db2-se
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
- DBParameterGroupName
-
- Required: Yes
- Type: string
The name of the DB parameter group.
Constraints:
-
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
This value is stored as a lowercase string.
- Description
-
- Required: Yes
- Type: string
The description for the DB parameter group.
- Tags
-
- Type: Array of Tag structures
Tags to assign to the DB parameter group.
Result Syntax
[ 'DBParameterGroup' => [ 'DBParameterGroupArn' => '<string>', 'DBParameterGroupFamily' => '<string>', 'DBParameterGroupName' => '<string>', 'Description' => '<string>', ], ]
Result Details
Members
- DBParameterGroup
-
- Type: DBParameterGroup structure
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the
DescribeDBParameterGroups
action.
Errors
- DBParameterGroupQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB parameter groups.
- DBParameterGroupAlreadyExistsFault:
A DB parameter group with the same name exists.
Examples
Example 1: To create a DB parameter group
The following example creates a DB parameter group.
$result = $client->createDBParameterGroup([ 'DBParameterGroupFamily' => 'MySQL8.0', 'DBParameterGroupName' => 'mydbparametergroup', 'Description' => 'My new parameter group', ]);
Result syntax:
[ 'DBParameterGroup' => [ 'DBParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup', 'DBParameterGroupFamily' => 'mysql8.0', 'DBParameterGroupName' => 'mydbparametergroup', 'Description' => 'My new parameter group', ], ]
CreateDBProxy
$result = $client->createDBProxy
([/* ... */]); $promise = $client->createDBProxyAsync
([/* ... */]);
Creates a new DB proxy.
Parameter Syntax
$result = $client->createDBProxy([ 'Auth' => [ // REQUIRED [ 'AuthScheme' => 'SECRETS', 'ClientPasswordAuthType' => 'MYSQL_NATIVE_PASSWORD|MYSQL_CACHING_SHA2_PASSWORD|POSTGRES_SCRAM_SHA_256|POSTGRES_MD5|SQL_SERVER_AUTHENTICATION', 'Description' => '<string>', 'IAMAuth' => 'DISABLED|REQUIRED|ENABLED', 'SecretArn' => '<string>', 'UserName' => '<string>', ], // ... ], 'DBProxyName' => '<string>', // REQUIRED 'DebugLogging' => true || false, 'EngineFamily' => 'MYSQL|POSTGRESQL|SQLSERVER', // REQUIRED 'IdleClientTimeout' => <integer>, 'RequireTLS' => true || false, 'RoleArn' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- Auth
-
- Required: Yes
- Type: Array of UserAuthConfig structures
The authorization mechanism that the proxy uses.
- DBProxyName
-
- Required: Yes
- Type: string
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
- DebugLogging
-
- Type: boolean
Specifies whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
- EngineFamily
-
- Required: Yes
- Type: string
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify
MYSQL
. For Aurora PostgreSQL and RDS for PostgreSQL databases, specifyPOSTGRESQL
. For RDS for Microsoft SQL Server, specifySQLSERVER
. - IdleClientTimeout
-
- Type: int
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
- RequireTLS
-
- Type: boolean
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
- Tags
-
- Type: Array of Tag structures
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- VpcSecurityGroupIds
-
- Type: Array of strings
One or more VPC security group IDs to associate with the new proxy.
- VpcSubnetIds
-
- Required: Yes
- Type: Array of strings
One or more VPC subnet IDs to associate with the new proxy.
Result Syntax
[ 'DBProxy' => [ 'Auth' => [ [ 'AuthScheme' => 'SECRETS', 'ClientPasswordAuthType' => 'MYSQL_NATIVE_PASSWORD|MYSQL_CACHING_SHA2_PASSWORD|POSTGRES_SCRAM_SHA_256|POSTGRES_MD5|SQL_SERVER_AUTHENTICATION', 'Description' => '<string>', 'IAMAuth' => 'DISABLED|REQUIRED|ENABLED', 'SecretArn' => '<string>', 'UserName' => '<string>', ], // ... ], 'CreatedDate' => <DateTime>, 'DBProxyArn' => '<string>', 'DBProxyName' => '<string>', 'DebugLogging' => true || false, 'Endpoint' => '<string>', 'EngineFamily' => '<string>', 'IdleClientTimeout' => <integer>, 'RequireTLS' => true || false, 'RoleArn' => '<string>', 'Status' => 'available|modifying|incompatible-network|insufficient-resource-limits|creating|deleting|suspended|suspending|reactivating', 'UpdatedDate' => <DateTime>, 'VpcId' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- DBProxy
-
- Type: DBProxy structure
The
DBProxy
structure corresponding to the new proxy.
Errors
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DBProxyAlreadyExistsFault:
The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyQuotaExceededFault:
Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.
CreateDBProxyEndpoint
$result = $client->createDBProxyEndpoint
([/* ... */]); $promise = $client->createDBProxyEndpointAsync
([/* ... */]);
Creates a DBProxyEndpoint
. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
Parameter Syntax
$result = $client->createDBProxyEndpoint([ 'DBProxyEndpointName' => '<string>', // REQUIRED 'DBProxyName' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetRole' => 'READ_WRITE|READ_ONLY', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- DBProxyEndpointName
-
- Required: Yes
- Type: string
The name of the DB proxy endpoint to create.
- DBProxyName
-
- Required: Yes
- Type: string
The name of the DB proxy associated with the DB proxy endpoint that you create.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetRole
-
- Type: string
The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is
READ_WRITE
. The only role that proxies for RDS for Microsoft SQL Server support isREAD_WRITE
. - VpcSecurityGroupIds
-
- Type: Array of strings
The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
- VpcSubnetIds
-
- Required: Yes
- Type: Array of strings
The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
Result Syntax
[ 'DBProxyEndpoint' => [ 'CreatedDate' => <DateTime>, 'DBProxyEndpointArn' => '<string>', 'DBProxyEndpointName' => '<string>', 'DBProxyName' => '<string>', 'Endpoint' => '<string>', 'IsDefault' => true || false, 'Status' => 'available|modifying|incompatible-network|insufficient-resource-limits|creating|deleting', 'TargetRole' => 'READ_WRITE|READ_ONLY', 'VpcId' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- DBProxyEndpoint
-
- Type: DBProxyEndpoint structure
The
DBProxyEndpoint
object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.
Errors
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyEndpointAlreadyExistsFault:
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyEndpointQuotaExceededFault:
The DB proxy already has the maximum number of endpoints.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
CreateDBSecurityGroup
$result = $client->createDBSecurityGroup
([/* ... */]); $promise = $client->createDBSecurityGroupAsync
([/* ... */]);
Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->createDBSecurityGroup([ 'DBSecurityGroupDescription' => '<string>', // REQUIRED 'DBSecurityGroupName' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DBSecurityGroupDescription
-
- Required: Yes
- Type: string
The description for the DB security group.
- DBSecurityGroupName
-
- Required: Yes
- Type: string
The name for the DB security group. This value is stored as a lowercase string.
Constraints:
-
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
-
Must not be "Default"
Example:
mysecuritygroup
- Tags
-
- Type: Array of Tag structures
Tags to assign to the DB security group.
Result Syntax
[ 'DBSecurityGroup' => [ 'DBSecurityGroupArn' => '<string>', 'DBSecurityGroupDescription' => '<string>', 'DBSecurityGroupName' => '<string>', 'EC2SecurityGroups' => [ [ 'EC2SecurityGroupId' => '<string>', 'EC2SecurityGroupName' => '<string>', 'EC2SecurityGroupOwnerId' => '<string>', 'Status' => '<string>', ], // ... ], 'IPRanges' => [ [ 'CIDRIP' => '<string>', 'Status' => '<string>', ], // ... ], 'OwnerId' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSecurityGroup
-
- Type: DBSecurityGroup structure
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
Errors
- DBSecurityGroupAlreadyExistsFault:
A DB security group with the name specified in
DBSecurityGroupName
already exists.- DBSecurityGroupQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB security groups.
- DBSecurityGroupNotSupportedFault:
A DB security group isn't allowed for this action.
Examples
Example 1: To create a DB security group.
This example creates a DB security group.
$result = $client->createDBSecurityGroup([ 'DBSecurityGroupDescription' => 'My DB security group', 'DBSecurityGroupName' => 'mydbsecuritygroup', ]);
Result syntax:
[ 'DBSecurityGroup' => [ ], ]
CreateDBShardGroup
$result = $client->createDBShardGroup
([/* ... */]); $promise = $client->createDBShardGroupAsync
([/* ... */]);
Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
Parameter Syntax
$result = $client->createDBShardGroup([ 'ComputeRedundancy' => <integer>, 'DBClusterIdentifier' => '<string>', // REQUIRED 'DBShardGroupIdentifier' => '<string>', // REQUIRED 'MaxACU' => <float>, // REQUIRED 'MinACU' => <float>, 'PubliclyAccessible' => true || false, 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- ComputeRedundancy
-
- Type: int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:
-
0 - Creates a DB shard group without a standby DB shard group. This is the default value.
-
1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
-
2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The name of the primary DB cluster for the DB shard group.
- DBShardGroupIdentifier
-
- Required: Yes
- Type: string
The name of the DB shard group.
- MaxACU
-
- Required: Yes
- Type: double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
- MinACU
-
- Type: double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
- PubliclyAccessible
-
- Type: boolean
Specifies whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group 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 shard group is private.
-
If the default VPC in the target Region has an internet gateway attached to it, the DB shard group 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 shard group is private.
-
If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Result Syntax
[ 'ComputeRedundancy' => <integer>, 'DBClusterIdentifier' => '<string>', 'DBShardGroupArn' => '<string>', 'DBShardGroupIdentifier' => '<string>', 'DBShardGroupResourceId' => '<string>', 'Endpoint' => '<string>', 'MaxACU' => <float>, 'MinACU' => <float>, 'PubliclyAccessible' => true || false, 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- ComputeRedundancy
-
- Type: int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:
-
0 - Creates a DB shard group without a standby DB shard group. This is the default value.
-
1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
-
2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
- DBClusterIdentifier
-
- Type: string
The name of the primary DB cluster for the DB shard group.
- DBShardGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB shard group.
- DBShardGroupIdentifier
-
- Type: string
The name of the DB shard group.
- DBShardGroupResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
- Endpoint
-
- Type: string
The connection endpoint for the DB shard group.
- MaxACU
-
- Type: double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
- MinACU
-
- Type: double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
- PubliclyAccessible
-
- Type: boolean
Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
- Status
-
- Type: string
The status of the DB shard group.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Errors
- DBShardGroupAlreadyExistsFault:
The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- MaxDBShardGroupLimitReached:
The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- UnsupportedDBEngineVersionFault:
The specified DB engine version isn't supported for Aurora Limitless Database.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- NetworkTypeNotSupported:
The network type is invalid for the DB instance. Valid nework type values are
IPV4
andDUAL
.
CreateDBSnapshot
$result = $client->createDBSnapshot
([/* ... */]); $promise = $client->createDBSnapshotAsync
([/* ... */]);
Creates a snapshot of a DB instance. The source DB instance must be in the available
or storage-optimization
state.
Parameter Syntax
$result = $client->createDBSnapshot([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'DBSnapshotIdentifier' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
-
Must match the identifier of an existing DBInstance.
- DBSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier for the DB snapshot.
Constraints:
-
Can't be null, empty, or blank
-
Must contain from 1 to 255 letters, numbers, or hyphens
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Result Syntax
[ 'DBSnapshot' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSnapshotArn' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'OriginalSnapshotCreateTime' => <DateTime>, 'PercentProgress' => <integer>, 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'SnapshotCreateTime' => <DateTime>, 'SnapshotDatabaseTime' => <DateTime>, 'SnapshotTarget' => '<string>', 'SnapshotType' => '<string>', 'SourceDBSnapshotIdentifier' => '<string>', 'SourceRegion' => '<string>', 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSnapshot
-
- Type: DBSnapshot structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
Errors
- DBSnapshotAlreadyExistsFault:
DBSnapshotIdentifier
is already used by an existing snapshot.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- SnapshotQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB snapshots.
Examples
Example 1: To create a DB snapshot
The following example creates a DB snapshot.
$result = $client->createDBSnapshot([ 'DBInstanceIdentifier' => 'mydbsnapshot', 'DBSnapshotIdentifier' => 'database-mysql', ]);
Result syntax:
[ 'DBSnapshot' => [ 'AllocatedStorage' => 100, 'AvailabilityZone' => 'us-east-1b', 'DBInstanceIdentifier' => 'database-mysql', 'DBSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot', 'DBSnapshotIdentifier' => 'mydbsnapshot', 'DbiResourceId' => 'db-AKIAIOSFODNN7EXAMPLE', 'Encrypted' => 1, 'Engine' => 'mysql', 'EngineVersion' => '8.0.32', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'Iops' => 1000, 'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', 'LicenseModel' => 'general-public-license', 'MasterUsername' => 'admin', 'OptionGroupName' => 'default:mysql-8-0', 'PercentProgress' => 0, 'Port' => 3306, 'ProcessorFeatures' => [ ], 'SnapshotType' => 'manual', 'Status' => 'creating', 'StorageType' => 'io1', 'VpcId' => 'vpc-6594f31c', ], ]
CreateDBSubnetGroup
$result = $client->createDBSubnetGroup
([/* ... */]); $promise = $client->createDBSubnetGroupAsync
([/* ... */]);
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
Parameter Syntax
$result = $client->createDBSubnetGroup([ 'DBSubnetGroupDescription' => '<string>', // REQUIRED 'DBSubnetGroupName' => '<string>', // REQUIRED 'SubnetIds' => ['<string>', ...], // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DBSubnetGroupDescription
-
- Required: Yes
- Type: string
The description for the DB subnet group.
- DBSubnetGroupName
-
- Required: Yes
- Type: string
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
-
Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
-
Must not be default.
-
First character must be a letter.
Example:
mydbsubnetgroup
- SubnetIds
-
- Required: Yes
- Type: Array of strings
The EC2 Subnet IDs for the DB subnet group.
- Tags
-
- Type: Array of Tag structures
Tags to assign to the DB subnet group.
Result Syntax
[ 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSubnetGroup
-
- Type: DBSubnetGroup structure
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the
DescribeDBSubnetGroups
action.
Errors
- DBSubnetGroupAlreadyExistsFault:
DBSubnetGroupName
is already used by an existing DB subnet group.- DBSubnetGroupQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB subnet groups.
- DBSubnetQuotaExceededFault:
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
Examples
Example 1: To create a DB subnet group
The following example creates a DB subnet group called mysubnetgroup using existing subnets.
$result = $client->createDBSubnetGroup([ 'DBSubnetGroupDescription' => 'test DB subnet group', 'DBSubnetGroupName' => 'mysubnetgroup', 'SubnetIds' => [ 'subnet-0a1dc4e1a6f123456', 'subnet-070dd7ecb3aaaaaaa', 'subnet-00f5b198bc0abcdef', ], ]);
Result syntax:
[ 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => 'arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup', 'DBSubnetGroupDescription' => 'test DB subnet group', 'DBSubnetGroupName' => 'mysubnetgroup', 'SubnetGroupStatus' => 'Complete', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2b', ], 'SubnetIdentifier' => 'subnet-070dd7ecb3aaaaaaa', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2d', ], 'SubnetIdentifier' => 'subnet-00f5b198bc0abcdef', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2b', ], 'SubnetIdentifier' => 'subnet-0a1dc4e1a6f123456', 'SubnetStatus' => 'Active', ], ], 'VpcId' => 'vpc-0f08e7610a1b2c3d4', ], ]
CreateEventSubscription
$result = $client->createEventSubscription
([/* ... */]); $promise = $client->createEventSubscriptionAsync
([/* ... */]);
Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType
) that you want to be notified of and provide a list of RDS sources (SourceIds
) that triggers the events. You can also provide a list of event categories (EventCategories
) for events that you want to be notified of. For example, you can specify SourceType
= db-instance
, SourceIds
= mydbinstance1
, mydbinstance2
and EventCategories
= Availability
, Backup
.
If you specify both the SourceType
and SourceIds
, such as SourceType
= db-instance
and SourceIds
= myDBInstance1
, you are notified of all the db-instance
events for the specified source. If you specify a SourceType
but do not specify SourceIds
, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds
, you are notified of events generated from all RDS sources belonging to your customer account.
For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->createEventSubscription([ 'Enabled' => true || false, 'EventCategories' => ['<string>', ...], 'SnsTopicArn' => '<string>', // REQUIRED 'SourceIds' => ['<string>', ...], 'SourceType' => '<string>', 'SubscriptionName' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- Enabled
-
- Type: boolean
Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
- EventCategories
-
- Type: Array of strings
A list of event categories for a particular source type (
SourceType
) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using theDescribeEventCategories
operation. - SnsTopicArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.
RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
- SourceIds
-
- Type: Array of strings
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
Constraints:
-
If
SourceIds
are supplied,SourceType
must also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.
- SourceType
-
- Type: string
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to
db-instance
. For RDS Proxy events, specifydb-proxy
. If this value isn't specified, all events are returned.Valid Values:
db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
- SubscriptionName
-
- Required: Yes
- Type: string
The name of the subscription.
Constraints: The name must be less than 255 characters.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Result Syntax
[ 'EventSubscription' => [ 'CustSubscriptionId' => '<string>', 'CustomerAwsId' => '<string>', 'Enabled' => true || false, 'EventCategoriesList' => ['<string>', ...], 'EventSubscriptionArn' => '<string>', 'SnsTopicArn' => '<string>', 'SourceIdsList' => ['<string>', ...], 'SourceType' => '<string>', 'Status' => '<string>', 'SubscriptionCreationTime' => '<string>', ], ]
Result Details
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
Errors
- EventSubscriptionQuotaExceededFault:
You have reached the maximum number of event subscriptions.
- SubscriptionAlreadyExistFault:
The supplied subscription name already exists.
- SNSInvalidTopicFault:
SNS has responded that there is a problem with the SNS topic specified.
- SNSNoAuthorizationFault:
You do not have permission to publish to the SNS topic ARN.
- SNSTopicArnNotFoundFault:
The SNS topic ARN does not exist.
- SubscriptionCategoryNotFoundFault:
The supplied category does not exist.
- SourceNotFoundFault:
The requested source could not be found.
Examples
Example 1: To create an event subscription
The following example creates a subscription for backup and recovery events for DB instances in the current AWS account. Notifications are sent to an Amazon Simple Notification Service topic.
$result = $client->createEventSubscription([ 'EventCategories' => [ 'backup', 'recovery', ], 'SnsTopicArn' => 'arn:aws:sns:us-east-1:123456789012:interesting-events', 'SourceType' => 'db-instance', 'SubscriptionName' => 'my-instance-events', ]);
Result syntax:
[ 'EventSubscription' => [ 'CustSubscriptionId' => 'my-instance-events', 'CustomerAwsId' => '123456789012', 'Enabled' => 1, 'EventCategoriesList' => [ 'backup', 'recovery', ], 'EventSubscriptionArn' => 'arn:aws:rds:us-east-1:123456789012:es:my-instance-events', 'SnsTopicArn' => 'arn:aws:sns:us-east-1:123456789012:interesting-events', 'SourceType' => 'db-instance', 'Status' => 'creating', 'SubscriptionCreationTime' => 'Tue Jul 31 23:22:01 UTC 2018', ], ]
CreateGlobalCluster
$result = $client->createGlobalCluster
([/* ... */]); $promise = $client->createGlobalClusterAsync
([/* ... */]);
Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This operation applies only to Aurora DB clusters.
Parameter Syntax
$result = $client->createGlobalCluster([ 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'SourceDBClusterIdentifier' => '<string>', 'StorageEncrypted' => true || false, 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DatabaseName
-
- Type: string
The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.
Constraints:
-
Can't be specified if
SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.
- DeletionProtection
-
- Type: boolean
Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.
- Engine
-
- Type: string
The database engine to use for this global database cluster.
Valid Values:
aurora-mysql | aurora-postgresql
Constraints:
-
Can't be specified if
SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
- EngineLifecycleSupport
-
- Type: string
The life cycle type for this global database cluster.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.This setting only applies to Aurora PostgreSQL-based global databases.
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- EngineVersion
-
- Type: string
The engine version to use for this global database cluster.
Constraints:
-
Can't be specified if
SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.
- GlobalClusterIdentifier
-
- Type: string
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
- SourceDBClusterIdentifier
-
- Type: string
The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
-
DatabaseName
-
Engine
-
EngineVersion
-
StorageEncrypted
- StorageEncrypted
-
- Type: boolean
Specifies whether to enable storage encryption for the new global database cluster.
Constraints:
-
Can't be specified if
SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
- Tags
-
- Type: Array of Tag structures
Tags to assign to the global cluster.
Result Syntax
[ 'GlobalCluster' => [ 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'FailoverState' => [ 'FromDbClusterArn' => '<string>', 'IsDataLossAllowed' => true || false, 'Status' => 'pending|failing-over|cancelling', 'ToDbClusterArn' => '<string>', ], 'GlobalClusterArn' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'GlobalClusterMembers' => [ [ 'DBClusterArn' => '<string>', 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'IsWriter' => true || false, 'Readers' => ['<string>', ...], 'SynchronizationStatus' => 'connected|pending-resync', ], // ... ], 'GlobalClusterResourceId' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
Errors
- GlobalClusterAlreadyExistsFault:
The
GlobalClusterIdentifier
already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.- GlobalClusterQuotaExceededFault:
The number of global database clusters for this account is already at the maximum allowed.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.
Examples
Example 1: To create a global DB cluster
The following example creates a new Aurora MySQL-compatible global DB cluster.
$result = $client->createGlobalCluster([ 'Engine' => 'aurora-mysql', 'GlobalClusterIdentifier' => 'myglobalcluster', ]);
Result syntax:
[ 'GlobalCluster' => [ 'DeletionProtection' => , 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.07.2', 'GlobalClusterArn' => 'arn:aws:rds::123456789012:global-cluster:myglobalcluster', 'GlobalClusterIdentifier' => 'myglobalcluster', 'GlobalClusterMembers' => [ ], 'GlobalClusterResourceId' => 'cluster-f0e523bfe07aabb', 'Status' => 'available', 'StorageEncrypted' => , ], ]
CreateIntegration
$result = $client->createIntegration
([/* ... */]); $promise = $client->createIntegrationAsync
([/* ... */]);
Creates a zero-ETL integration with Amazon Redshift.
Parameter Syntax
$result = $client->createIntegration([ 'AdditionalEncryptionContext' => ['<string>', ...], 'DataFilter' => '<string>', 'Description' => '<string>', 'IntegrationName' => '<string>', // REQUIRED 'KMSKeyId' => '<string>', 'SourceArn' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AdditionalEncryptionContext
-
- Type: Associative array of custom strings keys (String) to strings
An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
You can only include this parameter if you specify the
KMSKeyId
parameter. - DataFilter
-
- Type: string
Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.
Valid for: Integrations with Aurora MySQL source DB clusters only
- Description
-
- Type: string
A description of the integration.
- IntegrationName
-
- Required: Yes
- Type: string
The name of the integration.
- KMSKeyId
-
- Type: string
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.
- SourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the database to use as the source for replication.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetArn
-
- Required: Yes
- Type: string
The ARN of the Redshift data warehouse to use as the target for replication.
Result Syntax
[ 'AdditionalEncryptionContext' => ['<string>', ...], 'CreateTime' => <DateTime>, 'DataFilter' => '<string>', 'Description' => '<string>', 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', ], // ... ], 'IntegrationArn' => '<string>', 'IntegrationName' => '<string>', 'KMSKeyId' => '<string>', 'SourceArn' => '<string>', 'Status' => 'creating|active|modifying|failed|deleting|syncing|needs_attention', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetArn' => '<string>', ]
Result Details
Members
- AdditionalEncryptionContext
-
- Type: Associative array of custom strings keys (String) to strings
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the integration was created, in Universal Coordinated Time (UTC).
- DataFilter
-
- Type: string
Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
- Description
-
- Type: string
A description of the integration.
- Errors
-
- Type: Array of IntegrationError structures
Any errors associated with the integration.
- IntegrationArn
-
- Type: string
The ARN of the integration.
- IntegrationName
-
- Type: string
The name of the integration.
- KMSKeyId
-
- Type: string
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the database used as the source for replication.
- Status
-
- Type: string
The current status of the integration.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetArn
-
- Type: string
The ARN of the Redshift data warehouse used as the target for replication.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- IntegrationAlreadyExistsFault:
The integration you are trying to create already exists.
- IntegrationQuotaExceededFault:
You can't crate any more zero-ETL integrations because the quota has been reached.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- IntegrationConflictOperationFault:
A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
Examples
Example 1: To create a zero-ETL integration
The following example creates a zero-ETL integration with Amazon Redshift.
$result = $client->createIntegration([ 'IntegrationName' => 'my-integration', 'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-cluster', 'TargetArn' => 'arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8', ]);
Result syntax:
[ 'CreateTime' =>, 'IntegrationArn' => 'arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231', 'IntegrationName' => 'my-integration', 'KMSKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa', 'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-cluster', 'Status' => 'creating', 'Tags' => [ ], 'TargetArn' => 'arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8', ]
CreateOptionGroup
$result = $client->createOptionGroup
([/* ... */]); $promise = $client->createOptionGroupAsync
([/* ... */]);
Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
Parameter Syntax
$result = $client->createOptionGroup([ 'EngineName' => '<string>', // REQUIRED 'MajorEngineVersion' => '<string>', // REQUIRED 'OptionGroupDescription' => '<string>', // REQUIRED 'OptionGroupName' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- EngineName
-
- Required: Yes
- Type: string
The name of the engine to associate this option group with.
Valid Values:
-
db2-ae
-
db2-se
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
- MajorEngineVersion
-
- Required: Yes
- Type: string
Specifies the major version of the engine that this option group should be associated with.
- OptionGroupDescription
-
- Required: Yes
- Type: string
The description of the option group.
- OptionGroupName
-
- Required: Yes
- Type: string
Specifies the name of the option group to be created.
Constraints:
-
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
Example:
myoptiongroup
- Tags
-
- Type: Array of Tag structures
Tags to assign to the option group.
Result Syntax
[ 'OptionGroup' => [ 'AllowsVpcAndNonVpcInstanceMemberships' => true || false, 'CopyTimestamp' => <DateTime>, 'EngineName' => '<string>', 'MajorEngineVersion' => '<string>', 'OptionGroupArn' => '<string>', 'OptionGroupDescription' => '<string>', 'OptionGroupName' => '<string>', 'Options' => [ [ 'DBSecurityGroupMemberships' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'OptionDescription' => '<string>', 'OptionName' => '<string>', 'OptionSettings' => [ [ 'AllowedValues' => '<string>', 'ApplyType' => '<string>', 'DataType' => '<string>', 'DefaultValue' => '<string>', 'Description' => '<string>', 'IsCollection' => true || false, 'IsModifiable' => true || false, 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'OptionVersion' => '<string>', 'Permanent' => true || false, 'Persistent' => true || false, 'Port' => <integer>, 'VpcSecurityGroupMemberships' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], // ... ], 'SourceAccountId' => '<string>', 'SourceOptionGroup' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- OptionGroup
-
- Type: OptionGroup structure
Errors
- OptionGroupAlreadyExistsFault:
The option group you are trying to create already exists.
- OptionGroupQuotaExceededFault:
The quota of 20 option groups was exceeded for this Amazon Web Services account.
Examples
Example 1: To Create an Amazon RDS option group
The following example creates a new Amazon RDS option group for Oracle MySQL version 8,0 named MyOptionGroup.
$result = $client->createOptionGroup([ 'EngineName' => 'mysql', 'MajorEngineVersion' => '8.0', 'OptionGroupDescription' => 'MySQL 8.0 option group', 'OptionGroupName' => 'MyOptionGroup', ]);
Result syntax:
[ 'OptionGroup' => [ 'AllowsVpcAndNonVpcInstanceMemberships' => 1, 'EngineName' => 'mysql', 'MajorEngineVersion' => '8.0', 'OptionGroupArn' => 'arn:aws:rds:us-east-1:123456789012:og:myoptiongroup', 'OptionGroupDescription' => 'MySQL 8.0 option group', 'OptionGroupName' => 'myoptiongroup', 'Options' => [ ], ], ]
CreateTenantDatabase
$result = $client->createTenantDatabase
([/* ... */]); $promise = $client->createTenantDatabaseAsync
([/* ... */]);
Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
Parameter Syntax
$result = $client->createTenantDatabase([ 'CharacterSetName' => '<string>', 'DBInstanceIdentifier' => '<string>', // REQUIRED 'MasterUserPassword' => '<string>', // REQUIRED 'MasterUsername' => '<string>', // REQUIRED 'NcharCharacterSetName' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TenantDBName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- CharacterSetName
-
- Type: string
The character set for your tenant database. If you don't specify a value, the character set name defaults to
AL32UTF8
. - DBInstanceIdentifier
-
- Required: Yes
- Type: string
The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.
- MasterUserPassword
-
- Required: Yes
- Type: string
The password for the master user in your tenant database.
Constraints:
-
Must be 8 to 30 characters.
-
Can include any printable ASCII character except forward slash (
/
), double quote ("
), at symbol (@
), ampersand (&
), or single quote ('
).
- MasterUsername
-
- Required: Yes
- Type: string
The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.
Constraints:
-
Must be 1 to 16 letters, numbers, or underscores.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
- NcharCharacterSetName
-
- Type: string
The
NCHAR
value for the tenant database. - Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TenantDBName
-
- Required: Yes
- Type: string
The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as
DBName
inCreateDBInstance
.
Result Syntax
[ 'TenantDatabase' => [ 'CharacterSetName' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'DeletionProtection' => true || false, 'MasterUsername' => '<string>', 'NcharCharacterSetName' => '<string>', 'PendingModifiedValues' => [ 'MasterUserPassword' => '<string>', 'TenantDBName' => '<string>', ], 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TenantDBName' => '<string>', 'TenantDatabaseARN' => '<string>', 'TenantDatabaseCreateTime' => <DateTime>, 'TenantDatabaseResourceId' => '<string>', ], ]
Result Details
Members
- TenantDatabase
-
- Type: TenantDatabase structure
A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- TenantDatabaseAlreadyExistsFault:
You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
- TenantDatabaseQuotaExceededFault:
You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
DeleteBlueGreenDeployment
$result = $client->deleteBlueGreenDeployment
([/* ... */]); $promise = $client->deleteBlueGreenDeploymentAsync
([/* ... */]);
Deletes a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->deleteBlueGreenDeployment([ 'BlueGreenDeploymentIdentifier' => '<string>', // REQUIRED 'DeleteTarget' => true || false, ]);
Parameter Details
Members
- BlueGreenDeploymentIdentifier
-
- Required: Yes
- Type: string
The unique identifier of the blue/green deployment to delete. This parameter isn't case-sensitive.
Constraints:
-
Must match an existing blue/green deployment identifier.
- DeleteTarget
-
- Type: boolean
Specifies whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment status is
SWITCHOVER_COMPLETED
.
Result Syntax
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => '<string>', 'BlueGreenDeploymentName' => '<string>', 'CreateTime' => <DateTime>, 'DeleteTime' => <DateTime>, 'Source' => '<string>', 'Status' => '<string>', 'StatusDetails' => '<string>', 'SwitchoverDetails' => [ [ 'SourceMember' => '<string>', 'Status' => '<string>', 'TargetMember' => '<string>', ], // ... ], 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Target' => '<string>', 'Tasks' => [ [ 'Name' => '<string>', 'Status' => '<string>', ], // ... ], ], ]
Result Details
Members
- BlueGreenDeployment
-
- Type: BlueGreenDeployment structure
Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Errors
- BlueGreenDeploymentNotFoundFault:
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.- InvalidBlueGreenDeploymentStateFault:
The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.
Examples
Example 1: To delete resources in green environment for an RDS for MySQL DB instance
The following example deletes the resources in a green environment for an RDS for MySQL DB instance.
$result = $client->deleteBlueGreenDeployment([ 'BlueGreenDeploymentIdentifier' => 'bgd-v53303651eexfake', 'DeleteTarget' => 1, ]);
Result syntax:
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => 'bgd-v53303651eexfake', 'BlueGreenDeploymentName' => 'bgd-cli-test-instance', 'CreateTime' =>, 'DeleteTime' => , 'Source' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', 'Status' => 'DELETING', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t', ], ], 'Target' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe', 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'COMPLETED', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'COMPLETED', ], [ 'Name' => 'CONFIGURE_BACKUPS', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATING_TOPOLOGY_OF_SOURCE', 'Status' => 'COMPLETED', ], ], ], ]
Example 2: To delete resources in green environment for an Aurora MySQL DB cluster
The following example deletes the resources in a green environment for an Aurora MySQL DB cluster.
$result = $client->deleteBlueGreenDeployment([ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', 'DeleteTarget' => 1, ]);
Result syntax:
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', 'BlueGreenDeploymentName' => 'my-blue-green-deployment', 'CreateTime' =>, 'DeleteTime' => , 'Source' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Status' => 'DELETING', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg', ], ], 'Target' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl', 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'COMPLETED', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATE_DB_INSTANCES_FOR_CLUSTER', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATE_CUSTOM_ENDPOINTS', 'Status' => 'COMPLETED', ], ], ], ]
DeleteCustomDBEngineVersion
$result = $client->deleteCustomDBEngineVersion
([/* ... */]); $promise = $client->deleteCustomDBEngineVersionAsync
([/* ... */]);
Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
-
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
-
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion
event.
For more information, see Deleting a CEV in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->deleteCustomDBEngineVersion([ 'Engine' => '<string>', // REQUIRED 'EngineVersion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Engine
-
- Required: Yes
- Type: string
The database engine. RDS Custom for Oracle supports the following values:
-
custom-oracle-ee
-
custom-oracle-ee-cdb
-
custom-oracle-se2
-
custom-oracle-se2-cdb
- EngineVersion
-
- Required: Yes
- Type: string
The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of
Engine
andEngineVersion
is unique per customer per Amazon Web Services Region.
Result Syntax
[ 'CreateTime' => <DateTime>, 'CustomDBEngineVersionManifest' => '<string>', 'DBEngineDescription' => '<string>', 'DBEngineMediaType' => '<string>', 'DBEngineVersionArn' => '<string>', 'DBEngineVersionDescription' => '<string>', 'DBParameterGroupFamily' => '<string>', 'DatabaseInstallationFilesS3BucketName' => '<string>', 'DatabaseInstallationFilesS3Prefix' => '<string>', 'DefaultCharacterSet' => [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], 'Engine' => '<string>', 'EngineVersion' => '<string>', 'ExportableLogTypes' => ['<string>', ...], 'Image' => [ 'ImageId' => '<string>', 'Status' => '<string>', ], 'KMSKeyId' => '<string>', 'MajorEngineVersion' => '<string>', 'ServerlessV2FeaturesSupport' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, ], 'Status' => '<string>', 'SupportedCACertificateIdentifiers' => ['<string>', ...], 'SupportedCharacterSets' => [ [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], // ... ], 'SupportedEngineModes' => ['<string>', ...], 'SupportedFeatureNames' => ['<string>', ...], 'SupportedNcharCharacterSets' => [ [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], // ... ], 'SupportedTimezones' => [ [ 'TimezoneName' => '<string>', ], // ... ], 'SupportsBabelfish' => true || false, 'SupportsCertificateRotationWithoutRestart' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIntegrations' => true || false, 'SupportsLimitlessDatabase' => true || false, 'SupportsLocalWriteForwarding' => true || false, 'SupportsLogExportsToCloudwatchLogs' => true || false, 'SupportsParallelQuery' => true || false, 'SupportsReadReplica' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ValidUpgradeTarget' => [ [ 'AutoUpgrade' => true || false, 'Description' => '<string>', 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IsMajorVersionUpgrade' => true || false, 'SupportedEngineModes' => ['<string>', ...], 'SupportsBabelfish' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIntegrations' => true || false, 'SupportsLimitlessDatabase' => true || false, 'SupportsLocalWriteForwarding' => true || false, 'SupportsParallelQuery' => true || false, ], // ... ], ]
Result Details
Members
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the DB engine version.
- CustomDBEngineVersionManifest
-
- Type: string
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
- DBEngineDescription
-
- Type: string
The description of the database engine.
- DBEngineMediaType
-
- Type: string
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
- DBEngineVersionArn
-
- Type: string
The ARN of the custom engine version.
- DBEngineVersionDescription
-
- Type: string
The description of the database engine version.
- DBParameterGroupFamily
-
- Type: string
The name of the DB parameter group family for the database engine.
- DatabaseInstallationFilesS3BucketName
-
- Type: string
The name of the Amazon S3 bucket that contains your database installation files.
- DatabaseInstallationFilesS3Prefix
-
- Type: string
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
- DefaultCharacterSet
-
- Type: CharacterSet structure
The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn't specified. - Engine
-
- Type: string
The name of the database engine.
- EngineVersion
-
- Type: string
The version number of the database engine.
- ExportableLogTypes
-
- Type: Array of strings
The types of logs that the database engine has available for export to CloudWatch Logs.
- Image
-
- Type: CustomDBEngineVersionAMI structure
The EC2 image
- KMSKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
- MajorEngineVersion
-
- Type: string
The major engine version of the CEV.
- ServerlessV2FeaturesSupport
-
- Type: ServerlessV2FeaturesSupport structure
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
- Status
-
- Type: string
The status of the DB engine version, either
available
ordeprecated
. - SupportedCACertificateIdentifiers
-
- Type: Array of strings
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- SupportedCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation. - SupportedEngineModes
-
- Type: Array of strings
A list of the supported DB engine modes.
- SupportedFeatureNames
-
- Type: Array of strings
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output. - SupportedNcharCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation. - SupportedTimezones
-
- Type: Array of Timezone structures
A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action. - SupportsBabelfish
-
- Type: boolean
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- SupportsCertificateRotationWithoutRestart
-
- Type: boolean
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
- SupportsGlobalDatabases
-
- Type: boolean
Indicates whether you can use Aurora global databases with a specific DB engine version.
- SupportsIntegrations
-
- Type: boolean
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
- SupportsLimitlessDatabase
-
- Type: boolean
Indicates whether the DB engine version supports Aurora Limitless Database.
- SupportsLocalWriteForwarding
-
- Type: boolean
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
- SupportsLogExportsToCloudwatchLogs
-
- Type: boolean
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
- SupportsParallelQuery
-
- Type: boolean
Indicates whether you can use Aurora parallel query with a specific DB engine version.
- SupportsReadReplica
-
- Type: boolean
Indicates whether the database engine version supports read replicas.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- ValidUpgradeTarget
-
- Type: Array of UpgradeTarget structures
A list of engine versions that this database engine version can be upgraded to.
Errors
- CustomDBEngineVersionNotFoundFault:
The specified CEV was not found.
- InvalidCustomDBEngineVersionStateFault:
You can't delete the CEV.
DeleteDBCluster
$result = $client->deleteDBCluster
([/* ... */]); $promise = $client->deleteDBClusterAsync
([/* ... */]);
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->deleteDBCluster([ 'DBClusterIdentifier' => '<string>', // REQUIRED 'DeleteAutomatedBackups' => true || false, 'FinalDBSnapshotIdentifier' => '<string>', 'SkipFinalSnapshot' => true || false, ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
-
Must match an existing DBClusterIdentifier.
- DeleteAutomatedBackups
-
- Type: boolean
Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
- FinalDBSnapshotIdentifier
-
- Type: string
The DB cluster snapshot identifier of the new DB cluster snapshot created when
SkipFinalSnapshot
is disabled.If you specify this parameter and also skip the creation of a final DB cluster snapshot with the
SkipFinalShapshot
parameter, the request results in an error.Constraints:
-
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
- SkipFinalSnapshot
-
- Type: boolean
Specifies whether to skip the creation of a final DB cluster snapshot before RDS deletes the DB cluster. If you set this value to
true
, RDS doesn't create a final DB cluster snapshot. If you set this value tofalse
or don't specify it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this parameter is disabled, so RDS creates a final DB cluster snapshot.If
SkipFinalSnapshot
is disabled, you must specify a value for theFinalDBSnapshotIdentifier
parameter.
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBClusterSnapshotAlreadyExistsFault:
The user already has a DB cluster snapshot with the given identifier.
- SnapshotQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDBClusterSnapshotStateFault:
The supplied value isn't a valid DB cluster snapshot state.
- DBClusterAutomatedBackupQuotaExceededFault:
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.
Examples
Example 1: To delete a DB cluster
The following example deletes the DB cluster named mycluster and takes a final snapshot named mycluster-final-snapshot. The status of the DB cluster is available while the snapshot is being taken.
$result = $client->deleteDBCluster([ 'DBClusterIdentifier' => 'mycluster', 'FinalDBSnapshotIdentifier' => 'mycluster-final-snapshot', 'SkipFinalSnapshot' => , ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 20, 'AvailabilityZones' => [ 'eu-central-1b', 'eu-central-1c', 'eu-central-1a', ], 'BackupRetentionPeriod' => 7, 'DBClusterIdentifier' => 'mycluster', 'DBClusterParameterGroup' => 'default.aurora-postgresql10', 'DBSubnetGroup' => 'default-vpc-aa11bb22', 'Status' => 'available', ], // Some output ommitted. ]
DeleteDBClusterAutomatedBackup
$result = $client->deleteDBClusterAutomatedBackup
([/* ... */]); $promise = $client->deleteDBClusterAutomatedBackupAsync
([/* ... */]);
Deletes automated backups using the DbClusterResourceId
value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.
Parameter Syntax
$result = $client->deleteDBClusterAutomatedBackup([ 'DbClusterResourceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DbClusterResourceId
-
- Required: Yes
- Type: string
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
Result Syntax
[ 'DBClusterAutomatedBackup' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'ClusterCreateTime' => <DateTime>, 'DBClusterArn' => '<string>', 'DBClusterAutomatedBackupsArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DbClusterResourceId' => '<string>', 'Engine' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'Port' => <integer>, 'Region' => '<string>', 'RestoreWindow' => [ 'EarliestTime' => <DateTime>, 'LatestTime' => <DateTime>, ], 'Status' => '<string>', 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBClusterAutomatedBackup
-
- Type: DBClusterAutomatedBackup structure
An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
Errors
- InvalidDBClusterAutomatedBackupStateFault:
The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.
- DBClusterAutomatedBackupNotFoundFault:
No automated backup for this DB cluster was found.
DeleteDBClusterEndpoint
$result = $client->deleteDBClusterEndpoint
([/* ... */]); $promise = $client->deleteDBClusterEndpointAsync
([/* ... */]);
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Parameter Syntax
$result = $client->deleteDBClusterEndpoint([ 'DBClusterEndpointIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterEndpointIdentifier
-
- Required: Yes
- Type: string
The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
Result Syntax
[ 'CustomEndpointType' => '<string>', 'DBClusterEndpointArn' => '<string>', 'DBClusterEndpointIdentifier' => '<string>', 'DBClusterEndpointResourceIdentifier' => '<string>', 'DBClusterIdentifier' => '<string>', 'Endpoint' => '<string>', 'EndpointType' => '<string>', 'ExcludedMembers' => ['<string>', ...], 'StaticMembers' => ['<string>', ...], 'Status' => '<string>', ]
Result Details
Members
- CustomEndpointType
-
- Type: string
The type associated with a custom endpoint. One of:
READER
,WRITER
,ANY
. - DBClusterEndpointArn
-
- Type: string
The Amazon Resource Name (ARN) for the endpoint.
- DBClusterEndpointIdentifier
-
- Type: string
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
- DBClusterEndpointResourceIdentifier
-
- Type: string
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
- DBClusterIdentifier
-
- Type: string
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
- Endpoint
-
- Type: string
The DNS address of the endpoint.
- EndpointType
-
- Type: string
The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
. - ExcludedMembers
-
- Type: Array of strings
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
- StaticMembers
-
- Type: Array of strings
List of DB instance identifiers that are part of the custom endpoint group.
- Status
-
- Type: string
The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that can't be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.
Errors
- InvalidDBClusterEndpointStateFault:
The requested operation can't be performed on the endpoint while the endpoint is in this state.
- DBClusterEndpointNotFoundFault:
The specified custom endpoint doesn't exist.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
Examples
Example 1: To delete a custom DB cluster endpoint
The following example deletes the specified custom DB cluster endpoint.
$result = $client->deleteDBClusterEndpoint([ 'DBClusterEndpointIdentifier' => 'mycustomendpoint', ]);
Result syntax:
[ 'CustomEndpointType' => 'READER', 'DBClusterEndpointArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint', 'DBClusterEndpointIdentifier' => 'mycustomendpoint', 'DBClusterEndpointResourceIdentifier' => 'cluster-endpoint-ANPAJ4AE5446DAEXAMPLE', 'DBClusterIdentifier' => 'mydbcluster', 'Endpoint' => 'mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com', 'EndpointType' => 'CUSTOM', 'ExcludedMembers' => [ ], 'StaticMembers' => [ 'dbinstance1', 'dbinstance2', 'dbinstance3', ], 'Status' => 'deleting', ]
DeleteDBClusterParameterGroup
$result = $client->deleteDBClusterParameterGroup
([/* ... */]); $promise = $client->deleteDBClusterParameterGroupAsync
([/* ... */]);
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->deleteDBClusterParameterGroup([ 'DBClusterParameterGroupName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterParameterGroupName
-
- Required: Yes
- Type: string
The name of the DB cluster parameter group.
Constraints:
-
Must be the name of an existing DB cluster parameter group.
-
You can't delete a default DB cluster parameter group.
-
Can't be associated with any DB clusters.
Result Syntax
[]
Result Details
Errors
- InvalidDBParameterGroupStateFault:
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Examples
Example 1: To delete a DB cluster parameter group
The following example deletes the specified DB cluster parameter group.
$result = $client->deleteDBClusterParameterGroup([ 'DBClusterParameterGroupName' => 'mydbclusterparametergroup', ]);
DeleteDBClusterSnapshot
$result = $client->deleteDBClusterSnapshot
([/* ... */]); $promise = $client->deleteDBClusterSnapshotAsync
([/* ... */]);
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available
state to be deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->deleteDBClusterSnapshot([ 'DBClusterSnapshotIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the
available
state.
Result Syntax
[ 'DBClusterSnapshot' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZones' => ['<string>', ...], 'ClusterCreateTime' => <DateTime>, 'DBClusterIdentifier' => '<string>', 'DBClusterSnapshotArn' => '<string>', 'DBClusterSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbClusterResourceId' => '<string>', 'Engine' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'PercentProgress' => <integer>, 'Port' => <integer>, 'SnapshotCreateTime' => <DateTime>, 'SnapshotType' => '<string>', 'SourceDBClusterSnapshotArn' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcId' => '<string>', ], ]
Result Details
Members
- DBClusterSnapshot
-
- Type: DBClusterSnapshot structure
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
Errors
- InvalidDBClusterSnapshotStateFault:
The supplied value isn't a valid DB cluster snapshot state.
- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.
Examples
Example 1: To delete a DB cluster snapshot
$result = $client->deleteDBClusterSnapshot([ 'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot', ]);
Result syntax:
[ 'DBClusterSnapshot' => [ 'AllocatedStorage' => 0, 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1b', 'us-east-1e', ], 'ClusterCreateTime' =>, 'DBClusterIdentifier' => 'mydbcluster', 'DBClusterSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot', 'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot', 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.04.2', 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', 'LicenseModel' => 'aurora-mysql', 'MasterUsername' => 'myadmin', 'PercentProgress' => 100, 'Port' => 0, 'SnapshotCreateTime' => , 'SnapshotType' => 'manual', 'Status' => 'available', 'StorageEncrypted' => 1, 'VpcId' => 'vpc-6594f31c', ], ]
DeleteDBInstance
$result = $client->deleteDBInstance
([/* ... */]); $promise = $client->deleteDBInstanceAsync
([/* ... */]);
Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting
until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance
.
When a DB instance is in a failure state and has a status of failed
, incompatible-restore
, or incompatible-network
, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot
parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
-
The DB cluster is a read replica of another Amazon Aurora DB cluster.
-
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster
operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use the DeleteDBInstance
operation to delete the final instance in the DB cluster.
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
Parameter Syntax
$result = $client->deleteDBInstance([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'DeleteAutomatedBackups' => true || false, 'FinalDBSnapshotIdentifier' => '<string>', 'SkipFinalSnapshot' => true || false, ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
Constraints:
-
Must match the name of an existing DB instance.
- DeleteAutomatedBackups
-
- Type: boolean
Specifies whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
- FinalDBSnapshotIdentifier
-
- Type: string
The
DBSnapshotIdentifier
of the newDBSnapshot
created when theSkipFinalSnapshot
parameter is disabled.If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn't apply to RDS Custom.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
-
Can't be specified when deleting a read replica.
- SkipFinalSnapshot
-
- Type: boolean
Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.
If you don't enable this parameter, you must specify the
FinalDBSnapshotIdentifier
parameter.When a DB instance is in a failure state and has a status of
failed
,incompatible-restore
, orincompatible-network
, RDS can delete the instance only if you enable this parameter.If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- DBSnapshotAlreadyExistsFault:
DBSnapshotIdentifier
is already used by an existing snapshot.- SnapshotQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBInstanceAutomatedBackupQuotaExceededFault:
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
Examples
Example 1: To delete a DB instance
The following example deletes the specified DB instance after creating a final DB snapshot named test-instance-final-snap.
$result = $client->deleteDBInstance([ 'DBInstanceIdentifier' => 'test-instance', 'FinalDBSnapshotIdentifier' => 'test-instance-final-snap', 'SkipFinalSnapshot' => , ]);
Result syntax:
[ 'DBInstance' => [ 'DBInstanceIdentifier' => 'test-instance', 'DBInstanceStatus' => 'deleting', ], // Some output ommitted. ]
DeleteDBInstanceAutomatedBackup
$result = $client->deleteDBInstanceAutomatedBackup
([/* ... */]); $promise = $client->deleteDBInstanceAutomatedBackupAsync
([/* ... */]);
Deletes automated backups using the DbiResourceId
value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
Parameter Syntax
$result = $client->deleteDBInstanceAutomatedBackup([ 'DBInstanceAutomatedBackupsArn' => '<string>', 'DbiResourceId' => '<string>', ]);
Parameter Details
Members
- DBInstanceAutomatedBackupsArn
-
- Type: string
The Amazon Resource Name (ARN) of the automated backups to delete, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.This setting doesn't apply to RDS Custom.
- DbiResourceId
-
- Type: string
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Result Syntax
[ 'DBInstanceAutomatedBackup' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'Port' => <integer>, 'Region' => '<string>', 'RestoreWindow' => [ 'EarliestTime' => <DateTime>, 'LatestTime' => <DateTime>, ], 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBInstanceAutomatedBackup
-
- Type: DBInstanceAutomatedBackup structure
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
Errors
- InvalidDBInstanceAutomatedBackupStateFault:
The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.
- DBInstanceAutomatedBackupNotFoundFault:
No automated backup for this DB instance was found.
Examples
Example 1: To delete a replicated automated backup from a Region
The following example deletes the automated backup with the specified Amazon Resource Name (ARN).
$result = $client->deleteDBInstanceAutomatedBackup([ 'DBInstanceAutomatedBackupsArn' => 'arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example', ]);
Result syntax:
[ 'DBInstanceAutomatedBackup' => [ 'AllocatedStorage' => 20, 'AvailabilityZone' => 'us-east-1b', 'BackupRetentionPeriod' => 7, 'DBInstanceArn' => 'arn:aws:rds:us-east-1:123456789012:db:new-orcl-db', 'DBInstanceAutomatedBackupsArn' => 'arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example', 'DBInstanceIdentifier' => 'new-orcl-db', 'DbiResourceId' => 'db-JKIB2GFQ5RV7REPLZA4EXAMPLE', 'Encrypted' => , 'Engine' => 'oracle-se2', 'EngineVersion' => '12.1.0.2.v21', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'LicenseModel' => 'bring-your-own-license', 'MasterUsername' => 'admin', 'OptionGroupName' => 'default:oracle-se2-12-1', 'Port' => 1521, 'Region' => 'us-east-1', 'RestoreWindow' => [ ], 'Status' => 'deleting', 'StorageType' => 'gp2', 'VpcId' => 'vpc-########', ], ]
DeleteDBParameterGroup
$result = $client->deleteDBParameterGroup
([/* ... */]); $promise = $client->deleteDBParameterGroupAsync
([/* ... */]);
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
Parameter Syntax
$result = $client->deleteDBParameterGroup([ 'DBParameterGroupName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBParameterGroupName
-
- Required: Yes
- Type: string
The name of the DB parameter group.
Constraints:
-
Must be the name of an existing DB parameter group
-
You can't delete a default DB parameter group
-
Can't be associated with any DB instances
Result Syntax
[]
Result Details
Errors
- InvalidDBParameterGroupStateFault:
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Examples
Example 1: To delete a DB parameter group
The following example deletes a DB parameter group.
$result = $client->deleteDBParameterGroup([ 'DBParameterGroupName' => 'mydbparametergroup', ]);
DeleteDBProxy
$result = $client->deleteDBProxy
([/* ... */]); $promise = $client->deleteDBProxyAsync
([/* ... */]);
Deletes an existing DB proxy.
Parameter Syntax
$result = $client->deleteDBProxy([ 'DBProxyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBProxyName
-
- Required: Yes
- Type: string
The name of the DB proxy to delete.
Result Syntax
[ 'DBProxy' => [ 'Auth' => [ [ 'AuthScheme' => 'SECRETS', 'ClientPasswordAuthType' => 'MYSQL_NATIVE_PASSWORD|MYSQL_CACHING_SHA2_PASSWORD|POSTGRES_SCRAM_SHA_256|POSTGRES_MD5|SQL_SERVER_AUTHENTICATION', 'Description' => '<string>', 'IAMAuth' => 'DISABLED|REQUIRED|ENABLED', 'SecretArn' => '<string>', 'UserName' => '<string>', ], // ... ], 'CreatedDate' => <DateTime>, 'DBProxyArn' => '<string>', 'DBProxyName' => '<string>', 'DebugLogging' => true || false, 'Endpoint' => '<string>', 'EngineFamily' => '<string>', 'IdleClientTimeout' => <integer>, 'RequireTLS' => true || false, 'RoleArn' => '<string>', 'Status' => 'available|modifying|incompatible-network|insufficient-resource-limits|creating|deleting|suspended|suspending|reactivating', 'UpdatedDate' => <DateTime>, 'VpcId' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- DBProxy
-
- Type: DBProxy structure
The data structure representing the details of the DB proxy that you delete.
Errors
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
DeleteDBProxyEndpoint
$result = $client->deleteDBProxyEndpoint
([/* ... */]); $promise = $client->deleteDBProxyEndpointAsync
([/* ... */]);
Deletes a DBProxyEndpoint
. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.
Parameter Syntax
$result = $client->deleteDBProxyEndpoint([ 'DBProxyEndpointName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBProxyEndpointName
-
- Required: Yes
- Type: string
The name of the DB proxy endpoint to delete.
Result Syntax
[ 'DBProxyEndpoint' => [ 'CreatedDate' => <DateTime>, 'DBProxyEndpointArn' => '<string>', 'DBProxyEndpointName' => '<string>', 'DBProxyName' => '<string>', 'Endpoint' => '<string>', 'IsDefault' => true || false, 'Status' => 'available|modifying|incompatible-network|insufficient-resource-limits|creating|deleting', 'TargetRole' => 'READ_WRITE|READ_ONLY', 'VpcId' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- DBProxyEndpoint
-
- Type: DBProxyEndpoint structure
The data structure representing the details of the DB proxy endpoint that you delete.
Errors
- DBProxyEndpointNotFoundFault:
The DB proxy endpoint doesn't exist.
- InvalidDBProxyEndpointStateFault:
You can't perform this operation while the DB proxy endpoint is in a particular state.
DeleteDBSecurityGroup
$result = $client->deleteDBSecurityGroup
([/* ... */]); $promise = $client->deleteDBSecurityGroupAsync
([/* ... */]);
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->deleteDBSecurityGroup([ 'DBSecurityGroupName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBSecurityGroupName
-
- Required: Yes
- Type: string
The name of the DB security group to delete.
You can't delete the default DB security group.
Constraints:
-
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
-
Must not be "Default"
Result Syntax
[]
Result Details
Errors
- InvalidDBSecurityGroupStateFault:
The state of the DB security group doesn't allow deletion.
- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.
Examples
Example 1: To delete a DB security group
The following example deletes a DB security group.
$result = $client->deleteDBSecurityGroup([ 'DBSecurityGroupName' => 'mysecgroup', ]);
DeleteDBShardGroup
$result = $client->deleteDBShardGroup
([/* ... */]); $promise = $client->deleteDBShardGroupAsync
([/* ... */]);
Deletes an Aurora Limitless Database DB shard group.
Parameter Syntax
$result = $client->deleteDBShardGroup([ 'DBShardGroupIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBShardGroupIdentifier
-
- Required: Yes
- Type: string
The name of the DB shard group to delete.
Result Syntax
[ 'ComputeRedundancy' => <integer>, 'DBClusterIdentifier' => '<string>', 'DBShardGroupArn' => '<string>', 'DBShardGroupIdentifier' => '<string>', 'DBShardGroupResourceId' => '<string>', 'Endpoint' => '<string>', 'MaxACU' => <float>, 'MinACU' => <float>, 'PubliclyAccessible' => true || false, 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- ComputeRedundancy
-
- Type: int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:
-
0 - Creates a DB shard group without a standby DB shard group. This is the default value.
-
1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
-
2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
- DBClusterIdentifier
-
- Type: string
The name of the primary DB cluster for the DB shard group.
- DBShardGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB shard group.
- DBShardGroupIdentifier
-
- Type: string
The name of the DB shard group.
- DBShardGroupResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
- Endpoint
-
- Type: string
The connection endpoint for the DB shard group.
- MaxACU
-
- Type: double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
- MinACU
-
- Type: double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
- PubliclyAccessible
-
- Type: boolean
Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
- Status
-
- Type: string
The status of the DB shard group.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Errors
- DBShardGroupNotFoundFault:
The specified DB shard group name wasn't found.
- InvalidDBShardGroupStateFault:
The DB shard group must be in the available state.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
DeleteDBSnapshot
$result = $client->deleteDBSnapshot
([/* ... */]); $promise = $client->deleteDBSnapshotAsync
([/* ... */]);
Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available
state to be deleted.
Parameter Syntax
$result = $client->deleteDBSnapshot([ 'DBSnapshotIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBSnapshotIdentifier
-
- Required: Yes
- Type: string
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the
available
state.
Result Syntax
[ 'DBSnapshot' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSnapshotArn' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'OriginalSnapshotCreateTime' => <DateTime>, 'PercentProgress' => <integer>, 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'SnapshotCreateTime' => <DateTime>, 'SnapshotDatabaseTime' => <DateTime>, 'SnapshotTarget' => '<string>', 'SnapshotType' => '<string>', 'SourceDBSnapshotIdentifier' => '<string>', 'SourceRegion' => '<string>', 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSnapshot
-
- Type: DBSnapshot structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
Errors
- InvalidDBSnapshotStateFault:
The state of the DB snapshot doesn't allow deletion.
- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.
Examples
Example 1: To delete a DB snapshot
The following example deletes the specified DB snapshot.
$result = $client->deleteDBSnapshot([ 'DBSnapshotIdentifier' => 'mydbsnapshot', ]);
Result syntax:
[ 'DBSnapshot' => [ 'AllocatedStorage' => 100, 'AvailabilityZone' => 'us-east-1b', 'DBInstanceIdentifier' => 'database-mysql', 'DBSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot', 'DBSnapshotIdentifier' => 'mydbsnapshot', 'DbiResourceId' => 'db-AKIAIOSFODNN7EXAMPLE', 'Encrypted' => 1, 'Engine' => 'mysql', 'EngineVersion' => '5.6.40', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'Iops' => 1000, 'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', 'LicenseModel' => 'general-public-license', 'MasterUsername' => 'admin', 'OptionGroupName' => 'default:mysql-5-6', 'PercentProgress' => 100, 'Port' => 3306, 'ProcessorFeatures' => [ ], 'SnapshotCreateTime' => , 'SnapshotType' => 'manual', 'Status' => 'deleted', 'StorageType' => 'io1', 'VpcId' => 'vpc-6594f31c', ], ]
DeleteDBSubnetGroup
$result = $client->deleteDBSubnetGroup
([/* ... */]); $promise = $client->deleteDBSubnetGroupAsync
([/* ... */]);
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
Parameter Syntax
$result = $client->deleteDBSubnetGroup([ 'DBSubnetGroupName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBSubnetGroupName
-
- Required: Yes
- Type: string
The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example:
mydbsubnetgroup
Result Syntax
[]
Result Details
Errors
- InvalidDBSubnetGroupStateFault:
The DB subnet group cannot be deleted because it's in use.
- InvalidDBSubnetStateFault:
The DB subnet isn't in the available state.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.
Examples
Example 1: To delete a DB subnet group
The following example deletes the DB subnet group called mysubnetgroup.
$result = $client->deleteDBSubnetGroup([ 'DBSubnetGroupName' => 'mysubnetgroup', ]);
DeleteEventSubscription
$result = $client->deleteEventSubscription
([/* ... */]); $promise = $client->deleteEventSubscriptionAsync
([/* ... */]);
Deletes an RDS event notification subscription.
Parameter Syntax
$result = $client->deleteEventSubscription([ 'SubscriptionName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SubscriptionName
-
- Required: Yes
- Type: string
The name of the RDS event notification subscription you want to delete.
Result Syntax
[ 'EventSubscription' => [ 'CustSubscriptionId' => '<string>', 'CustomerAwsId' => '<string>', 'Enabled' => true || false, 'EventCategoriesList' => ['<string>', ...], 'EventSubscriptionArn' => '<string>', 'SnsTopicArn' => '<string>', 'SourceIdsList' => ['<string>', ...], 'SourceType' => '<string>', 'Status' => '<string>', 'SubscriptionCreationTime' => '<string>', ], ]
Result Details
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
Errors
- SubscriptionNotFoundFault:
The subscription name does not exist.
- InvalidEventSubscriptionStateFault:
This error can occur if someone else is modifying a subscription. You should retry the action.
Examples
Example 1: To delete an event subscription
The following example deletes the specified event subscription.
$result = $client->deleteEventSubscription([ 'SubscriptionName' => 'my-instance-events', ]);
Result syntax:
[ 'EventSubscription' => [ 'CustSubscriptionId' => 'my-instance-events', 'CustomerAwsId' => '123456789012', 'Enabled' => , 'EventCategoriesList' => [ 'backup', 'recovery', ], 'EventSubscriptionArn' => 'arn:aws:rds:us-east-1:123456789012:es:my-instance-events', 'SnsTopicArn' => 'arn:aws:sns:us-east-1:123456789012:interesting-events', 'SourceIdsList' => [ 'test-instance', ], 'SourceType' => 'db-instance', 'Status' => 'deleting', 'SubscriptionCreationTime' => '2018-07-31 23:22:01.893', ], ]
DeleteGlobalCluster
$result = $client->deleteGlobalCluster
([/* ... */]); $promise = $client->deleteGlobalClusterAsync
([/* ... */]);
Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
Parameter Syntax
$result = $client->deleteGlobalCluster([ 'GlobalClusterIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- GlobalClusterIdentifier
-
- Required: Yes
- Type: string
The cluster identifier of the global database cluster being deleted.
Result Syntax
[ 'GlobalCluster' => [ 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'FailoverState' => [ 'FromDbClusterArn' => '<string>', 'IsDataLossAllowed' => true || false, 'Status' => 'pending|failing-over|cancelling', 'ToDbClusterArn' => '<string>', ], 'GlobalClusterArn' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'GlobalClusterMembers' => [ [ 'DBClusterArn' => '<string>', 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'IsWriter' => true || false, 'Readers' => ['<string>', ...], 'SynchronizationStatus' => 'connected|pending-resync', ], // ... ], 'GlobalClusterResourceId' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
Errors
- GlobalClusterNotFoundFault:
The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster.- InvalidGlobalClusterStateFault:
The global cluster is in an invalid state and can't perform the requested operation.
Examples
Example 1: To delete a global DB cluster
The following example deletes an Aurora MySQL-compatible global DB cluster.
$result = $client->deleteGlobalCluster([ 'GlobalClusterIdentifier' => 'myglobalcluster', ]);
Result syntax:
[ 'GlobalCluster' => [ 'DeletionProtection' => , 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.07.2', 'GlobalClusterArn' => 'arn:aws:rds::123456789012:global-cluster:myglobalcluster', 'GlobalClusterIdentifier' => 'myglobalcluster', 'GlobalClusterMembers' => [ ], 'GlobalClusterResourceId' => 'cluster-f0e523bfe07aabb', 'Status' => 'available', 'StorageEncrypted' => , ], ]
DeleteIntegration
$result = $client->deleteIntegration
([/* ... */]); $promise = $client->deleteIntegrationAsync
([/* ... */]);
Deletes a zero-ETL integration with Amazon Redshift.
Parameter Syntax
$result = $client->deleteIntegration([ 'IntegrationIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- IntegrationIdentifier
-
- Required: Yes
- Type: string
The unique identifier of the integration.
Result Syntax
[ 'AdditionalEncryptionContext' => ['<string>', ...], 'CreateTime' => <DateTime>, 'DataFilter' => '<string>', 'Description' => '<string>', 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', ], // ... ], 'IntegrationArn' => '<string>', 'IntegrationName' => '<string>', 'KMSKeyId' => '<string>', 'SourceArn' => '<string>', 'Status' => 'creating|active|modifying|failed|deleting|syncing|needs_attention', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetArn' => '<string>', ]
Result Details
Members
- AdditionalEncryptionContext
-
- Type: Associative array of custom strings keys (String) to strings
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the integration was created, in Universal Coordinated Time (UTC).
- DataFilter
-
- Type: string
Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
- Description
-
- Type: string
A description of the integration.
- Errors
-
- Type: Array of IntegrationError structures
Any errors associated with the integration.
- IntegrationArn
-
- Type: string
The ARN of the integration.
- IntegrationName
-
- Type: string
The name of the integration.
- KMSKeyId
-
- Type: string
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the database used as the source for replication.
- Status
-
- Type: string
The current status of the integration.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetArn
-
- Type: string
The ARN of the Redshift data warehouse used as the target for replication.
Errors
- IntegrationNotFoundFault:
The specified integration could not be found.
- IntegrationConflictOperationFault:
A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
- InvalidIntegrationStateFault:
The integration is in an invalid state and can't perform the requested operation.
Examples
Example 1: To delete a zero-ETL integration
The following example deletes a zero-ETL integration with Amazon Redshift.
$result = $client->deleteIntegration([ 'IntegrationIdentifier' => '5b9f3d79-7392-4a3e-896c-58eaa1b53231', ]);
Result syntax:
[ 'CreateTime' =>, 'IntegrationArn' => 'arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231', 'IntegrationName' => 'my-integration', 'KMSKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa', 'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-cluster', 'Status' => 'deleting', 'Tags' => [ ], 'TargetArn' => 'arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8', ]
DeleteOptionGroup
$result = $client->deleteOptionGroup
([/* ... */]); $promise = $client->deleteOptionGroupAsync
([/* ... */]);
Deletes an existing option group.
Parameter Syntax
$result = $client->deleteOptionGroup([ 'OptionGroupName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- OptionGroupName
-
- Required: Yes
- Type: string
The name of the option group to be deleted.
You can't delete default option groups.
Result Syntax
[]
Result Details
Errors
- OptionGroupNotFoundFault:
The specified option group could not be found.
- InvalidOptionGroupStateFault:
The option group isn't in the available state.
Examples
Example 1: To delete an option group
The following example deletes the specified option group.
$result = $client->deleteOptionGroup([ 'OptionGroupName' => 'myoptiongroup', ]);
DeleteTenantDatabase
$result = $client->deleteTenantDatabase
([/* ... */]); $promise = $client->deleteTenantDatabaseAsync
([/* ... */]);
Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can't delete a tenant database when it is the only tenant in the DB instance.
Parameter Syntax
$result = $client->deleteTenantDatabase([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'FinalDBSnapshotIdentifier' => '<string>', 'SkipFinalSnapshot' => true || false, 'TenantDBName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.
- FinalDBSnapshotIdentifier
-
- Type: string
The
DBSnapshotIdentifier
of the newDBSnapshot
created when theSkipFinalSnapshot
parameter is disabled.If you enable this parameter and also enable
SkipFinalShapshot
, the command results in an error. - SkipFinalSnapshot
-
- Type: boolean
Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you don't enable this parameter, you must specify the
FinalDBSnapshotIdentifier
parameter. - TenantDBName
-
- Required: Yes
- Type: string
The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.
Result Syntax
[ 'TenantDatabase' => [ 'CharacterSetName' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'DeletionProtection' => true || false, 'MasterUsername' => '<string>', 'NcharCharacterSetName' => '<string>', 'PendingModifiedValues' => [ 'MasterUserPassword' => '<string>', 'TenantDBName' => '<string>', ], 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TenantDBName' => '<string>', 'TenantDatabaseARN' => '<string>', 'TenantDatabaseCreateTime' => <DateTime>, 'TenantDatabaseResourceId' => '<string>', ], ]
Result Details
Members
- TenantDatabase
-
- Type: TenantDatabase structure
A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- TenantDatabaseNotFoundFault:
The specified tenant database wasn't found in the DB instance.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
DeregisterDBProxyTargets
$result = $client->deregisterDBProxyTargets
([/* ... */]); $promise = $client->deregisterDBProxyTargetsAsync
([/* ... */]);
Remove the association between one or more DBProxyTarget
data structures and a DBProxyTargetGroup
.
Parameter Syntax
$result = $client->deregisterDBProxyTargets([ 'DBClusterIdentifiers' => ['<string>', ...], 'DBInstanceIdentifiers' => ['<string>', ...], 'DBProxyName' => '<string>', // REQUIRED 'TargetGroupName' => '<string>', ]);
Parameter Details
Members
- DBClusterIdentifiers
-
- Type: Array of strings
One or more DB cluster identifiers.
- DBInstanceIdentifiers
-
- Type: Array of strings
One or more DB instance identifiers.
- DBProxyName
-
- Required: Yes
- Type: string
The identifier of the
DBProxy
that is associated with theDBProxyTargetGroup
. - TargetGroupName
-
- Type: string
The identifier of the
DBProxyTargetGroup
.
Result Syntax
[]
Result Details
Errors
- DBProxyTargetNotFoundFault:
The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetGroupNotFoundFault:
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
DescribeAccountAttributes
$result = $client->describeAccountAttributes
([/* ... */]); $promise = $client->describeAccountAttributesAsync
([/* ... */]);
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command doesn't take any parameters.
Parameter Syntax
$result = $client->describeAccountAttributes([ ]);
Parameter Details
Members
Result Syntax
[ 'AccountQuotas' => [ [ 'AccountQuotaName' => '<string>', 'Max' => <integer>, 'Used' => <integer>, ], // ... ], ]
Result Details
Members
- AccountQuotas
-
- Type: Array of AccountQuota structures
A list of
AccountQuota
objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe account attributes
The following example retrieves the attributes for the current AWS account.
$result = $client->describeAccountAttributes([ ]);
Result syntax:
[ 'AccountQuotas' => [ [ 'AccountQuotaName' => 'DBInstances', 'Max' => 40, 'Used' => 4, ], [ 'AccountQuotaName' => 'ReservedDBInstances', 'Max' => 40, 'Used' => 0, ], [ 'AccountQuotaName' => 'AllocatedStorage', 'Max' => 100000, 'Used' => 40, ], [ 'AccountQuotaName' => 'DBSecurityGroups', 'Max' => 25, 'Used' => 0, ], [ 'AccountQuotaName' => 'AuthorizationsPerDBSecurityGroup', 'Max' => 20, 'Used' => 0, ], [ 'AccountQuotaName' => 'DBParameterGroups', 'Max' => 50, 'Used' => 1, ], [ 'AccountQuotaName' => 'ManualSnapshots', 'Max' => 100, 'Used' => 3, ], [ 'AccountQuotaName' => 'EventSubscriptions', 'Max' => 20, 'Used' => 0, ], [ 'AccountQuotaName' => 'DBSubnetGroups', 'Max' => 50, 'Used' => 1, ], [ 'AccountQuotaName' => 'OptionGroups', 'Max' => 20, 'Used' => 1, ], [ 'AccountQuotaName' => 'SubnetsPerDBSubnetGroup', 'Max' => 20, 'Used' => 6, ], [ 'AccountQuotaName' => 'ReadReplicasPerMaster', 'Max' => 5, 'Used' => 0, ], [ 'AccountQuotaName' => 'DBClusters', 'Max' => 40, 'Used' => 1, ], [ 'AccountQuotaName' => 'DBClusterParameterGroups', 'Max' => 50, 'Used' => 0, ], [ 'AccountQuotaName' => 'DBClusterRoles', 'Max' => 5, 'Used' => 0, ], ], ]
DescribeBlueGreenDeployments
$result = $client->describeBlueGreenDeployments
([/* ... */]); $promise = $client->describeBlueGreenDeploymentsAsync
([/* ... */]);
Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->describeBlueGreenDeployments([ 'BlueGreenDeploymentIdentifier' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- BlueGreenDeploymentIdentifier
-
- Type: string
The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case-sensitive.
Constraints:
-
Must match an existing blue/green deployment identifier.
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more blue/green deployments to describe.
Valid Values:
-
blue-green-deployment-identifier
- Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers. -
blue-green-deployment-name
- Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names. -
source
- Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases. -
target
- Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeBlueGreenDeployments
request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints:
-
Must be a minimum of 20.
-
Can't exceed 100.
Result Syntax
[ 'BlueGreenDeployments' => [ [ 'BlueGreenDeploymentIdentifier' => '<string>', 'BlueGreenDeploymentName' => '<string>', 'CreateTime' => <DateTime>, 'DeleteTime' => <DateTime>, 'Source' => '<string>', 'Status' => '<string>', 'StatusDetails' => '<string>', 'SwitchoverDetails' => [ [ 'SourceMember' => '<string>', 'Status' => '<string>', 'TargetMember' => '<string>', ], // ... ], 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Target' => '<string>', 'Tasks' => [ [ 'Name' => '<string>', 'Status' => '<string>', ], // ... ], ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- BlueGreenDeployments
-
- Type: Array of BlueGreenDeployment structures
A list of blue/green deployments in the current account and Amazon Web Services Region.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeBlueGreenDeployments
request.
Errors
- BlueGreenDeploymentNotFoundFault:
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
Examples
Example 1: To describe a blue/green deployment of an RDS DB instance after creation completes
The following example retrieves the details of a blue/green deployment after creation completes.
$result = $client->describeBlueGreenDeployments([ 'BlueGreenDeploymentIdentifier' => 'bgd-v53303651eexfake', ]);
Result syntax:
[ 'BlueGreenDeployments' => [ [ 'BlueGreenDeploymentIdentifier' => 'bgd-v53303651eexfake', 'BlueGreenDeploymentName' => 'bgd-cli-test-instance', 'CreateTime' =>, 'Source' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', 'Status' => 'AVAILABLE', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t', ], ], 'Target' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe', 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'COMPLETED', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'COMPLETED', ], [ 'Name' => 'CONFIGURE_BACKUPS', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATING_TOPOLOGY_OF_SOURCE', 'Status' => 'COMPLETED', ], ], ], ], ]
Example 2: To describe a blue/green deployment for an Aurora MySQL DB cluster
The following example retrieves the details of a blue/green deployment.
$result = $client->describeBlueGreenDeployments([ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', ]);
Result syntax:
[ 'BlueGreenDeployments' => [ [ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', 'BlueGreenDeploymentName' => 'my-blue-green-deployment', 'CreateTime' =>, 'Source' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Status' => 'AVAILABLE', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg', ], ], 'Target' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl', 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'COMPLETED', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATE_DB_INSTANCES_FOR_CLUSTER', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATE_CUSTOM_ENDPOINTS', 'Status' => 'COMPLETED', ], ], ], ], ]
Example 3: To describe a blue/green deployment for an Aurora MySQL cluster after switchover
The following example retrieves the details about a blue/green deployment after the green environment is promoted to be the production environment.
$result = $client->describeBlueGreenDeployments([ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', ]);
Result syntax:
[ 'BlueGreenDeployments' => [ [ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', 'BlueGreenDeploymentName' => 'my-blue-green-deployment', 'CreateTime' =>, 'Source' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1', 'Status' => 'SWITCHOVER_COMPLETED', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1', 'Status' => 'SWITCHOVER_COMPLETED', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-old1', 'Status' => 'SWITCHOVER_COMPLETED', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-old1', 'Status' => 'SWITCHOVER_COMPLETED', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-old1', 'Status' => 'SWITCHOVER_COMPLETED', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-old1', 'Status' => 'SWITCHOVER_COMPLETED', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-old1', 'Status' => 'SWITCHOVER_COMPLETED', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint', ], ], 'Target' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'COMPLETED', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATE_DB_INSTANCES_FOR_CLUSTER', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATE_CUSTOM_ENDPOINTS', 'Status' => 'COMPLETED', ], ], ], ], ]
DescribeCertificates
$result = $client->describeCertificates
([/* ... */]); $promise = $client->describeCertificatesAsync
([/* ... */]);
Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->describeCertificates([ 'CertificateIdentifier' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- CertificateIdentifier
-
- Type: string
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
Constraints:
-
Must match an existing CertificateIdentifier.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeCertificates
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'Certificates' => [ [ 'CertificateArn' => '<string>', 'CertificateIdentifier' => '<string>', 'CertificateType' => '<string>', 'CustomerOverride' => true || false, 'CustomerOverrideValidTill' => <DateTime>, 'Thumbprint' => '<string>', 'ValidFrom' => <DateTime>, 'ValidTill' => <DateTime>, ], // ... ], 'DefaultCertificateForNewLaunches' => '<string>', 'Marker' => '<string>', ]
Result Details
Members
- Certificates
-
- Type: Array of Certificate structures
The list of
Certificate
objects for the Amazon Web Services account. - DefaultCertificateForNewLaunches
-
- Type: string
The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the
ModifyCertificates
operation. - Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeCertificates
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
Errors
- CertificateNotFoundFault:
CertificateIdentifier
doesn't refer to an existing certificate.
Examples
Example 1: To describe certificates
The following example retrieves the details of the certificate associated with the user's default region.
$result = $client->describeCertificates([ ]);
Result syntax:
[ 'Certificates' => [ [ 'CertificateArn' => 'arn:aws:rds:us-east-1::cert:rds-ca-ecc384-g1', 'CertificateIdentifier' => 'rds-ca-ecc384-g1', 'CertificateType' => 'CA', 'CustomerOverride' => , 'Thumbprint' => '24a97b91cbe86911190576c35c36aab4fEXAMPLE', 'ValidFrom' =>, 'ValidTill' => , ], [ 'CertificateArn' => 'arn:aws:rds:us-east-1::cert:rds-ca-rsa4096-g1', 'CertificateIdentifier' => 'rds-ca-rsa4096-g1', 'CertificateType' => 'CA', 'CustomerOverride' => , 'Thumbprint' => '9da6fa7fd2ec09c569a400d876b01b0c1EXAMPLE', 'ValidFrom' => , 'ValidTill' => , ], [ 'CertificateArn' => 'arn:aws:rds:us-east-1::cert:rds-ca-rsa2048-g1', 'CertificateIdentifier' => 'rds-ca-rsa2048-g1', 'CertificateType' => 'CA', 'CustomerOverride' => 1, 'CustomerOverrideValidTill' => , 'Thumbprint' => '2fa77ef894d983ba9d37ad699c84ab0f6EXAMPLE', 'ValidFrom' => , 'ValidTill' => , ], [ 'CertificateArn' => 'arn:aws:rds:us-east-1::cert:rds-ca-2019', 'CertificateIdentifier' => 'rds-ca-2019', 'CertificateType' => 'CA', 'CustomerOverride' => , 'Thumbprint' => 'f0ed823ed14447bab557fdf3e49274669EXAMPLE', 'ValidFrom' => , 'ValidTill' => , ], ], ]
DescribeDBClusterAutomatedBackups
$result = $client->describeDBClusterAutomatedBackups
([/* ... */]); $promise = $client->describeDBClusterAutomatedBackupsAsync
([/* ... */]);
Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups
and DescribeDBClusters
operations.
All parameters are optional.
Parameter Syntax
$result = $client->describeDBClusterAutomatedBackups([ 'DBClusterIdentifier' => '<string>', 'DbClusterResourceId' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Type: string
(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.
- DbClusterResourceId
-
- Type: string
The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.
- Filters
-
- Type: Array of Filter structures
A filter that specifies which resources to return based on status.
Supported filters are the following:
-
status
-
retained
- Automated backups for deleted clusters and after backup replication is stopped.
-
-
db-cluster-id
- Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs. -
db-cluster-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
- Marker
-
- Type: string
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Result Syntax
[ 'DBClusterAutomatedBackups' => [ [ 'AllocatedStorage' => <integer>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'ClusterCreateTime' => <DateTime>, 'DBClusterArn' => '<string>', 'DBClusterAutomatedBackupsArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DbClusterResourceId' => '<string>', 'Engine' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'Port' => <integer>, 'Region' => '<string>', 'RestoreWindow' => [ 'EarliestTime' => <DateTime>, 'LatestTime' => <DateTime>, ], 'Status' => '<string>', 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'VpcId' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBClusterAutomatedBackups
-
- Type: Array of DBClusterAutomatedBackup structures
A list of
DBClusterAutomatedBackup
backups. - Marker
-
- Type: string
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to
MaxRecords
.
Errors
- DBClusterAutomatedBackupNotFoundFault:
No automated backup for this DB cluster was found.
DescribeDBClusterBacktracks
$result = $client->describeDBClusterBacktracks
([/* ... */]); $promise = $client->describeDBClusterBacktracksAsync
([/* ... */]);
Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
Parameter Syntax
$result = $client->describeDBClusterBacktracks([ 'BacktrackIdentifier' => '<string>', 'DBClusterIdentifier' => '<string>', // REQUIRED 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- BacktrackIdentifier
-
- Type: string
If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
-
Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see Universally unique identifier.
Example:
123e4567-e89b-12d3-a456-426655440000
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more DB clusters to describe. Supported filters include the following:
-
db-cluster-backtrack-id
- Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers. -
db-cluster-backtrack-status
- Accepts any of the following backtrack status values:-
applying
-
completed
-
failed
-
pending
The results list includes information about only the backtracks identified by these values.
-
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterBacktracks
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBClusterBacktracks' => [ [ 'BacktrackIdentifier' => '<string>', 'BacktrackRequestCreationTime' => <DateTime>, 'BacktrackTo' => <DateTime>, 'BacktrackedFrom' => <DateTime>, 'DBClusterIdentifier' => '<string>', 'Status' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBClusterBacktracks
-
- Type: Array of DBClusterBacktrack structures
Contains a list of backtracks for the user.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeDBClusterBacktracks
request.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBClusterBacktrackNotFoundFault:
BacktrackIdentifier
doesn't refer to an existing backtrack.
Examples
Example 1: To describe backtracks for a DB cluster
The following example retrieves details about the specified DB cluster.
$result = $client->describeDBClusterBacktracks([ 'DBClusterIdentifier' => 'mydbcluster', ]);
Result syntax:
[ 'DBClusterBacktracks' => [ [ 'BacktrackIdentifier' => '2f5f5294-0dd2-44c9-9f50-EXAMPLE', 'BacktrackRequestCreationTime' =>, 'BacktrackTo' => , 'BacktrackedFrom' => , 'DBClusterIdentifier' => 'mydbcluster', 'Status' => 'COMPLETED', ], [ 'BacktrackIdentifier' => '3c7a6421-af2a-4ea3-ae95-EXAMPLE', 'BacktrackRequestCreationTime' => , 'BacktrackTo' => , 'BacktrackedFrom' => , 'DBClusterIdentifier' => 'mydbcluster', 'Status' => 'COMPLETED', ], ], ]
DescribeDBClusterEndpoints
$result = $client->describeDBClusterEndpoints
([/* ... */]); $promise = $client->describeDBClusterEndpointsAsync
([/* ... */]);
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Parameter Syntax
$result = $client->describeDBClusterEndpoints([ 'DBClusterEndpointIdentifier' => '<string>', 'DBClusterIdentifier' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBClusterEndpointIdentifier
-
- Type: string
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
- DBClusterIdentifier
-
- Type: string
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
- Filters
-
- Type: Array of Filter structures
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,...
.Name
can be one of:db-cluster-endpoint-type
,db-cluster-endpoint-custom-type
,db-cluster-endpoint-id
,db-cluster-endpoint-status
.Values
for thedb-cluster-endpoint-type
filter can be one or more of:reader
,writer
,custom
.Values
for thedb-cluster-endpoint-custom-type
filter can be one or more of:reader
,any
.Values
for thedb-cluster-endpoint-status
filter can be one or more of:available
,creating
,deleting
,inactive
,modifying
. - Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterEndpoints
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBClusterEndpoints' => [ [ 'CustomEndpointType' => '<string>', 'DBClusterEndpointArn' => '<string>', 'DBClusterEndpointIdentifier' => '<string>', 'DBClusterEndpointResourceIdentifier' => '<string>', 'DBClusterIdentifier' => '<string>', 'Endpoint' => '<string>', 'EndpointType' => '<string>', 'ExcludedMembers' => ['<string>', ...], 'StaticMembers' => ['<string>', ...], 'Status' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBClusterEndpoints
-
- Type: Array of DBClusterEndpoint structures
Contains the details of the endpoints associated with the cluster and matching any filter conditions.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterEndpoints
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.
Examples
Example 1: To describe DB cluster endpoints
The following example retrieves details for your DB cluster endpoints. The most common kinds of Aurora clusters have two endpoints. One endpoint has type WRITER. You can use this endpoint for all SQL statements. The other endpoint has type READER. You can use this endpoint only for SELECT and other read-only SQL statements.
$result = $client->describeDBClusterEndpoints([ ]);
Result syntax:
[ 'DBClusterEndpoints' => [ [ 'DBClusterIdentifier' => 'my-database-1', 'Endpoint' => 'my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com', 'EndpointType' => 'WRITER', 'Status' => 'creating', ], [ 'DBClusterIdentifier' => 'my-database-1', 'Endpoint' => 'my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com', 'EndpointType' => 'READER', 'Status' => 'creating', ], [ 'DBClusterIdentifier' => 'mydbcluster', 'Endpoint' => 'mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com', 'EndpointType' => 'WRITER', 'Status' => 'available', ], [ 'DBClusterIdentifier' => 'mydbcluster', 'Endpoint' => 'mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com', 'EndpointType' => 'READER', 'Status' => 'available', ], ], ]
Example 2: To describe DB cluster endpoints of a single DB cluster
The following example retrieves details for the DB cluster endpoints of a single specified DB cluster. Aurora Serverless clusters have only a single endpoint with a type of WRITER.
$result = $client->describeDBClusterEndpoints([ 'DBClusterIdentifier' => 'serverless-cluster', ]);
Result syntax:
[ 'DBClusterEndpoints' => [ [ 'DBClusterIdentifier' => 'serverless-cluster', 'Endpoint' => 'serverless-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com', 'EndpointType' => 'WRITER', 'Status' => 'available', ], ], ]
DescribeDBClusterParameterGroups
$result = $client->describeDBClusterParameterGroups
([/* ... */]); $promise = $client->describeDBClusterParameterGroupsAsync
([/* ... */]);
Returns a list of DBClusterParameterGroup
descriptions. If a DBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->describeDBClusterParameterGroups([ 'DBClusterParameterGroupName' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBClusterParameterGroupName
-
- Type: string
The name of a specific DB cluster parameter group to return details for.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterParameterGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBClusterParameterGroups' => [ [ 'DBClusterParameterGroupArn' => '<string>', 'DBClusterParameterGroupName' => '<string>', 'DBParameterGroupFamily' => '<string>', 'Description' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBClusterParameterGroups
-
- Type: Array of DBClusterParameterGroup structures
A list of DB cluster parameter groups.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterParameterGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
Errors
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Examples
Example 1: To describe DB cluster parameter groups
The following example retrieves details for your DB cluster parameter groups.
$result = $client->describeDBClusterParameterGroups([ ]);
Result syntax:
[ 'DBClusterParameterGroups' => [ [ 'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7', 'DBClusterParameterGroupName' => 'default.aurora-mysql5.7', 'DBParameterGroupFamily' => 'aurora-mysql5.7', 'Description' => 'Default cluster parameter group for aurora-mysql5.7', ], [ 'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6', 'DBClusterParameterGroupName' => 'default.aurora-postgresql9.6', 'DBParameterGroupFamily' => 'aurora-postgresql9.6', 'Description' => 'Default cluster parameter group for aurora-postgresql9.6', ], [ 'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6', 'DBClusterParameterGroupName' => 'default.aurora5.6', 'DBParameterGroupFamily' => 'aurora5.6', 'Description' => 'Default cluster parameter group for aurora5.6', ], [ 'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg', 'DBClusterParameterGroupName' => 'mydbclusterpg', 'DBParameterGroupFamily' => 'aurora-mysql5.7', 'Description' => 'My DB cluster parameter group', ], [ 'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy', 'DBClusterParameterGroupName' => 'mydbclusterpgcopy', 'DBParameterGroupFamily' => 'aurora-mysql5.7', 'Description' => 'Copy of mydbclusterpg parameter group', ], ], ]
DescribeDBClusterParameters
$result = $client->describeDBClusterParameters
([/* ... */]); $promise = $client->describeDBClusterParametersAsync
([/* ... */]);
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->describeDBClusterParameters([ 'DBClusterParameterGroupName' => '<string>', // REQUIRED 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'Source' => '<string>', ]);
Parameter Details
Members
- DBClusterParameterGroupName
-
- Required: Yes
- Type: string
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- Source
-
- Type: string
A specific source to return parameters for.
Valid Values:
-
customer
-
engine
-
service
Result Syntax
[ 'Marker' => '<string>', 'Parameters' => [ [ 'AllowedValues' => '<string>', 'ApplyMethod' => 'immediate|pending-reboot', 'ApplyType' => '<string>', 'DataType' => '<string>', 'Description' => '<string>', 'IsModifiable' => true || false, 'MinimumEngineVersion' => '<string>', 'ParameterName' => '<string>', 'ParameterValue' => '<string>', 'Source' => '<string>', 'SupportedEngineModes' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - Parameters
-
- Type: Array of Parameter structures
Provides a list of parameters for the DB cluster parameter group.
Errors
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Examples
Example 1: To describe the parameters in a DB cluster parameter group
The following example retrieves details about the parameters in a DB cluster parameter group.
$result = $client->describeDBClusterParameters([ 'DBClusterParameterGroupName' => 'mydbclusterpg', ]);
Result syntax:
[ 'Parameters' => [ [ 'AllowedValues' => '0,1', 'ApplyMethod' => 'pending-reboot', 'ApplyType' => 'static', 'DataType' => 'boolean', 'Description' => 'Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded', 'IsModifiable' => , 'ParameterName' => 'allow-suspicious-udfs', 'Source' => 'engine-default', 'SupportedEngineModes' => [ 'provisioned', ], ], [ 'AllowedValues' => '0,1', 'ApplyMethod' => 'pending-reboot', 'ApplyType' => 'static', 'DataType' => 'boolean', 'Description' => 'Enables new features in the Aurora engine.', 'IsModifiable' => 1, 'ParameterName' => 'aurora_lab_mode', 'ParameterValue' => '0', 'Source' => 'engine-default', 'SupportedEngineModes' => [ 'provisioned', ], ], ], // Some output ommitted. ]
DescribeDBClusterSnapshotAttributes
$result = $client->describeDBClusterSnapshotAttributes
([/* ... */]); $promise = $client->describeDBClusterSnapshotAttributesAsync
([/* ... */]);
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes
returns the restore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all
is included in the list of values for the restore
attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute
API action.
Parameter Syntax
$result = $client->describeDBClusterSnapshotAttributes([ 'DBClusterSnapshotIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier for the DB cluster snapshot to describe the attributes for.
Result Syntax
[ 'DBClusterSnapshotAttributesResult' => [ 'DBClusterSnapshotAttributes' => [ [ 'AttributeName' => '<string>', 'AttributeValues' => ['<string>', ...], ], // ... ], 'DBClusterSnapshotIdentifier' => '<string>', ], ]
Result Details
Members
- DBClusterSnapshotAttributesResult
-
- Type: DBClusterSnapshotAttributesResult structure
Contains the results of a successful call to the
DescribeDBClusterSnapshotAttributes
API action.Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.
Errors
- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.
Examples
Example 1: To describe the attribute names and values for a DB cluster snapshot
The following example retrieves details of the attribute names and values for the specified DB cluster snapshot.
$result = $client->describeDBClusterSnapshotAttributes([ 'DBClusterSnapshotIdentifier' => 'myclustersnapshot', ]);
Result syntax:
[ 'DBClusterSnapshotAttributesResult' => [ 'DBClusterSnapshotAttributes' => [ [ 'AttributeName' => 'restore', 'AttributeValues' => [ '123456789012', ], ], ], 'DBClusterSnapshotIdentifier' => 'myclustersnapshot', ], ]
DescribeDBClusterSnapshots
$result = $client->describeDBClusterSnapshots
([/* ... */]); $promise = $client->describeDBClusterSnapshotsAsync
([/* ... */]);
Returns information about DB cluster snapshots. This API action supports pagination.
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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->describeDBClusterSnapshots([ 'DBClusterIdentifier' => '<string>', 'DBClusterSnapshotIdentifier' => '<string>', 'DbClusterResourceId' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'IncludePublic' => true || false, 'IncludeShared' => true || false, 'Marker' => '<string>', 'MaxRecords' => <integer>, 'SnapshotType' => '<string>', ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Type: string
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.Constraints:
-
If supplied, must match the identifier of an existing DBCluster.
- DBClusterSnapshotIdentifier
-
- Type: string
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the
DBClusterIdentifier
parameter. This value is stored as a lowercase string.Constraints:
-
If supplied, must match the identifier of an existing DBClusterSnapshot.
-
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
- DbClusterResourceId
-
- Type: string
A specific DB cluster resource ID to describe.
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). -
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers. -
snapshot-type
- Accepts types of DB cluster snapshots. -
engine
- Accepts names of database engines.
- IncludePublic
-
- Type: boolean
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
- IncludeShared
-
- Type: boolean
Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the
ModifyDBClusterSnapshotAttribute
API action. - Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- SnapshotType
-
- Type: string
The type of DB cluster snapshots to be returned. You can specify one of the following values:
-
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. -
manual
- Return all DB cluster snapshots that have been taken by my Amazon Web Services account. -
shared
- Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. -
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a
SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling theIncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling theIncludePublic
parameter.The
IncludeShared
andIncludePublic
parameters don't apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn't apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn't apply whenSnapshotType
is set topublic
.
Result Syntax
[ 'DBClusterSnapshots' => [ [ 'AllocatedStorage' => <integer>, 'AvailabilityZones' => ['<string>', ...], 'ClusterCreateTime' => <DateTime>, 'DBClusterIdentifier' => '<string>', 'DBClusterSnapshotArn' => '<string>', 'DBClusterSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbClusterResourceId' => '<string>', 'Engine' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'PercentProgress' => <integer>, 'Port' => <integer>, 'SnapshotCreateTime' => <DateTime>, 'SnapshotType' => '<string>', 'SourceDBClusterSnapshotArn' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcId' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBClusterSnapshots
-
- Type: Array of DBClusterSnapshot structures
Provides a list of DB cluster snapshots for the user.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
Errors
- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.
Examples
Example 1: To describe a DB cluster snapshot for a DB cluster
The following example retrieves the details for the DB cluster snapshots for the specified DB cluster.
$result = $client->describeDBClusterSnapshots([ 'DBClusterIdentifier' => 'mydbcluster', ]);
Result syntax:
[ 'DBClusterSnapshots' => [ [ 'AllocatedStorage' => 0, 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1b', 'us-east-1e', ], 'ClusterCreateTime' =>, 'DBClusterIdentifier' => 'mydbcluster', 'DBClusterSnapshotArn' => 'arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy', 'DBClusterSnapshotIdentifier' => 'myclustersnapshotcopy', 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.04.2', 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE', 'LicenseModel' => 'aurora-mysql', 'MasterUsername' => 'myadmin', 'PercentProgress' => 100, 'Port' => 0, 'SnapshotCreateTime' => , 'SnapshotType' => 'manual', 'Status' => 'available', 'StorageEncrypted' => 1, 'VpcId' => 'vpc-6594f31c', ], [ 'AllocatedStorage' => 0, 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1b', 'us-east-1e', ], 'ClusterCreateTime' => , 'DBClusterIdentifier' => 'mydbcluster', 'DBClusterSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16', 'DBClusterSnapshotIdentifier' => 'rds:mydbcluster-2019-06-20-09-16', 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.04.2', 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE', 'LicenseModel' => 'aurora-mysql', 'MasterUsername' => 'myadmin', 'PercentProgress' => 100, 'Port' => 0, 'SnapshotCreateTime' => , 'SnapshotType' => 'automated', 'Status' => 'available', 'StorageEncrypted' => 1, 'VpcId' => 'vpc-6594f31c', ], ], ]
DescribeDBClusters
$result = $client->describeDBClusters
([/* ... */]); $promise = $client->describeDBClustersAsync
([/* ... */]);
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
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 DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Parameter Syntax
$result = $client->describeDBClusters([ 'DBClusterIdentifier' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'IncludeShared' => true || false, 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Type: string
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match an existing DB cluster identifier.
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more DB clusters to describe.
Supported Filters:
-
clone-group-id
- Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups. -
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs. -
db-cluster-resource-id
- Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers. -
domain
- Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains. -
engine
- Accepts engine names. The results list only includes information about the DB clusters for these engines.
- IncludeShared
-
- Type: boolean
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100
Result Syntax
[ 'DBClusters' => [ [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBClusters
-
- Type: Array of DBCluster structures
Contains a list of DB clusters for the user.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeDBClusters
request.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.
Examples
Example 1: To describe a DB cluster
The following example retrieves the details of the specified DB cluster.
$result = $client->describeDBClusters([ 'DBClusterIdentifier' => 'mydbcluster', ]);
Result syntax:
[ 'DBClusters' => [ [ 'AllocatedStorage' => 1, 'AssociatedRoles' => [ ], 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1b', 'us-east-1e', ], 'BackupRetentionPeriod' => 1, 'ClusterCreateTime' =>, 'DBClusterArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster', 'DBClusterIdentifier' => 'mydbcluster', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => 'in-sync', 'DBInstanceIdentifier' => 'dbinstance3', 'IsClusterWriter' => , 'PromotionTier' => 1, ], [ 'DBClusterParameterGroupStatus' => 'in-sync', 'DBInstanceIdentifier' => 'dbinstance1', 'IsClusterWriter' => , 'PromotionTier' => 1, ], [ 'DBClusterParameterGroupStatus' => 'in-sync', 'DBInstanceIdentifier' => 'dbinstance2', 'IsClusterWriter' => , 'PromotionTier' => 1, ], [ 'DBClusterParameterGroupStatus' => 'in-sync', 'DBInstanceIdentifier' => 'mydbcluster', 'IsClusterWriter' => , 'PromotionTier' => 1, ], [ 'DBClusterParameterGroupStatus' => 'in-sync', 'DBInstanceIdentifier' => 'mydbcluster-us-east-1b', 'IsClusterWriter' => , 'PromotionTier' => 1, ], [ 'DBClusterParameterGroupStatus' => 'in-sync', 'DBInstanceIdentifier' => 'mydbcluster', 'IsClusterWriter' => 1, 'PromotionTier' => 1, ], ], 'DBClusterParameterGroup' => 'default.aurora-mysql5.7', 'DBSubnetGroup' => 'default', 'DatabaseName' => 'mydbcluster', 'DbClusterResourceId' => 'cluster-AKIAIOSFODNN7EXAMPLE', 'DeletionProtection' => , 'EarliestRestorableTime' => , 'Endpoint' => 'mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com', 'Engine' => 'aurora-mysql', 'EngineMode' => 'provisioned', 'EngineVersion' => '5.7.mysql_aurora.2.04.2', 'HostedZoneId' => 'Z2R2ITUGPM61AM', 'HttpEndpointEnabled' => , 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE', 'LatestRestorableTime' => , 'MasterUsername' => 'myadmin', 'MultiAZ' => 1, 'Port' => 3306, 'PreferredBackupWindow' => '09:09-09:39', 'PreferredMaintenanceWindow' => 'sat:04:09-sat:04:39', 'ReadReplicaIdentifiers' => [ ], 'ReaderEndpoint' => 'mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com', 'Status' => 'available', 'StorageEncrypted' => 1, 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-0b9130572daf3dc16', ], ], ], ], ]
DescribeDBEngineVersions
$result = $client->describeDBEngineVersions
([/* ... */]); $promise = $client->describeDBEngineVersionsAsync
([/* ... */]);
Describes the properties of specific versions of DB engines.
Parameter Syntax
$result = $client->describeDBEngineVersions([ 'DBParameterGroupFamily' => '<string>', 'DefaultOnly' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'IncludeAll' => true || false, 'ListSupportedCharacterSets' => true || false, 'ListSupportedTimezones' => true || false, 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBParameterGroupFamily
-
- Type: string
The name of a specific DB parameter group family to return details for.
Constraints:
-
If supplied, must match an existing DB parameter group family.
- DefaultOnly
-
- Type: boolean
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
- Engine
-
- Type: string
The database engine to return version details for.
Valid Values:
-
aurora-mysql
-
aurora-postgresql
-
custom-oracle-ee
-
custom-oracle-ee-cdb
-
custom-oracle-se2
-
custom-oracle-se2-cdb
-
db2-ae
-
db2-se
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
- EngineVersion
-
- Type: string
A specific database engine version to return details for.
Example:
5.1.49
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more DB engine versions to describe.
Supported filters:
-
db-parameter-group-family
- Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families. -
engine
- Accepts engine names. The results list only includes information about the DB engine versions for these engines. -
engine-mode
- Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:-
global
-
multimaster
-
parallelquery
-
provisioned
-
serverless
-
-
engine-version
- Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions. -
status
- Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:-
available
-
deprecated
-
- IncludeAll
-
- Type: boolean
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
- ListSupportedCharacterSets
-
- Type: boolean
Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the
CharacterSetName
parameter forCreateDBInstance
, the response includes a list of supported character sets for each engine version.For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
- ListSupportedTimezones
-
- Type: boolean
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the
TimeZone
parameter forCreateDBInstance
, the response includes a list of supported time zones for each engine version.For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more than the
MaxRecords
value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBEngineVersions' => [ [ 'CreateTime' => <DateTime>, 'CustomDBEngineVersionManifest' => '<string>', 'DBEngineDescription' => '<string>', 'DBEngineMediaType' => '<string>', 'DBEngineVersionArn' => '<string>', 'DBEngineVersionDescription' => '<string>', 'DBParameterGroupFamily' => '<string>', 'DatabaseInstallationFilesS3BucketName' => '<string>', 'DatabaseInstallationFilesS3Prefix' => '<string>', 'DefaultCharacterSet' => [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], 'Engine' => '<string>', 'EngineVersion' => '<string>', 'ExportableLogTypes' => ['<string>', ...], 'Image' => [ 'ImageId' => '<string>', 'Status' => '<string>', ], 'KMSKeyId' => '<string>', 'MajorEngineVersion' => '<string>', 'ServerlessV2FeaturesSupport' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, ], 'Status' => '<string>', 'SupportedCACertificateIdentifiers' => ['<string>', ...], 'SupportedCharacterSets' => [ [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], // ... ], 'SupportedEngineModes' => ['<string>', ...], 'SupportedFeatureNames' => ['<string>', ...], 'SupportedNcharCharacterSets' => [ [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], // ... ], 'SupportedTimezones' => [ [ 'TimezoneName' => '<string>', ], // ... ], 'SupportsBabelfish' => true || false, 'SupportsCertificateRotationWithoutRestart' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIntegrations' => true || false, 'SupportsLimitlessDatabase' => true || false, 'SupportsLocalWriteForwarding' => true || false, 'SupportsLogExportsToCloudwatchLogs' => true || false, 'SupportsParallelQuery' => true || false, 'SupportsReadReplica' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ValidUpgradeTarget' => [ [ 'AutoUpgrade' => true || false, 'Description' => '<string>', 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IsMajorVersionUpgrade' => true || false, 'SupportedEngineModes' => ['<string>', ...], 'SupportsBabelfish' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIntegrations' => true || false, 'SupportsLimitlessDatabase' => true || false, 'SupportsLocalWriteForwarding' => true || false, 'SupportsParallelQuery' => true || false, ], // ... ], ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBEngineVersions
-
- Type: Array of DBEngineVersion structures
A list of
DBEngineVersion
elements. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe the DB engine versions for the MySQL DB engine
The following example displays details about each of the DB engine versions for the specified DB engine.
$result = $client->describeDBEngineVersions([ 'Engine' => 'mysql', ]);
Result syntax:
[ 'DBEngineVersions' => [ [ 'DBEngineDescription' => 'MySQL Community Edition', 'DBEngineVersionDescription' => 'MySQL 5.7.33', 'DBParameterGroupFamily' => 'mysql5.7', 'Engine' => 'mysql', 'EngineVersion' => '5.7.33', 'ValidUpgradeTarget' => [ [ 'AutoUpgrade' => , 'Description' => 'MySQL 5.7.34', 'Engine' => 'mysql', 'EngineVersion' => '5.7.34', 'IsMajorVersionUpgrade' => , ], [ 'AutoUpgrade' => , 'Description' => 'MySQL 5.7.36', 'Engine' => 'mysql', 'EngineVersion' => '5.7.36', 'IsMajorVersionUpgrade' => , ], ], ], ], // Some output ommitted. ]
DescribeDBInstanceAutomatedBackups
$result = $client->describeDBInstanceAutomatedBackups
([/* ... */]); $promise = $client->describeDBInstanceAutomatedBackupsAsync
([/* ... */]);
Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups
and DescribeDBInstances
operations.
All parameters are optional.
Parameter Syntax
$result = $client->describeDBInstanceAutomatedBackups([ 'DBInstanceAutomatedBackupsArn' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBInstanceAutomatedBackupsArn
-
- Type: string
The Amazon Resource Name (ARN) of the replicated automated backups, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.This setting doesn't apply to RDS Custom.
- DBInstanceIdentifier
-
- Type: string
(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.
- DbiResourceId
-
- Type: string
The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
- Filters
-
- Type: Array of Filter structures
A filter that specifies which resources to return based on status.
Supported filters are the following:
-
status
-
active
- Automated backups for current instances. -
creating
- Automated backups that are waiting for the first automated snapshot to be available. -
retained
- Automated backups for deleted instances and after backup replication is stopped.
-
-
db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs. -
dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
- Marker
-
- Type: string
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Result Syntax
[ 'DBInstanceAutomatedBackups' => [ [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'Port' => <integer>, 'Region' => '<string>', 'RestoreWindow' => [ 'EarliestTime' => <DateTime>, 'LatestTime' => <DateTime>, ], 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBInstanceAutomatedBackups
-
- Type: Array of DBInstanceAutomatedBackup structures
A list of
DBInstanceAutomatedBackup
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBInstanceAutomatedBackupNotFoundFault:
No automated backup for this DB instance was found.
Examples
Example 1: To describe the automated backups for a DB instance
The following example displays details about the automated backups for the specified DB instance. The details include replicated automated backups in other AWS Regions.
$result = $client->describeDBInstanceAutomatedBackups([ 'DBInstanceIdentifier' => 'new-orcl-db', ]);
Result syntax:
[ 'DBInstanceAutomatedBackups' => [ [ 'AllocatedStorage' => 20, 'BackupRetentionPeriod' => 14, 'DBInstanceArn' => 'arn:aws:rds:us-east-1:123456789012:db:new-orcl-db', 'DBInstanceAutomatedBackupsArn' => 'arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example', 'DBInstanceIdentifier' => 'new-orcl-db', 'DbiResourceId' => 'db-JKIB2GFQ5RV7REPLZA4EXAMPLE', 'Encrypted' => , 'Engine' => 'oracle-se2', 'EngineVersion' => '12.1.0.2.v21', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'LicenseModel' => 'bring-your-own-license', 'MasterUsername' => 'admin', 'OptionGroupName' => 'default:oracle-se2-12-1', 'Port' => 1521, 'Region' => 'us-east-1', 'RestoreWindow' => [ 'EarliestTime' => , 'LatestTime' => , ], 'Status' => 'replicating', 'StorageType' => 'gp2', ], ], ]
DescribeDBInstances
$result = $client->describeDBInstances
([/* ... */]); $promise = $client->describeDBInstancesAsync
([/* ... */]);
Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Parameter Syntax
$result = $client->describeDBInstances([ 'DBInstanceIdentifier' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Type: string
The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match the identifier of an existing DB instance.
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more DB instances to describe.
Supported Filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs. -
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs. -
dbi-resource-id
- Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers. -
domain
- Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains. -
engine
- Accepts engine names. The results list only includes information about the DB instances for these engines.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBInstances' => [ [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBInstances
-
- Type: Array of DBInstance structures
A list of
DBInstance
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.
Examples
Example 1: To describe a DB instance
The following example retrieves details about the specified DB instance.
$result = $client->describeDBInstances([ 'DBInstanceIdentifier' => 'mydbinstancecf', ]);
Result syntax:
[ 'DBInstances' => [ [ 'DBInstanceClass' => 'db.t3.small', 'DBInstanceIdentifier' => 'mydbinstancecf', 'DBInstanceStatus' => 'available', 'Endpoint' => [ 'Address' => 'mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com', 'HostedZoneId' => 'Z2R2ITUGPM61AM', 'Port' => 3306, ], 'Engine' => 'mysql', 'MasterUsername' => 'admin', ], ], // Some output ommitted. ]
DescribeDBLogFiles
$result = $client->describeDBLogFiles
([/* ... */]); $promise = $client->describeDBLogFilesAsync
([/* ... */]);
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
Parameter Syntax
$result = $client->describeDBLogFiles([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'FileLastWritten' => <integer>, 'FileSize' => <integer>, 'FilenameContains' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
-
Must match the identifier of an existing DBInstance.
- FileLastWritten
-
- Type: long (int|float)
Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
- FileSize
-
- Type: long (int|float)
Filters the available log files for files larger than the specified size.
- FilenameContains
-
- Type: string
Filters the available log files for log file names that contain the specified string.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
- MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Result Syntax
[ 'DescribeDBLogFiles' => [ [ 'LastWritten' => <integer>, 'LogFileName' => '<string>', 'Size' => <integer>, ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DescribeDBLogFiles
-
- Type: Array of DescribeDBLogFilesDetails structures
The DB log files returned.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeDBLogFiles
request.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBInstanceNotReadyFault:
An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.
Examples
Example 1: To describe the log files for a DB instance
The following example retrieves details about the log files for the specified DB instance.
$result = $client->describeDBLogFiles([ 'DBInstanceIdentifier' => 'test-instance', ]);
Result syntax:
[ 'DescribeDBLogFiles' => [ [ 'LastWritten' => 1533060000000, 'LogFileName' => 'error/mysql-error-running.log', 'Size' => 0, ], [ 'LastWritten' => 1532994300000, 'LogFileName' => 'error/mysql-error-running.log.0', 'Size' => 2683, ], [ 'LastWritten' => 1533057300000, 'LogFileName' => 'error/mysql-error-running.log.18', 'Size' => 107, ], [ 'LastWritten' => 1532991000000, 'LogFileName' => 'error/mysql-error-running.log.23', 'Size' => 13105, ], [ 'LastWritten' => 1533061200000, 'LogFileName' => 'error/mysql-error.log', 'Size' => 0, ], [ 'LastWritten' => 1532989252000, 'LogFileName' => 'mysqlUpgrade', 'Size' => 3519, ], ], ]
DescribeDBParameterGroups
$result = $client->describeDBParameterGroups
([/* ... */]); $promise = $client->describeDBParameterGroupsAsync
([/* ... */]);
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.
Parameter Syntax
$result = $client->describeDBParameterGroups([ 'DBParameterGroupName' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBParameterGroupName
-
- Type: string
The name of a specific DB parameter group to return details for.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBParameterGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBParameterGroups' => [ [ 'DBParameterGroupArn' => '<string>', 'DBParameterGroupFamily' => '<string>', 'DBParameterGroupName' => '<string>', 'Description' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBParameterGroups
-
- Type: Array of DBParameterGroup structures
A list of
DBParameterGroup
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Examples
Example 1: To describe your DB parameter groups
The following example retrieves details about your DB parameter groups.
$result = $client->describeDBParameterGroups([ ]);
Result syntax:
[ 'DBParameterGroups' => [ [ 'DBParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7', 'DBParameterGroupFamily' => 'aurora-mysql5.7', 'DBParameterGroupName' => 'default.aurora-mysql5.7', 'Description' => 'Default parameter group for aurora-mysql5.7', ], [ 'DBParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6', 'DBParameterGroupFamily' => 'aurora-postgresql9.6', 'DBParameterGroupName' => 'default.aurora-postgresql9.6', 'Description' => 'Default parameter group for aurora-postgresql9.6', ], [ 'DBParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6', 'DBParameterGroupFamily' => 'aurora5.6', 'DBParameterGroupName' => 'default.aurora5.6', 'Description' => 'Default parameter group for aurora5.6', ], [ 'DBParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1', 'DBParameterGroupFamily' => 'mariadb10.1', 'DBParameterGroupName' => 'default.mariadb10.1', 'Description' => 'Default parameter group for mariadb10.1', ], ], // Some output ommitted. ]
DescribeDBParameters
$result = $client->describeDBParameters
([/* ... */]); $promise = $client->describeDBParametersAsync
([/* ... */]);
Returns the detailed parameter list for a particular DB parameter group.
Parameter Syntax
$result = $client->describeDBParameters([ 'DBParameterGroupName' => '<string>', // REQUIRED 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'Source' => '<string>', ]);
Parameter Details
Members
- DBParameterGroupName
-
- Required: Yes
- Type: string
The name of a specific DB parameter group to return details for.
Constraints:
-
If supplied, must match the name of an existing DBParameterGroup.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- Source
-
- Type: string
The parameter types to return.
Default: All parameter types returned
Valid Values:
user | system | engine-default
Result Syntax
[ 'Marker' => '<string>', 'Parameters' => [ [ 'AllowedValues' => '<string>', 'ApplyMethod' => 'immediate|pending-reboot', 'ApplyType' => '<string>', 'DataType' => '<string>', 'Description' => '<string>', 'IsModifiable' => true || false, 'MinimumEngineVersion' => '<string>', 'ParameterName' => '<string>', 'ParameterValue' => '<string>', 'Source' => '<string>', 'SupportedEngineModes' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - Parameters
-
- Type: Array of Parameter structures
A list of
Parameter
values.
Errors
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Examples
Example 1: To describe the parameters in a DB parameter group
The following example retrieves the details of the specified DB parameter group.
$result = $client->describeDBParameters([ 'DBParameterGroupName' => 'mydbpg', ]);
Result syntax:
[ 'Parameters' => [ [ 'AllowedValues' => '0,1', 'ApplyMethod' => 'pending-reboot', 'ApplyType' => 'static', 'DataType' => 'boolean', 'Description' => 'Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded', 'IsModifiable' => , 'ParameterName' => 'allow-suspicious-udfs', 'Source' => 'engine-default', ], [ 'AllowedValues' => '0,1', 'ApplyMethod' => 'pending-reboot', 'ApplyType' => 'static', 'DataType' => 'boolean', 'Description' => 'Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.', 'IsModifiable' => , 'ParameterName' => 'auto_generate_certs', 'Source' => 'engine-default', ], ], // Some output omitted. ]
DescribeDBProxies
$result = $client->describeDBProxies
([/* ... */]); $promise = $client->describeDBProxiesAsync
([/* ... */]);
Returns information about DB proxies.
Parameter Syntax
$result = $client->describeDBProxies([ 'DBProxyName' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBProxyName
-
- Type: string
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
- Filters
-
- Type: Array of Filter structures
This parameter is not currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBProxies' => [ [ 'Auth' => [ [ 'AuthScheme' => 'SECRETS', 'ClientPasswordAuthType' => 'MYSQL_NATIVE_PASSWORD|MYSQL_CACHING_SHA2_PASSWORD|POSTGRES_SCRAM_SHA_256|POSTGRES_MD5|SQL_SERVER_AUTHENTICATION', 'Description' => '<string>', 'IAMAuth' => 'DISABLED|REQUIRED|ENABLED', 'SecretArn' => '<string>', 'UserName' => '<string>', ], // ... ], 'CreatedDate' => <DateTime>, 'DBProxyArn' => '<string>', 'DBProxyName' => '<string>', 'DebugLogging' => true || false, 'Endpoint' => '<string>', 'EngineFamily' => '<string>', 'IdleClientTimeout' => <integer>, 'RequireTLS' => true || false, 'RoleArn' => '<string>', 'Status' => 'available|modifying|incompatible-network|insufficient-resource-limits|creating|deleting|suspended|suspending|reactivating', 'UpdatedDate' => <DateTime>, 'VpcId' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBProxies
-
- Type: Array of DBProxy structures
A return value representing an arbitrary number of
DBProxy
data structures. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
DescribeDBProxyEndpoints
$result = $client->describeDBProxyEndpoints
([/* ... */]); $promise = $client->describeDBProxyEndpointsAsync
([/* ... */]);
Returns information about DB proxy endpoints.
Parameter Syntax
$result = $client->describeDBProxyEndpoints([ 'DBProxyEndpointName' => '<string>', 'DBProxyName' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBProxyEndpointName
-
- Type: string
The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.
- DBProxyName
-
- Type: string
The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.
- Filters
-
- Type: Array of Filter structures
This parameter is not currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBProxyEndpoints' => [ [ 'CreatedDate' => <DateTime>, 'DBProxyEndpointArn' => '<string>', 'DBProxyEndpointName' => '<string>', 'DBProxyName' => '<string>', 'Endpoint' => '<string>', 'IsDefault' => true || false, 'Status' => 'available|modifying|incompatible-network|insufficient-resource-limits|creating|deleting', 'TargetRole' => 'READ_WRITE|READ_ONLY', 'VpcId' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBProxyEndpoints
-
- Type: Array of DBProxyEndpoint structures
The list of
ProxyEndpoint
objects returned by the API operation. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyEndpointNotFoundFault:
The DB proxy endpoint doesn't exist.
DescribeDBProxyTargetGroups
$result = $client->describeDBProxyTargetGroups
([/* ... */]); $promise = $client->describeDBProxyTargetGroupsAsync
([/* ... */]);
Returns information about DB proxy target groups, represented by DBProxyTargetGroup
data structures.
Parameter Syntax
$result = $client->describeDBProxyTargetGroups([ 'DBProxyName' => '<string>', // REQUIRED 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'TargetGroupName' => '<string>', ]);
Parameter Details
Members
- DBProxyName
-
- Required: Yes
- Type: string
The identifier of the
DBProxy
associated with the target group. - Filters
-
- Type: Array of Filter structures
This parameter is not currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- TargetGroupName
-
- Type: string
The identifier of the
DBProxyTargetGroup
to describe.
Result Syntax
[ 'Marker' => '<string>', 'TargetGroups' => [ [ 'ConnectionPoolConfig' => [ 'ConnectionBorrowTimeout' => <integer>, 'InitQuery' => '<string>', 'MaxConnectionsPercent' => <integer>, 'MaxIdleConnectionsPercent' => <integer>, 'SessionPinningFilters' => ['<string>', ...], ], 'CreatedDate' => <DateTime>, 'DBProxyName' => '<string>', 'IsDefault' => true || false, 'Status' => '<string>', 'TargetGroupArn' => '<string>', 'TargetGroupName' => '<string>', 'UpdatedDate' => <DateTime>, ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - TargetGroups
-
- Type: Array of DBProxyTargetGroup structures
An arbitrary number of
DBProxyTargetGroup
objects, containing details of the corresponding target groups.
Errors
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetGroupNotFoundFault:
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
DescribeDBProxyTargets
$result = $client->describeDBProxyTargets
([/* ... */]); $promise = $client->describeDBProxyTargetsAsync
([/* ... */]);
Returns information about DBProxyTarget
objects. This API supports pagination.
Parameter Syntax
$result = $client->describeDBProxyTargets([ 'DBProxyName' => '<string>', // REQUIRED 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'TargetGroupName' => '<string>', ]);
Parameter Details
Members
- DBProxyName
-
- Required: Yes
- Type: string
The identifier of the
DBProxyTarget
to describe. - Filters
-
- Type: Array of Filter structures
This parameter is not currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- TargetGroupName
-
- Type: string
The identifier of the
DBProxyTargetGroup
to describe.
Result Syntax
[ 'Marker' => '<string>', 'Targets' => [ [ 'Endpoint' => '<string>', 'Port' => <integer>, 'RdsResourceId' => '<string>', 'Role' => 'READ_WRITE|READ_ONLY|UNKNOWN', 'TargetArn' => '<string>', 'TargetHealth' => [ 'Description' => '<string>', 'Reason' => 'UNREACHABLE|CONNECTION_FAILED|AUTH_FAILURE|PENDING_PROXY_CAPACITY|INVALID_REPLICATION_STATE', 'State' => 'REGISTERING|AVAILABLE|UNAVAILABLE', ], 'TrackedClusterId' => '<string>', 'Type' => 'RDS_INSTANCE|RDS_SERVERLESS_ENDPOINT|TRACKED_CLUSTER', ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - Targets
-
- Type: Array of DBProxyTarget structures
An arbitrary number of
DBProxyTarget
objects, containing details of the corresponding targets.
Errors
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetNotFoundFault:
The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetGroupNotFoundFault:
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
DescribeDBRecommendations
$result = $client->describeDBRecommendations
([/* ... */]); $promise = $client->describeDBRecommendationsAsync
([/* ... */]);
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
Parameter Syntax
$result = $client->describeDBRecommendations([ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'LastUpdatedAfter' => <integer || string || DateTime>, 'LastUpdatedBefore' => <integer || string || DateTime>, 'Locale' => '<string>', 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more recommendations to describe.
Supported Filters:
-
recommendation-id
- Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values. -
status
- Accepts a list of recommendation statuses.Valid values:
-
active
- The recommendations which are ready for you to apply. -
pending
- The applied or scheduled recommendations which are in progress. -
resolved
- The recommendations which are completed. -
dismissed
- The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
-
-
severity
- Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.Valid values:
-
high
-
medium
-
low
-
informational
-
-
type-id
- Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values. -
dbi-resource-id
- Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases. -
cluster-resource-id
- Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters. -
pg-arn
- Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups. -
cluster-pg-arn
- Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
- LastUpdatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter to include only the recommendations that were updated after this specified time.
- LastUpdatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter to include only the recommendations that were updated before this specified time.
- Locale
-
- Type: string
The language that you choose to return the list of recommendations.
Valid values:
-
en
-
en_UK
-
de
-
es
-
fr
-
id
-
it
-
ja
-
ko
-
pt_BR
-
zh_TW
-
zh_CN
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBRecommendations
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of recommendations to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Result Syntax
[ 'DBRecommendations' => [ [ 'AdditionalInfo' => '<string>', 'Category' => '<string>', 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'Detection' => '<string>', 'Impact' => '<string>', 'IssueDetails' => [ 'PerformanceIssueDetails' => [ 'Analysis' => '<string>', 'EndTime' => <DateTime>, 'Metrics' => [ [ 'MetricQuery' => [ 'PerformanceInsightsMetricQuery' => [ 'GroupBy' => [ 'Dimensions' => ['<string>', ...], 'Group' => '<string>', 'Limit' => <integer>, ], 'Metric' => '<string>', ], ], 'Name' => '<string>', 'References' => [ [ 'Name' => '<string>', 'ReferenceDetails' => [ 'ScalarReferenceDetails' => [ 'Value' => <float>, ], ], ], // ... ], 'StatisticsDetails' => '<string>', ], // ... ], 'StartTime' => <DateTime>, ], ], 'Links' => [ [ 'Text' => '<string>', 'Url' => '<string>', ], // ... ], 'Reason' => '<string>', 'Recommendation' => '<string>', 'RecommendationId' => '<string>', 'RecommendedActions' => [ [ 'ActionId' => '<string>', 'ApplyModes' => ['<string>', ...], 'ContextAttributes' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Description' => '<string>', 'IssueDetails' => [ 'PerformanceIssueDetails' => [ 'Analysis' => '<string>', 'EndTime' => <DateTime>, 'Metrics' => [ [ 'MetricQuery' => [ 'PerformanceInsightsMetricQuery' => [ 'GroupBy' => [ 'Dimensions' => ['<string>', ...], 'Group' => '<string>', 'Limit' => <integer>, ], 'Metric' => '<string>', ], ], 'Name' => '<string>', 'References' => [ [ 'Name' => '<string>', 'ReferenceDetails' => [ 'ScalarReferenceDetails' => [ 'Value' => <float>, ], ], ], // ... ], 'StatisticsDetails' => '<string>', ], // ... ], 'StartTime' => <DateTime>, ], ], 'Operation' => '<string>', 'Parameters' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Status' => '<string>', 'Title' => '<string>', ], // ... ], 'ResourceArn' => '<string>', 'Severity' => '<string>', 'Source' => '<string>', 'Status' => '<string>', 'TypeDetection' => '<string>', 'TypeId' => '<string>', 'TypeRecommendation' => '<string>', 'UpdatedTime' => <DateTime>, ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBRecommendations
-
- Type: Array of DBRecommendation structures
A list of recommendations which is returned from
DescribeDBRecommendations
API request. - Marker
-
- Type: string
An optional pagination token provided by a previous
DBRecommendationsMessage
request. This token can be used later in aDescribeDBRecomendations
request.
Errors
There are no errors described for this operation.
DescribeDBSecurityGroups
$result = $client->describeDBSecurityGroups
([/* ... */]); $promise = $client->describeDBSecurityGroupsAsync
([/* ... */]);
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security group.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->describeDBSecurityGroups([ 'DBSecurityGroupName' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBSecurityGroupName
-
- Type: string
The name of the DB security group to return details for.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBSecurityGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBSecurityGroups' => [ [ 'DBSecurityGroupArn' => '<string>', 'DBSecurityGroupDescription' => '<string>', 'DBSecurityGroupName' => '<string>', 'EC2SecurityGroups' => [ [ 'EC2SecurityGroupId' => '<string>', 'EC2SecurityGroupName' => '<string>', 'EC2SecurityGroupOwnerId' => '<string>', 'Status' => '<string>', ], // ... ], 'IPRanges' => [ [ 'CIDRIP' => '<string>', 'Status' => '<string>', ], // ... ], 'OwnerId' => '<string>', 'VpcId' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBSecurityGroups
-
- Type: Array of DBSecurityGroup structures
A list of
DBSecurityGroup
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.
Examples
Example 1: To list DB security group settings
This example lists settings for the specified security group.
$result = $client->describeDBSecurityGroups([ 'DBSecurityGroupName' => 'mydbsecuritygroup', ]);
Result syntax:
[ ]
DescribeDBShardGroups
$result = $client->describeDBShardGroups
([/* ... */]); $promise = $client->describeDBShardGroupsAsync
([/* ... */]);
Describes existing Aurora Limitless Database DB shard groups.
Parameter Syntax
$result = $client->describeDBShardGroups([ 'DBShardGroupIdentifier' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBShardGroupIdentifier
-
- Type: string
The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match an existing DB shard group identifier.
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more DB shard groups to describe.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBShardGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100
Result Syntax
[ 'DBShardGroups' => [ [ 'ComputeRedundancy' => <integer>, 'DBClusterIdentifier' => '<string>', 'DBShardGroupArn' => '<string>', 'DBShardGroupIdentifier' => '<string>', 'DBShardGroupResourceId' => '<string>', 'Endpoint' => '<string>', 'MaxACU' => <float>, 'MinACU' => <float>, 'PubliclyAccessible' => true || false, 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBShardGroups
-
- Type: Array of DBShardGroup structures
Contains a list of DB shard groups for the user.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeDBClusters
request.
Errors
- DBShardGroupNotFoundFault:
The specified DB shard group name wasn't found.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.
DescribeDBSnapshotAttributes
$result = $client->describeDBSnapshotAttributes
([/* ... */]); $promise = $client->describeDBSnapshotAttributesAsync
([/* ... */]);
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes
returns the restore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all
is included in the list of values for the restore
attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute
API action.
Parameter Syntax
$result = $client->describeDBSnapshotAttributes([ 'DBSnapshotIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier for the DB snapshot to describe the attributes for.
Result Syntax
[ 'DBSnapshotAttributesResult' => [ 'DBSnapshotAttributes' => [ [ 'AttributeName' => '<string>', 'AttributeValues' => ['<string>', ...], ], // ... ], 'DBSnapshotIdentifier' => '<string>', ], ]
Result Details
Members
- DBSnapshotAttributesResult
-
- Type: DBSnapshotAttributesResult structure
Contains the results of a successful call to the
DescribeDBSnapshotAttributes
API action.Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the
ModifyDBSnapshotAttribute
API action.
Errors
- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.
Examples
Example 1: To describe the attribute names and values for a DB snapshot
The following example describes the attribute names and values for a DB snapshot.
$result = $client->describeDBSnapshotAttributes([ 'DBSnapshotIdentifier' => 'mydbsnapshot', ]);
Result syntax:
[ 'DBSnapshotAttributesResult' => [ 'DBSnapshotAttributes' => [ [ 'AttributeName' => 'restore', 'AttributeValues' => [ '123456789012', '210987654321', ], ], ], 'DBSnapshotIdentifier' => 'mydbsnapshot', ], ]
DescribeDBSnapshotTenantDatabases
$result = $client->describeDBSnapshotTenantDatabases
([/* ... */]); $promise = $client->describeDBSnapshotTenantDatabasesAsync
([/* ... */]);
Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.
You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.
Parameter Syntax
$result = $client->describeDBSnapshotTenantDatabases([ 'DBInstanceIdentifier' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'SnapshotType' => '<string>', ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Type: string
The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match the identifier of an existing
DBInstance
.
- DBSnapshotIdentifier
-
- Type: string
The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.
Constraints:
-
If you specify this parameter, the value must match the ID of an existing DB snapshot.
-
If you specify an automatic snapshot, you must also specify
SnapshotType
.
- DbiResourceId
-
- Type: string
A specific DB resource identifier to describe.
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more tenant databases to describe.
Supported filters:
-
tenant-db-name
- Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. -
tenant-database-resource-id
- Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots. -
dbi-resource-id
- DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers. -
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). -
db-snapshot-id
- Accepts DB snapshot identifiers. -
snapshot-type
- Accepts types of DB snapshots.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBSnapshotTenantDatabases
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. - SnapshotType
-
- Type: string
The type of DB snapshots to be returned. You can specify one of the following values:
-
automated
– All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. -
manual
– All DB snapshots that have been taken by my Amazon Web Services account. -
shared
– All manual DB snapshots that have been shared to my Amazon Web Services account. -
public
– All DB snapshots that have been marked as public. -
awsbackup
– All DB snapshots managed by the Amazon Web Services Backup service.
Result Syntax
[ 'DBSnapshotTenantDatabases' => [ [ 'CharacterSetName' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DBSnapshotTenantDatabaseARN' => '<string>', 'DbiResourceId' => '<string>', 'EngineName' => '<string>', 'MasterUsername' => '<string>', 'NcharCharacterSetName' => '<string>', 'SnapshotType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TenantDBName' => '<string>', 'TenantDatabaseCreateTime' => <DateTime>, 'TenantDatabaseResourceId' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBSnapshotTenantDatabases
-
- Type: Array of DBSnapshotTenantDatabase structures
A list of DB snapshot tenant databases.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.
DescribeDBSnapshots
$result = $client->describeDBSnapshots
([/* ... */]); $promise = $client->describeDBSnapshotsAsync
([/* ... */]);
Returns information about DB snapshots. This API action supports pagination.
Parameter Syntax
$result = $client->describeDBSnapshots([ 'DBInstanceIdentifier' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'IncludePublic' => true || false, 'IncludeShared' => true || false, 'Marker' => '<string>', 'MaxRecords' => <integer>, 'SnapshotType' => '<string>', ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Type: string
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match the identifier of an existing DBInstance.
- DBSnapshotIdentifier
-
- Type: string
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
-
If supplied, must match the identifier of an existing DBSnapshot.
-
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
- DbiResourceId
-
- Type: string
A specific DB resource ID to describe.
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more DB snapshots to describe.
Supported filters:
-
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). -
db-snapshot-id
- Accepts DB snapshot identifiers. -
dbi-resource-id
- Accepts identifiers of source DB instances. -
snapshot-type
- Accepts types of DB snapshots. -
engine
- Accepts names of database engines.
- IncludePublic
-
- Type: boolean
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
- IncludeShared
-
- Type: boolean
Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the
ModifyDBSnapshotAttribute
API action.This setting doesn't apply to RDS Custom.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- SnapshotType
-
- Type: string
The type of snapshots to be returned. You can specify one of the following values:
-
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. -
manual
- Return all DB snapshots that have been taken by my Amazon Web Services account. -
shared
- Return all manual DB snapshots that have been shared to my Amazon Web Services account. -
public
- Return all DB snapshots that have been marked as public. -
awsbackup
- Return the DB snapshots managed by the Amazon Web Services Backup service.For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The
awsbackup
type does not apply to Aurora.
If you don't specify a
SnapshotType
value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling theIncludeShared
parameter. You can include public snapshots with these results by enabling theIncludePublic
parameter.The
IncludeShared
andIncludePublic
parameters don't apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn't apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn't apply whenSnapshotType
is set topublic
.
Result Syntax
[ 'DBSnapshots' => [ [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSnapshotArn' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'OriginalSnapshotCreateTime' => <DateTime>, 'PercentProgress' => <integer>, 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'SnapshotCreateTime' => <DateTime>, 'SnapshotDatabaseTime' => <DateTime>, 'SnapshotTarget' => '<string>', 'SnapshotType' => '<string>', 'SourceDBSnapshotIdentifier' => '<string>', 'SourceRegion' => '<string>', 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBSnapshots
-
- Type: Array of DBSnapshot structures
A list of
DBSnapshot
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.
Examples
Example 1: To describe a DB snapshot for a DB instance
The following example retrieves the details of a DB snapshot for a DB instance.
$result = $client->describeDBSnapshots([ 'DBSnapshotIdentifier' => 'mydbsnapshot', ]);
Result syntax:
[ 'DBSnapshots' => [ [ 'AllocatedStorage' => 20, 'AvailabilityZone' => 'us-east-1f', 'DBInstanceIdentifier' => 'mysqldb', 'DBSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot', 'DBSnapshotIdentifier' => 'mydbsnapshot', 'DbiResourceId' => 'db-AKIAIOSFODNN7EXAMPLE', 'Encrypted' => , 'Engine' => 'mysql', 'EngineVersion' => '5.6.37', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'LicenseModel' => 'general-public-license', 'MasterUsername' => 'mysqladmin', 'OptionGroupName' => 'default:mysql-5-6', 'PercentProgress' => 100, 'Port' => 3306, 'ProcessorFeatures' => [ ], 'SnapshotCreateTime' => , 'SnapshotType' => 'manual', 'Status' => 'available', 'StorageType' => 'gp2', 'VpcId' => 'vpc-6594f31c', ], ], ]
DescribeDBSubnetGroups
$result = $client->describeDBSubnetGroups
([/* ... */]); $promise = $client->describeDBSubnetGroupsAsync
([/* ... */]);
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Parameter Syntax
$result = $client->describeDBSubnetGroups([ 'DBSubnetGroupName' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBSubnetGroupName
-
- Type: string
The name of the DB subnet group to return details for.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'DBSubnetGroups' => [ [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- DBSubnetGroups
-
- Type: Array of DBSubnetGroup structures
A list of
DBSubnetGroup
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.
Examples
Example 1: To describe a DB subnet group
The following example retrieves the details of the specified DB subnet group.
$result = $client->describeDBSubnetGroups([ ]);
Result syntax:
[ 'DBSubnetGroups' => [ [ 'DBSubnetGroupArn' => 'arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup', 'DBSubnetGroupDescription' => 'My DB Subnet Group', 'DBSubnetGroupName' => 'mydbsubnetgroup', 'SubnetGroupStatus' => 'Complete', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-east-1a', ], 'SubnetIdentifier' => 'subnet-d8c8e7f4', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-east-1f', ], 'SubnetIdentifier' => 'subnet-718fdc7d', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-east-1a', ], 'SubnetIdentifier' => 'subnet-cbc8e7e7', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-east-1a', ], 'SubnetIdentifier' => 'subnet-0ccde220', 'SubnetStatus' => 'Active', ], ], 'VpcId' => 'vpc-971c12ee', ], ], ]
DescribeEngineDefaultClusterParameters
$result = $client->describeEngineDefaultClusterParameters
([/* ... */]); $promise = $client->describeEngineDefaultClusterParametersAsync
([/* ... */]);
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->describeEngineDefaultClusterParameters([ 'DBParameterGroupFamily' => '<string>', // REQUIRED 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBParameterGroupFamily
-
- Required: Yes
- Type: string
The name of the DB cluster parameter group family to return engine parameter information for.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeEngineDefaultClusterParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'EngineDefaults' => [ 'DBParameterGroupFamily' => '<string>', 'Marker' => '<string>', 'Parameters' => [ [ 'AllowedValues' => '<string>', 'ApplyMethod' => 'immediate|pending-reboot', 'ApplyType' => '<string>', 'DataType' => '<string>', 'Description' => '<string>', 'IsModifiable' => true || false, 'MinimumEngineVersion' => '<string>', 'ParameterName' => '<string>', 'ParameterValue' => '<string>', 'Source' => '<string>', 'SupportedEngineModes' => ['<string>', ...], ], // ... ], ], ]
Result Details
Members
- EngineDefaults
-
- Type: EngineDefaults structure
Contains the result of a successful invocation of the
DescribeEngineDefaultParameters
action.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe the default engine and system parameter information for the Aurora database engine
The following example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility.
$result = $client->describeEngineDefaultClusterParameters([ 'DBParameterGroupFamily' => 'aurora-mysql5.7', ]);
Result syntax:
[ 'EngineDefaults' => [ 'Parameters' => [ [ 'ApplyType' => 'dynamic', 'DataType' => 'string', 'Description' => 'IAM role ARN used to load data from AWS S3', 'IsModifiable' => 1, 'ParameterName' => 'aurora_load_from_s3_role', 'Source' => 'engine-default', 'SupportedEngineModes' => [ 'provisioned', ], ], ], ], // Some output omitted. ]
DescribeEngineDefaultParameters
$result = $client->describeEngineDefaultParameters
([/* ... */]); $promise = $client->describeEngineDefaultParametersAsync
([/* ... */]);
Returns the default engine and system parameter information for the specified database engine.
Parameter Syntax
$result = $client->describeEngineDefaultParameters([ 'DBParameterGroupFamily' => '<string>', // REQUIRED 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- DBParameterGroupFamily
-
- Required: Yes
- Type: string
The name of the DB parameter group family.
Valid Values:
-
aurora-mysql5.7
-
aurora-mysql8.0
-
aurora-postgresql10
-
aurora-postgresql11
-
aurora-postgresql12
-
aurora-postgresql13
-
aurora-postgresql14
-
custom-oracle-ee-19
-
custom-oracle-ee-cdb-19
-
db2-ae
-
db2-se
-
mariadb10.2
-
mariadb10.3
-
mariadb10.4
-
mariadb10.5
-
mariadb10.6
-
mysql5.7
-
mysql8.0
-
oracle-ee-19
-
oracle-ee-cdb-19
-
oracle-ee-cdb-21
-
oracle-se2-19
-
oracle-se2-cdb-19
-
oracle-se2-cdb-21
-
postgres10
-
postgres11
-
postgres12
-
postgres13
-
postgres14
-
sqlserver-ee-11.0
-
sqlserver-ee-12.0
-
sqlserver-ee-13.0
-
sqlserver-ee-14.0
-
sqlserver-ee-15.0
-
sqlserver-ex-11.0
-
sqlserver-ex-12.0
-
sqlserver-ex-13.0
-
sqlserver-ex-14.0
-
sqlserver-ex-15.0
-
sqlserver-se-11.0
-
sqlserver-se-12.0
-
sqlserver-se-13.0
-
sqlserver-se-14.0
-
sqlserver-se-15.0
-
sqlserver-web-11.0
-
sqlserver-web-12.0
-
sqlserver-web-13.0
-
sqlserver-web-14.0
-
sqlserver-web-15.0
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeEngineDefaultParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'EngineDefaults' => [ 'DBParameterGroupFamily' => '<string>', 'Marker' => '<string>', 'Parameters' => [ [ 'AllowedValues' => '<string>', 'ApplyMethod' => 'immediate|pending-reboot', 'ApplyType' => '<string>', 'DataType' => '<string>', 'Description' => '<string>', 'IsModifiable' => true || false, 'MinimumEngineVersion' => '<string>', 'ParameterName' => '<string>', 'ParameterValue' => '<string>', 'Source' => '<string>', 'SupportedEngineModes' => ['<string>', ...], ], // ... ], ], ]
Result Details
Members
- EngineDefaults
-
- Type: EngineDefaults structure
Contains the result of a successful invocation of the
DescribeEngineDefaultParameters
action.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe the default engine and system parameter information for the database engine
The following example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.
$result = $client->describeEngineDefaultParameters([ 'DBParameterGroupFamily' => 'mysql5.7', ]);
Result syntax:
[ 'EngineDefaults' => [ 'Parameters' => [ [ 'AllowedValues' => '0,1', 'ApplyType' => 'static', 'DataType' => 'boolean', 'Description' => 'Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded', 'IsModifiable' => , 'ParameterName' => 'allow-suspicious-udfs', 'Source' => 'engine-default', ], ], ], // Some output omitted. ]
DescribeEventCategories
$result = $client->describeEventCategories
([/* ... */]); $promise = $client->describeEventCategoriesAsync
([/* ... */]);
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
Parameter Syntax
$result = $client->describeEventCategories([ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'SourceType' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- SourceType
-
- Type: string
The type of source that is generating the events. For RDS Proxy events, specify
db-proxy
.Valid Values:
db-instance
|db-cluster
|db-parameter-group
|db-security-group
|db-snapshot
|db-cluster-snapshot
|db-proxy
Result Syntax
[ 'EventCategoriesMapList' => [ [ 'EventCategories' => ['<string>', ...], 'SourceType' => '<string>', ], // ... ], ]
Result Details
Members
- EventCategoriesMapList
-
- Type: Array of EventCategoriesMap structures
A list of
EventCategoriesMap
data types.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe event categories
The following example retrieves details about the event categories for all available event sources.
$result = $client->describeEventCategories([ 'Filters' => [ ], 'SourceType' => '', ]);
Result syntax:
[ 'EventCategoriesMapList' => [ [ 'EventCategories' => [ 'deletion', 'read replica', 'failover', 'restoration', 'maintenance', 'low storage', 'configuration change', 'backup', 'creation', 'availability', 'recovery', 'failure', 'backtrack', 'notification', ], 'SourceType' => 'db-instance', ], [ 'EventCategories' => [ 'configuration change', 'failure', ], 'SourceType' => 'db-security-group', ], [ 'EventCategories' => [ 'configuration change', ], 'SourceType' => 'db-parameter-group', ], [ 'EventCategories' => [ 'deletion', 'creation', 'restoration', 'notification', ], 'SourceType' => 'db-snapshot', ], [ 'EventCategories' => [ 'failover', 'failure', 'notification', ], 'SourceType' => 'db-cluster', ], [ 'EventCategories' => [ 'backup', ], 'SourceType' => 'db-cluster-snapshot', ], ], ]
DescribeEventSubscriptions
$result = $client->describeEventSubscriptions
([/* ... */]); $promise = $client->describeEventSubscriptionsAsync
([/* ... */]);
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName
, SNSTopicARN
, CustomerID
, SourceType
, SourceID
, CreationTime
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
Parameter Syntax
$result = $client->describeEventSubscriptions([ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'SubscriptionName' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- SubscriptionName
-
- Type: string
The name of the RDS event notification subscription you want to describe.
Result Syntax
[ 'EventSubscriptionsList' => [ [ 'CustSubscriptionId' => '<string>', 'CustomerAwsId' => '<string>', 'Enabled' => true || false, 'EventCategoriesList' => ['<string>', ...], 'EventSubscriptionArn' => '<string>', 'SnsTopicArn' => '<string>', 'SourceIdsList' => ['<string>', ...], 'SourceType' => '<string>', 'Status' => '<string>', 'SubscriptionCreationTime' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- EventSubscriptionsList
-
- Type: Array of EventSubscription structures
A list of EventSubscriptions data types.
- Marker
-
- Type: string
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
- SubscriptionNotFoundFault:
The subscription name does not exist.
Examples
Example 1: To describe event subscriptions
This example describes all of the Amazon RDS event subscriptions for the current AWS account.
$result = $client->describeEventSubscriptions([ ]);
Result syntax:
[ 'EventSubscriptionsList' => [ [ 'CustSubscriptionId' => 'my-instance-events', 'CustomerAwsId' => '123456789012', 'Enabled' => 1, 'EventCategoriesList' => [ 'backup', 'recovery', ], 'EventSubscriptionArn' => 'arn:aws:rds:us-east-1:123456789012:es:my-instance-events', 'SnsTopicArn' => 'arn:aws:sns:us-east-1:123456789012:interesting-events', 'SourceType' => 'db-instance', 'Status' => 'creating', 'SubscriptionCreationTime' => '2018-07-31 23:22:01.893', ], ], // Some output omitted. ]
DescribeEvents
$result = $client->describeEvents
([/* ... */]); $promise = $client->describeEventsAsync
([/* ... */]);
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
Parameter Syntax
$result = $client->describeEvents([ 'Duration' => <integer>, 'EndTime' => <integer || string || DateTime>, 'EventCategories' => ['<string>', ...], 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'SourceIdentifier' => '<string>', 'SourceType' => 'db-instance|db-parameter-group|db-security-group|db-snapshot|db-cluster|db-cluster-snapshot|custom-engine-version|db-proxy|blue-green-deployment', 'StartTime' => <integer || string || DateTime>, ]);
Parameter Details
Members
- Duration
-
- Type: int
The number of minutes to retrieve events for.
Default: 60
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
- EventCategories
-
- Type: Array of strings
A list of event categories that trigger notifications for a event notification subscription.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- SourceIdentifier
-
- Type: string
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
-
If
SourceIdentifier
is supplied,SourceType
must also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied. -
Can't end with a hyphen or contain two consecutive hyphens.
- SourceType
-
- Type: string
The event source to retrieve events for. If no value is specified, all events are returned.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Result Syntax
[ 'Events' => [ [ 'Date' => <DateTime>, 'EventCategories' => ['<string>', ...], 'Message' => '<string>', 'SourceArn' => '<string>', 'SourceIdentifier' => '<string>', 'SourceType' => 'db-instance|db-parameter-group|db-security-group|db-snapshot|db-cluster|db-cluster-snapshot|custom-engine-version|db-proxy|blue-green-deployment', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- Events
-
- Type: Array of Event structures
A list of
Event
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe events
The following retrieves details for the events that have occurred for the specified DB instance.
$result = $client->describeEvents([ 'SourceIdentifier' => 'test-instance', 'SourceType' => 'db-instance', ]);
Result syntax:
[ 'Events' => [ [ 'Date' =>, 'EventCategories' => [ 'backup', ], 'Message' => 'Backing up DB instance', 'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:db:test-instance', 'SourceIdentifier' => 'test-instance', 'SourceType' => 'db-instance', ], [ 'Date' => , 'EventCategories' => [ 'backup', ], 'Message' => 'Finished DB Instance backup', 'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:db:test-instance', 'SourceIdentifier' => 'test-instance', 'SourceType' => 'db-instance', ], ], ]
DescribeExportTasks
$result = $client->describeExportTasks
([/* ... */]); $promise = $client->describeExportTasksAsync
([/* ... */]);
Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
Parameter Syntax
$result = $client->describeExportTasks([ 'ExportTaskIdentifier' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'SourceArn' => '<string>', 'SourceType' => 'SNAPSHOT|CLUSTER', ]);
Parameter Details
Members
- ExportTaskIdentifier
-
- Type: string
The identifier of the snapshot or cluster export task to be described.
- Filters
-
- Type: Array of Filter structures
Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.
Supported filters include the following:
-
export-task-identifier
- An identifier for the snapshot or cluster export task. -
s3-bucket
- The Amazon S3 bucket the data is exported to. -
source-arn
- The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. -
status
- The status of the export task. Must be lowercase. Valid statuses are the following:-
canceled
-
canceling
-
complete
-
failed
-
in_progress
-
starting
-
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeExportTasks
request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by theMaxRecords
parameter. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later
DescribeExportTasks
request to retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
- SourceType
-
- Type: string
The type of source for the export.
Result Syntax
[ 'ExportTasks' => [ [ 'ExportOnly' => ['<string>', ...], 'ExportTaskIdentifier' => '<string>', 'FailureCause' => '<string>', 'IamRoleArn' => '<string>', 'KmsKeyId' => '<string>', 'PercentProgress' => <integer>, 'S3Bucket' => '<string>', 'S3Prefix' => '<string>', 'SnapshotTime' => <DateTime>, 'SourceArn' => '<string>', 'SourceType' => 'SNAPSHOT|CLUSTER', 'Status' => '<string>', 'TaskEndTime' => <DateTime>, 'TaskStartTime' => <DateTime>, 'TotalExtractedDataInGB' => <integer>, 'WarningMessage' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- ExportTasks
-
- Type: Array of ExportTask structures
Information about an export of a snapshot or cluster to Amazon S3.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeExportTasks
request. A marker is used for pagination to identify the location to begin output for the next response ofDescribeExportTasks
.
Errors
- ExportTaskNotFoundFault:
The export task doesn't exist.
Examples
Example 1: To describe snapshot export tasks
The following example returns information about snapshot exports to Amazon S3.
$result = $client->describeExportTasks([ ]);
Result syntax:
[ 'ExportTasks' => [ [ 'ExportTaskIdentifier' => 'test-snapshot-export', 'IamRoleArn' => 'arn:aws:iam::123456789012:role/service-role/ExportRole', 'KmsKeyId' => 'arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff', 'PercentProgress' => 100, 'S3Bucket' => 'mybucket', 'S3Prefix' => '', 'SnapshotTime' =>, 'SourceArn' => 'arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot', 'Status' => 'COMPLETE', 'TaskEndTime' => , 'TaskStartTime' => , 'TotalExtractedDataInGB' => 0, ], [ 'ExportTaskIdentifier' => 'my-s3-export', 'IamRoleArn' => 'arn:aws:iam::123456789012:role/service-role/ExportRole', 'KmsKeyId' => 'arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff', 'PercentProgress' => 0, 'S3Bucket' => 'mybucket', 'S3Prefix' => '', 'SnapshotTime' => , 'SourceArn' => 'arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test', 'Status' => 'STARTING', 'TotalExtractedDataInGB' => 0, ], ], ]
DescribeGlobalClusters
$result = $client->describeGlobalClusters
([/* ... */]); $promise = $client->describeGlobalClustersAsync
([/* ... */]);
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Parameter Syntax
$result = $client->describeGlobalClusters([ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'GlobalClusterIdentifier' => '<string>', 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.
Currently, the only supported filter is
region
.If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.
- GlobalClusterIdentifier
-
- Type: string
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match an existing DBClusterIdentifier.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeGlobalClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'GlobalClusters' => [ [ 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'FailoverState' => [ 'FromDbClusterArn' => '<string>', 'IsDataLossAllowed' => true || false, 'Status' => 'pending|failing-over|cancelling', 'ToDbClusterArn' => '<string>', ], 'GlobalClusterArn' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'GlobalClusterMembers' => [ [ 'DBClusterArn' => '<string>', 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'IsWriter' => true || false, 'Readers' => ['<string>', ...], 'SynchronizationStatus' => 'connected|pending-resync', ], // ... ], 'GlobalClusterResourceId' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- GlobalClusters
-
- Type: Array of GlobalCluster structures
The list of global clusters returned by this request.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeGlobalClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
Errors
- GlobalClusterNotFoundFault:
The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
Examples
Example 1: To describe global DB clusters
The following example lists Aurora global DB clusters in the current AWS Region.
$result = $client->describeGlobalClusters([ ]);
Result syntax:
[ 'GlobalClusters' => [ [ 'DeletionProtection' => , 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.07.2', 'GlobalClusterArn' => 'arn:aws:rds::123456789012:global-cluster:myglobalcluster', 'GlobalClusterIdentifier' => 'myglobalcluster', 'GlobalClusterMembers' => [ ], 'GlobalClusterResourceId' => 'cluster-f5982077e3b5aabb', 'Status' => 'available', 'StorageEncrypted' => , ], ], ]
DescribeIntegrations
$result = $client->describeIntegrations
([/* ... */]); $promise = $client->describeIntegrationsAsync
([/* ... */]);
Describe one or more zero-ETL integrations with Amazon Redshift.
Parameter Syntax
$result = $client->describeIntegrations([ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'IntegrationIdentifier' => '<string>', 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more resources to return.
- IntegrationIdentifier
-
- Type: string
The unique identifier of the integration.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeIntegrations
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'Integrations' => [ [ 'AdditionalEncryptionContext' => ['<string>', ...], 'CreateTime' => <DateTime>, 'DataFilter' => '<string>', 'Description' => '<string>', 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', ], // ... ], 'IntegrationArn' => '<string>', 'IntegrationName' => '<string>', 'KMSKeyId' => '<string>', 'SourceArn' => '<string>', 'Status' => 'creating|active|modifying|failed|deleting|syncing|needs_attention', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetArn' => '<string>', ], // ... ], 'Marker' => '<string>', ]
Result Details
Members
- Integrations
-
- Type: Array of Integration structures
A list of integrations.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeIntegrations
request.
Errors
- IntegrationNotFoundFault:
The specified integration could not be found.
Examples
Example 1: To describe a zero-ETL integration
The following example retrieves information about a zero-ETL integration with Amazon Redshift.
$result = $client->describeIntegrations([ 'IntegrationIdentifier' => '5b9f3d79-7392-4a3e-896c-58eaa1b53231', ]);
Result syntax:
[ 'Integrations' => [ [ 'CreateTime' =>, 'IntegrationArn' => 'arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231', 'IntegrationName' => 'my-integration', 'KMSKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa', 'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-cluster', 'Status' => 'active', 'Tags' => [ ], 'TargetArn' => 'arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8', ], ], ]
DescribeOptionGroupOptions
$result = $client->describeOptionGroupOptions
([/* ... */]); $promise = $client->describeOptionGroupOptionsAsync
([/* ... */]);
Describes all available options for the specified engine.
Parameter Syntax
$result = $client->describeOptionGroupOptions([ 'EngineName' => '<string>', // REQUIRED 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'MajorEngineVersion' => '<string>', 'Marker' => '<string>', 'MaxRecords' => <integer>, ]);
Parameter Details
Members
- EngineName
-
- Required: Yes
- Type: string
The name of the engine to describe options for.
Valid Values:
-
db2-ae
-
db2-se
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- MajorEngineVersion
-
- Type: string
If specified, filters the results to include only options for the specified major engine version.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Result Syntax
[ 'Marker' => '<string>', 'OptionGroupOptions' => [ [ 'CopyableCrossAccount' => true || false, 'DefaultPort' => <integer>, 'Description' => '<string>', 'EngineName' => '<string>', 'MajorEngineVersion' => '<string>', 'MinimumRequiredMinorEngineVersion' => '<string>', 'Name' => '<string>', 'OptionGroupOptionSettings' => [ [ 'AllowedValues' => '<string>', 'ApplyType' => '<string>', 'DefaultValue' => '<string>', 'IsModifiable' => true || false, 'IsRequired' => true || false, 'MinimumEngineVersionPerAllowedValue' => [ [ 'AllowedValue' => '<string>', 'MinimumEngineVersion' => '<string>', ], // ... ], 'SettingDescription' => '<string>', 'SettingName' => '<string>', ], // ... ], 'OptionGroupOptionVersions' => [ [ 'IsDefault' => true || false, 'Version' => '<string>', ], // ... ], 'OptionsConflictsWith' => ['<string>', ...], 'OptionsDependedOn' => ['<string>', ...], 'Permanent' => true || false, 'Persistent' => true || false, 'PortRequired' => true || false, 'RequiresAutoMinorEngineVersionUpgrade' => true || false, 'SupportsOptionVersionDowngrade' => true || false, 'VpcOnly' => true || false, ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - OptionGroupOptions
-
- Type: Array of OptionGroupOption structures
List of available option group options.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe all available options
The following example lists the options for an RDS for MySQL version 8.0 DB instance.
$result = $client->describeOptionGroupOptions([ 'EngineName' => 'mysql', 'MajorEngineVersion' => '8.0', ]);
Result syntax:
[ 'OptionGroupOptions' => [ [ 'Description' => 'MariaDB Audit Plugin', 'EngineName' => 'mysql', 'MajorEngineVersion' => '8.0', 'MinimumRequiredMinorEngineVersion' => '25', 'Name' => 'MARIADB_AUDIT_PLUGIN', 'OptionGroupOptionSettings' => [ [ 'ApplyType' => 'DYNAMIC', 'IsModifiable' => 1, 'IsRequired' => , 'MinimumEngineVersionPerAllowedValue' => [ ], 'SettingDescription' => 'Include specified users', 'SettingName' => 'SERVER_AUDIT_INCL_USERS', ], [ 'ApplyType' => 'DYNAMIC', 'IsModifiable' => 1, 'IsRequired' => , 'MinimumEngineVersionPerAllowedValue' => [ ], 'SettingDescription' => 'Exclude specified users', 'SettingName' => 'SERVER_AUDIT_EXCL_USERS', ], ], 'OptionsConflictsWith' => [ ], 'OptionsDependedOn' => [ ], 'Permanent' => , 'Persistent' => , 'PortRequired' => , 'RequiresAutoMinorEngineVersionUpgrade' => , 'VpcOnly' => , ], ], // Some output omitted. ]
DescribeOptionGroups
$result = $client->describeOptionGroups
([/* ... */]); $promise = $client->describeOptionGroupsAsync
([/* ... */]);
Describes the available option groups.
Parameter Syntax
$result = $client->describeOptionGroups([ 'EngineName' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'MajorEngineVersion' => '<string>', 'Marker' => '<string>', 'MaxRecords' => <integer>, 'OptionGroupName' => '<string>', ]);
Parameter Details
Members
- EngineName
-
- Type: string
A filter to only include option groups associated with this database engine.
Valid Values:
-
db2-ae
-
db2-se
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- MajorEngineVersion
-
- Type: string
Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
- Marker
-
- Type: string
An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- OptionGroupName
-
- Type: string
The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
Result Syntax
[ 'Marker' => '<string>', 'OptionGroupsList' => [ [ 'AllowsVpcAndNonVpcInstanceMemberships' => true || false, 'CopyTimestamp' => <DateTime>, 'EngineName' => '<string>', 'MajorEngineVersion' => '<string>', 'OptionGroupArn' => '<string>', 'OptionGroupDescription' => '<string>', 'OptionGroupName' => '<string>', 'Options' => [ [ 'DBSecurityGroupMemberships' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'OptionDescription' => '<string>', 'OptionName' => '<string>', 'OptionSettings' => [ [ 'AllowedValues' => '<string>', 'ApplyType' => '<string>', 'DataType' => '<string>', 'DefaultValue' => '<string>', 'Description' => '<string>', 'IsCollection' => true || false, 'IsModifiable' => true || false, 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'OptionVersion' => '<string>', 'Permanent' => true || false, 'Persistent' => true || false, 'Port' => <integer>, 'VpcSecurityGroupMemberships' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], // ... ], 'SourceAccountId' => '<string>', 'SourceOptionGroup' => '<string>', 'VpcId' => '<string>', ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - OptionGroupsList
-
- Type: Array of OptionGroup structures
List of option groups.
Errors
- OptionGroupNotFoundFault:
The specified option group could not be found.
Examples
Example 1: To describe the available option groups
The following example lists the options groups for an Oracle Database 19c instance.
$result = $client->describeOptionGroups([ 'EngineName' => 'oracle-ee', 'MajorEngineVersion' => '19', ]);
Result syntax:
[ 'OptionGroupsList' => [ [ 'AllowsVpcAndNonVpcInstanceMemberships' => 1, 'EngineName' => 'oracle-ee', 'MajorEngineVersion' => '19', 'OptionGroupArn' => 'arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19', 'OptionGroupDescription' => 'Default option group for oracle-ee 19', 'OptionGroupName' => 'default:oracle-ee-19', 'Options' => [ ], ], ], ]
DescribeOrderableDBInstanceOptions
$result = $client->describeOrderableDBInstanceOptions
([/* ... */]); $promise = $client->describeOrderableDBInstanceOptionsAsync
([/* ... */]);
Describes the orderable DB instance options for a specified DB engine.
Parameter Syntax
$result = $client->describeOrderableDBInstanceOptions([ 'AvailabilityZoneGroup' => '<string>', 'DBInstanceClass' => '<string>', 'Engine' => '<string>', // REQUIRED 'EngineVersion' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'LicenseModel' => '<string>', 'Marker' => '<string>', 'MaxRecords' => <integer>, 'Vpc' => true || false, ]);
Parameter Details
Members
- AvailabilityZoneGroup
-
- Type: string
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.
Omit this parameter to show the available options in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
- DBInstanceClass
-
- Type: string
A filter to include only the available options for the specified DB instance class.
- Engine
-
- Required: Yes
- Type: string
The name of the database engine to describe DB instance options for.
Valid Values:
-
aurora-mysql
-
aurora-postgresql
-
custom-oracle-ee
-
custom-oracle-ee-cdb
-
custom-oracle-se2
-
custom-oracle-se2-cdb
-
db2-ae
-
db2-se
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
- EngineVersion
-
- Type: string
A filter to include only the available options for the specified engine version.
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- LicenseModel
-
- Type: string
A filter to include only the available options for the specified license model.
RDS Custom supports only the BYOL licensing model.
- Marker
-
- Type: string
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 1000.
- Vpc
-
- Type: boolean
Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
Result Syntax
[ 'Marker' => '<string>', 'OrderableDBInstanceOptions' => [ [ 'AvailabilityZoneGroup' => '<string>', 'AvailabilityZones' => [ [ 'Name' => '<string>', ], // ... ], 'AvailableProcessorFeatures' => [ [ 'AllowedValues' => '<string>', 'DefaultValue' => '<string>', 'Name' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'Engine' => '<string>', 'EngineVersion' => '<string>', 'LicenseModel' => '<string>', 'MaxIopsPerDbInstance' => <integer>, 'MaxIopsPerGib' => <float>, 'MaxStorageSize' => <integer>, 'MaxStorageThroughputPerDbInstance' => <integer>, 'MaxStorageThroughputPerIops' => <float>, 'MinIopsPerDbInstance' => <integer>, 'MinIopsPerGib' => <float>, 'MinStorageSize' => <integer>, 'MinStorageThroughputPerDbInstance' => <integer>, 'MinStorageThroughputPerIops' => <float>, 'MultiAZCapable' => true || false, 'OutpostCapable' => true || false, 'ReadReplicaCapable' => true || false, 'StorageType' => '<string>', 'SupportedActivityStreamModes' => ['<string>', ...], 'SupportedEngineModes' => ['<string>', ...], 'SupportedNetworkTypes' => ['<string>', ...], 'SupportsClusters' => true || false, 'SupportsDedicatedLogVolume' => true || false, 'SupportsEnhancedMonitoring' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIAMDatabaseAuthentication' => true || false, 'SupportsIops' => true || false, 'SupportsKerberosAuthentication' => true || false, 'SupportsPerformanceInsights' => true || false, 'SupportsStorageAutoscaling' => true || false, 'SupportsStorageEncryption' => true || false, 'SupportsStorageThroughput' => true || false, 'Vpc' => true || false, ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - OrderableDBInstanceOptions
-
- Type: Array of OrderableDBInstanceOption structures
An
OrderableDBInstanceOption
structure containing information about orderable options for the DB instance.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe orderable DB instance options
The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.
$result = $client->describeOrderableDBInstanceOptions([ 'Engine' => 'mysql', ]);
Result syntax:
[ 'OrderableDBInstanceOptions' => [ [ 'AvailabilityZones' => [ [ 'Name' => 'us-east-1a', ], [ 'Name' => 'us-east-1b', ], [ 'Name' => 'us-east-1c', ], [ 'Name' => 'us-east-1d', ], [ 'Name' => 'us-east-1e', ], [ 'Name' => 'us-east-1f', ], ], 'DBInstanceClass' => 'db.m4.10xlarge', 'Engine' => 'mysql', 'EngineVersion' => '5.7.33', 'LicenseModel' => 'general-public-license', 'MultiAZCapable' => 1, 'ReadReplicaCapable' => 1, 'StorageType' => 'gp2', 'SupportsStorageEncryption' => 1, 'Vpc' => 1, ], ], // Some output omitted. ]
DescribePendingMaintenanceActions
$result = $client->describePendingMaintenanceActions
([/* ... */]); $promise = $client->describePendingMaintenanceActionsAsync
([/* ... */]);
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This API follows an eventual consistency model. This means that the result of the DescribePendingMaintenanceActions
command might not be immediately visible to all subsequent RDS commands. Keep this in mind when you use DescribePendingMaintenanceActions
immediately after using a previous API command such as ApplyPendingMaintenanceActions
.
Parameter Syntax
$result = $client->describePendingMaintenanceActions([ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'ResourceIdentifier' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs. -
db-instance-id
- Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribePendingMaintenanceActions
request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- ResourceIdentifier
-
- Type: string
The ARN of a resource to return pending maintenance actions for.
Result Syntax
[ 'Marker' => '<string>', 'PendingMaintenanceActions' => [ [ 'PendingMaintenanceActionDetails' => [ [ 'Action' => '<string>', 'AutoAppliedAfterDate' => <DateTime>, 'CurrentApplyDate' => <DateTime>, 'Description' => '<string>', 'ForcedApplyDate' => <DateTime>, 'OptInStatus' => '<string>', ], // ... ], 'ResourceIdentifier' => '<string>', ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribePendingMaintenanceActions
request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified byMaxRecords
. - PendingMaintenanceActions
-
- Type: Array of ResourcePendingMaintenanceActions structures
A list of the pending maintenance actions for the resource.
Errors
- ResourceNotFoundFault:
The specified resource ID was not found.
Examples
Example 1: To list resources with at least one pending maintenance action
The following example lists the pending maintenace action for a DB instance.
$result = $client->describePendingMaintenanceActions([ ]);
Result syntax:
[ 'PendingMaintenanceActions' => [ [ 'PendingMaintenanceActionDetails' => [ [ 'Action' => 'system-update', 'Description' => 'Upgrade to Aurora PostgreSQL 2.4.2', ], ], 'ResourceIdentifier' => 'arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1', ], ], ]
DescribeReservedDBInstances
$result = $client->describeReservedDBInstances
([/* ... */]); $promise = $client->describeReservedDBInstancesAsync
([/* ... */]);
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
Parameter Syntax
$result = $client->describeReservedDBInstances([ 'DBInstanceClass' => '<string>', 'Duration' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'LeaseId' => '<string>', 'Marker' => '<string>', 'MaxRecords' => <integer>, 'MultiAZ' => true || false, 'OfferingType' => '<string>', 'ProductDescription' => '<string>', 'ReservedDBInstanceId' => '<string>', 'ReservedDBInstancesOfferingId' => '<string>', ]);
Parameter Details
Members
- DBInstanceClass
-
- Type: string
The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
- Duration
-
- Type: string
The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values:
1 | 3 | 31536000 | 94608000
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- LeaseId
-
- Type: string
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more than the
MaxRecords
value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- MultiAZ
-
- Type: boolean
Specifies whether to show only those reservations that support Multi-AZ.
- OfferingType
-
- Type: string
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values:
"Partial Upfront" | "All Upfront" | "No Upfront"
- ProductDescription
-
- Type: string
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
- ReservedDBInstanceId
-
- Type: string
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
- ReservedDBInstancesOfferingId
-
- Type: string
The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
Result Syntax
[ 'Marker' => '<string>', 'ReservedDBInstances' => [ [ 'CurrencyCode' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceCount' => <integer>, 'Duration' => <integer>, 'FixedPrice' => <float>, 'LeaseId' => '<string>', 'MultiAZ' => true || false, 'OfferingType' => '<string>', 'ProductDescription' => '<string>', 'RecurringCharges' => [ [ 'RecurringChargeAmount' => <float>, 'RecurringChargeFrequency' => '<string>', ], // ... ], 'ReservedDBInstanceArn' => '<string>', 'ReservedDBInstanceId' => '<string>', 'ReservedDBInstancesOfferingId' => '<string>', 'StartTime' => <DateTime>, 'State' => '<string>', 'UsagePrice' => <float>, ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - ReservedDBInstances
-
- Type: Array of ReservedDBInstance structures
A list of reserved DB instances.
Errors
- ReservedDBInstanceNotFoundFault:
The specified reserved DB Instance not found.
Examples
Example 1: To describe reserved DB instances
The following example retrieves details about any reserved DB instances in the current AWS account.
$result = $client->describeReservedDBInstances([ ]);
Result syntax:
[ 'ReservedDBInstances' => [ [ 'CurrencyCode' => 'USD', 'DBInstanceClass' => 'db.t3.micro', 'DBInstanceCount' => 1, 'Duration' => 31536000, 'FixedPrice' => 0, 'LeaseId' => 'a1b2c3d4-6b69-4a59-be89-5e11aa446666', 'MultiAZ' => , 'OfferingType' => 'No Upfront', 'ProductDescription' => 'sqlserver-ex(li)', 'RecurringCharges' => [ [ 'RecurringChargeAmount' => 0.014, 'RecurringChargeFrequency' => 'Hourly', ], ], 'ReservedDBInstanceArn' => 'arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance', 'ReservedDBInstanceId' => 'myreservedinstance', 'ReservedDBInstancesOfferingId' => '12ab34cd-59af-4b2c-a660-1abcdef23456', 'StartTime' =>, 'State' => 'payment-pending', 'UsagePrice' => 0, ], ], ]
DescribeReservedDBInstancesOfferings
$result = $client->describeReservedDBInstancesOfferings
([/* ... */]); $promise = $client->describeReservedDBInstancesOfferingsAsync
([/* ... */]);
Lists available reserved DB instance offerings.
Parameter Syntax
$result = $client->describeReservedDBInstancesOfferings([ 'DBInstanceClass' => '<string>', 'Duration' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'MultiAZ' => true || false, 'OfferingType' => '<string>', 'ProductDescription' => '<string>', 'ReservedDBInstancesOfferingId' => '<string>', ]);
Parameter Details
Members
- DBInstanceClass
-
- Type: string
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
- Duration
-
- Type: string
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values:
1 | 3 | 31536000 | 94608000
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more than the
MaxRecords
value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- MultiAZ
-
- Type: boolean
Specifies whether to show only those reservations that support Multi-AZ.
- OfferingType
-
- Type: string
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values:
"Partial Upfront" | "All Upfront" | "No Upfront"
- ProductDescription
-
- Type: string
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
- ReservedDBInstancesOfferingId
-
- Type: string
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
Result Syntax
[ 'Marker' => '<string>', 'ReservedDBInstancesOfferings' => [ [ 'CurrencyCode' => '<string>', 'DBInstanceClass' => '<string>', 'Duration' => <integer>, 'FixedPrice' => <float>, 'MultiAZ' => true || false, 'OfferingType' => '<string>', 'ProductDescription' => '<string>', 'RecurringCharges' => [ [ 'RecurringChargeAmount' => <float>, 'RecurringChargeFrequency' => '<string>', ], // ... ], 'ReservedDBInstancesOfferingId' => '<string>', 'UsagePrice' => <float>, ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - ReservedDBInstancesOfferings
-
- Type: Array of ReservedDBInstancesOffering structures
A list of reserved DB instance offerings.
Errors
- ReservedDBInstancesOfferingNotFoundFault:
Specified offering does not exist.
Examples
Example 1: To describe reserved DB instance offerings
The following example retrieves details about reserved DB instance options for RDS for Oracle.
$result = $client->describeReservedDBInstancesOfferings([ 'ProductDescription' => 'oracle', ]);
Result syntax:
[ 'ReservedDBInstancesOfferings' => [ [ 'CurrencyCode' => 'USD', 'DBInstanceClass' => 'db.m4.xlarge', 'Duration' => 31536000, 'FixedPrice' => 4089, 'MultiAZ' => 1, 'OfferingType' => 'Partial Upfront', 'ProductDescription' => 'oracle-se2(li)', 'RecurringCharges' => [ [ 'RecurringChargeAmount' => 0.594, 'RecurringChargeFrequency' => 'Hourly', ], ], 'ReservedDBInstancesOfferingId' => '005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8', 'UsagePrice' => 0, ], ], // Some output omitted. ]
DescribeSourceRegions
$result = $client->describeSourceRegions
([/* ... */]); $promise = $client->describeSourceRegionsAsync
([/* ... */]);
Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions
. For more information, see DescribeRegions in the Amazon EC2 API Reference.
Parameter Syntax
$result = $client->describeSourceRegions([ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'RegionName' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeSourceRegions
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
- RegionName
-
- Type: string
The source Amazon Web Services Region name. For example,
us-east-1
.Constraints:
-
Must specify a valid Amazon Web Services Region name.
Result Syntax
[ 'Marker' => '<string>', 'SourceRegions' => ['<string>', ...], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - SourceRegions
-
- Type: Array of strings
A list of
SourceRegion
instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
Errors
There are no errors described for this operation.
Examples
Example 1: To describe source Regions
The following example retrieves details about all source AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. It also shows that automated backups can be replicated only from US West (Oregon) to the destination AWS Region, US East (N. Virginia).
$result = $client->describeSourceRegions([ 'RegionName' => 'us-east-1', ]);
Result syntax:
[ 'SourceRegions' => [ 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', 'Array', ], ]
DescribeTenantDatabases
$result = $client->describeTenantDatabases
([/* ... */]); $promise = $client->describeTenantDatabasesAsync
([/* ... */]);
Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.
Parameter Syntax
$result = $client->describeTenantDatabases([ 'DBInstanceIdentifier' => '<string>', 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'Marker' => '<string>', 'MaxRecords' => <integer>, 'TenantDBName' => '<string>', ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Type: string
The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive.
- Filters
-
- Type: Array of Filter structures
A filter that specifies one or more database tenants to describe.
Supported filters:
-
tenant-db-name
- Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. -
tenant-database-resource-id
- Tenant database resource identifiers. -
dbi-resource-id
- DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeTenantDatabases
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - MaxRecords
-
- Type: int
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. - TenantDBName
-
- Type: string
The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.
Result Syntax
[ 'Marker' => '<string>', 'TenantDatabases' => [ [ 'CharacterSetName' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'DeletionProtection' => true || false, 'MasterUsername' => '<string>', 'NcharCharacterSetName' => '<string>', 'PendingModifiedValues' => [ 'MasterUserPassword' => '<string>', 'TenantDBName' => '<string>', ], 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TenantDBName' => '<string>', 'TenantDatabaseARN' => '<string>', 'TenantDatabaseCreateTime' => <DateTime>, 'TenantDatabaseResourceId' => '<string>', ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeTenantDatabases
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - TenantDatabases
-
- Type: Array of TenantDatabase structures
An array of the tenant databases requested by the
DescribeTenantDatabases
operation.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.
DescribeValidDBInstanceModifications
$result = $client->describeValidDBInstanceModifications
([/* ... */]); $promise = $client->describeValidDBInstanceModificationsAsync
([/* ... */]);
You can call DescribeValidDBInstanceModifications
to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance
.
This command doesn't apply to RDS Custom.
Parameter Syntax
$result = $client->describeValidDBInstanceModifications([ 'DBInstanceIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The customer identifier or the ARN of your DB instance.
Result Syntax
[ 'ValidDBInstanceModificationsMessage' => [ 'Storage' => [ [ 'IopsToStorageRatio' => [ [ 'From' => <float>, 'To' => <float>, ], // ... ], 'ProvisionedIops' => [ [ 'From' => <integer>, 'Step' => <integer>, 'To' => <integer>, ], // ... ], 'ProvisionedStorageThroughput' => [ [ 'From' => <integer>, 'Step' => <integer>, 'To' => <integer>, ], // ... ], 'StorageSize' => [ [ 'From' => <integer>, 'Step' => <integer>, 'To' => <integer>, ], // ... ], 'StorageThroughputToIopsRatio' => [ [ 'From' => <float>, 'To' => <float>, ], // ... ], 'StorageType' => '<string>', 'SupportsStorageAutoscaling' => true || false, ], // ... ], 'SupportsDedicatedLogVolume' => true || false, 'ValidProcessorFeatures' => [ [ 'AllowedValues' => '<string>', 'DefaultValue' => '<string>', 'Name' => '<string>', ], // ... ], ], ]
Result Details
Members
- ValidDBInstanceModificationsMessage
-
- Type: ValidDBInstanceModificationsMessage structure
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the
DescribeValidDBInstanceModifications
action. You can use this information when you callModifyDBInstance
.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To describe valid modifications for a DB instance
The following example retrieves details about the valid modifications for the specified DB instance.
$result = $client->describeValidDBInstanceModifications([ 'DBInstanceIdentifier' => 'database-test1', ]);
Result syntax:
[ 'ValidDBInstanceModificationsMessage' => [ 'Storage' => [ [ 'StorageSize' => [ [ 'From' => 20, 'Step' => 1, 'To' => 20, ], [ 'From' => 22, 'Step' => 1, 'To' => 6144, ], ], 'StorageType' => 'gp2', ], ], ], // Some output omitted. ]
DisableHttpEndpoint
$result = $client->disableHttpEndpoint
([/* ... */]); $promise = $client->disableHttpEndpointAsync
([/* ... */]);
Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint
parameter of the ModifyDBCluster
operation.
Parameter Syntax
$result = $client->disableHttpEndpoint([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB cluster.
Result Syntax
[ 'HttpEndpointEnabled' => true || false, 'ResourceArn' => '<string>', ]
Result Details
Members
- HttpEndpointEnabled
-
- Type: boolean
Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
- ResourceArn
-
- Type: string
The ARN of the DB cluster.
Errors
- ResourceNotFoundFault:
The specified resource ID was not found.
- InvalidResourceStateFault:
The operation can't be performed because another operation is in progress.
DownloadDBLogFilePortion
$result = $client->downloadDBLogFilePortion
([/* ... */]); $promise = $client->downloadDBLogFilePortionAsync
([/* ... */]);
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
Parameter Syntax
$result = $client->downloadDBLogFilePortion([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'LogFileName' => '<string>', // REQUIRED 'Marker' => '<string>', 'NumberOfLines' => <integer>, ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
-
Must match the identifier of an existing DBInstance.
- LogFileName
-
- Required: Yes
- Type: string
The name of the log file to be downloaded.
- Marker
-
- Type: string
The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
- NumberOfLines
-
- Type: int
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
-
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
-
If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.
-
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
-
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Result Syntax
[ 'AdditionalDataPending' => true || false, 'LogFileData' => '<string>', 'Marker' => '<string>', ]
Result Details
Members
- AdditionalDataPending
-
- Type: boolean
A Boolean value that, if true, indicates there is more data to be downloaded.
- LogFileData
-
- Type: string
Entries from the specified log file.
- Marker
-
- Type: string
A pagination token that can be used in a later
DownloadDBLogFilePortion
request.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBInstanceNotReadyFault:
An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.
- DBLogFileNotFoundFault:
LogFileName
doesn't refer to an existing DB log file.
Examples
Example 1: To download a DB log file
The following example downloads only the latest part of your log file.
$result = $client->downloadDBLogFilePortion([ 'DBInstanceIdentifier' => 'test-instance', 'LogFileName' => 'log.txt', ]);
Result syntax:
[ ]
EnableHttpEndpoint
$result = $client->enableHttpEndpoint
([/* ... */]); $promise = $client->enableHttpEndpointAsync
([/* ... */]);
Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora 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.
This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint
parameter of the ModifyDBCluster
operation.
Parameter Syntax
$result = $client->enableHttpEndpoint([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB cluster.
Result Syntax
[ 'HttpEndpointEnabled' => true || false, 'ResourceArn' => '<string>', ]
Result Details
Members
- HttpEndpointEnabled
-
- Type: boolean
Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
- ResourceArn
-
- Type: string
The ARN of the DB cluster.
Errors
- ResourceNotFoundFault:
The specified resource ID was not found.
- InvalidResourceStateFault:
The operation can't be performed because another operation is in progress.
FailoverDBCluster
$result = $client->failoverDBCluster
([/* ... */]); $promise = $client->failoverDBClusterAsync
([/* ... */]);
Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->failoverDBCluster([ 'DBClusterIdentifier' => '<string>', // REQUIRED 'TargetDBInstanceIdentifier' => '<string>', ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DB cluster.
- TargetDBInstanceIdentifier
-
- Type: string
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example
mydbcluster-replica1
.This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To perform a failover for a DB cluster
This example performs a failover for the specified DB cluster to the specified DB instance.
$result = $client->failoverDBCluster([ 'DBClusterIdentifier' => 'myaurorainstance-cluster', 'TargetDBInstanceIdentifier' => 'myaurorareplica', ]);
Result syntax:
[ 'DBCluster' => [ ], ]
FailoverGlobalCluster
$result = $client->failoverGlobalCluster
([/* ... */]); $promise = $client->failoverGlobalClusterAsync
([/* ... */]);
Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.
How you use this operation depends on whether you are failing over or switching over your global database cluster:
-
Failing over - Specify the
AllowDataLoss
parameter and don't specify theSwitchover
parameter. -
Switching over - Specify the
Switchover
parameter or omit it, but don't specify theAllowDataLoss
parameter.
About failing over and switching over
While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
-
Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.
-
Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.
For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->failoverGlobalCluster([ 'AllowDataLoss' => true || false, 'GlobalClusterIdentifier' => '<string>', // REQUIRED 'Switchover' => true || false, 'TargetDbClusterIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AllowDataLoss
-
- Type: boolean
Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don't specify
AllowDataLoss
, the global database cluster operation defaults to a switchover.Constraints:
-
Can't be specified together with the
Switchover
parameter.
- GlobalClusterIdentifier
-
- Required: Yes
- Type: string
The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.
Constraints:
-
Must match the identifier of an existing global database cluster.
- Switchover
-
- Type: boolean
Specifies whether to switch over this global database cluster.
Constraints:
-
Can't be specified together with the
AllowDataLoss
parameter.
- TargetDbClusterIdentifier
-
- Required: Yes
- Type: string
The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
Result Syntax
[ 'GlobalCluster' => [ 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'FailoverState' => [ 'FromDbClusterArn' => '<string>', 'IsDataLossAllowed' => true || false, 'Status' => 'pending|failing-over|cancelling', 'ToDbClusterArn' => '<string>', ], 'GlobalClusterArn' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'GlobalClusterMembers' => [ [ 'DBClusterArn' => '<string>', 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'IsWriter' => true || false, 'Readers' => ['<string>', ...], 'SynchronizationStatus' => 'connected|pending-resync', ], // ... ], 'GlobalClusterResourceId' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
Errors
- GlobalClusterNotFoundFault:
The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster.- InvalidGlobalClusterStateFault:
The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->listTagsForResource([ 'Filters' => [ [ 'Name' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'ResourceName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
This parameter isn't currently supported.
- ResourceName
-
- Required: Yes
- Type: string
The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Result Syntax
[ 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- TagList
-
- Type: Array of Tag structures
List of tags returned by the
ListTagsForResource
operation.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetGroupNotFoundFault:
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundFault:
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.- IntegrationNotFoundFault:
The specified integration could not be found.
- TenantDatabaseNotFoundFault:
The specified tenant database wasn't found in the DB instance.
- DBSnapshotTenantDatabaseNotFoundFault:
The specified snapshot tenant database wasn't found.
Examples
Example 1: To list tags on an Amazon RDS resource
The following example lists all tags on a DB instance.
$result = $client->listTagsForResource([ 'ResourceName' => 'arn:aws:rds:us-east-1:123456789012:db:orcl1', ]);
Result syntax:
[ 'TagList' => [ [ 'Key' => 'Environment', 'Value' => 'test', ], [ 'Key' => 'Name', 'Value' => 'MyDatabase', ], ], ]
ModifyActivityStream
$result = $client->modifyActivityStream
([/* ... */]); $promise = $client->modifyActivityStreamAsync
([/* ... */]);
Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
Parameter Syntax
$result = $client->modifyActivityStream([ 'AuditPolicyState' => 'locked|unlocked', 'ResourceArn' => '<string>', ]);
Parameter Details
Members
- AuditPolicyState
-
- Type: string
The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
- ResourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example,
arn:aws:rds:us-east-1:12345667890:db:my-orcl-db
.
Result Syntax
[ 'EngineNativeAuditFieldsIncluded' => true || false, 'KinesisStreamName' => '<string>', 'KmsKeyId' => '<string>', 'Mode' => 'sync|async', 'PolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'Status' => 'stopped|starting|started|stopping', ]
Result Details
Members
- EngineNativeAuditFieldsIncluded
-
- Type: boolean
Indicates whether engine-native audit fields are included in the database activity stream.
- KinesisStreamName
-
- Type: string
The name of the Amazon Kinesis data stream to be used for the database activity stream.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
- Mode
-
- Type: string
The mode of the database activity stream.
- PolicyStatus
-
- Type: string
The status of the modification to the policy state of the database activity stream.
- Status
-
- Type: string
The status of the modification to the database activity stream.
Errors
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- ResourceNotFoundFault:
The specified resource ID was not found.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.
ModifyCertificates
$result = $client->modifyCertificates
([/* ... */]); $promise = $client->modifyCertificatesAsync
([/* ... */]);
Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
-
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
-
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->modifyCertificates([ 'CertificateIdentifier' => '<string>', 'RemoveCustomerOverride' => true || false, ]);
Parameter Details
Members
- CertificateIdentifier
-
- Type: string
The new default certificate identifier to override the current one with.
To determine the valid values, use the
describe-certificates
CLI command or theDescribeCertificates
API operation. - RemoveCustomerOverride
-
- Type: boolean
Specifies whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
Result Syntax
[ 'Certificate' => [ 'CertificateArn' => '<string>', 'CertificateIdentifier' => '<string>', 'CertificateType' => '<string>', 'CustomerOverride' => true || false, 'CustomerOverrideValidTill' => <DateTime>, 'Thumbprint' => '<string>', 'ValidFrom' => <DateTime>, 'ValidTill' => <DateTime>, ], ]
Result Details
Members
- Certificate
-
- Type: Certificate structure
A CA certificate for an Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Errors
- CertificateNotFoundFault:
CertificateIdentifier
doesn't refer to an existing certificate.
Examples
Example 1: To temporarily override the system-default SSL/TLS certificate for new DB instances
The following example temporarily overrides the system-default SSL/TLS certificate for new DB instances.
$result = $client->modifyCertificates([ 'CertificateIdentifier' => 'rds-ca-2019', ]);
Result syntax:
[ 'Certificate' => [ 'CertificateArn' => 'arn:aws:rds:us-east-1::cert:rds-ca-2019', 'CertificateIdentifier' => 'rds-ca-2019', 'CertificateType' => 'CA', 'CustomerOverride' => 1, 'CustomerOverrideValidTill' =>, 'Thumbprint' => 'EXAMPLE123456789012', 'ValidFrom' => , 'ValidTill' => , ], ]
ModifyCurrentDBClusterCapacity
$result = $client->modifyCurrentDBClusterCapacity
([/* ... */]); $promise = $client->modifyCurrentDBClusterCapacityAsync
([/* ... */]);
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity
to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity
with the default TimeoutAction
, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This operation only applies to Aurora Serverless v1 DB clusters.
Parameter Syntax
$result = $client->modifyCurrentDBClusterCapacity([ 'Capacity' => <integer>, 'DBClusterIdentifier' => '<string>', // REQUIRED 'SecondsBeforeTimeout' => <integer>, 'TimeoutAction' => '<string>', ]);
Parameter Details
Members
- Capacity
-
- Type: int
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
-
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
.
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DB cluster.
- SecondsBeforeTimeout
-
- Type: int
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
- TimeoutAction
-
- Type: string
The action to take when the timeout is reached, 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.
Result Syntax
[ 'CurrentCapacity' => <integer>, 'DBClusterIdentifier' => '<string>', 'PendingCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'TimeoutAction' => '<string>', ]
Result Details
Members
- CurrentCapacity
-
- Type: int
The current capacity of the DB cluster.
- DBClusterIdentifier
-
- Type: string
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
- PendingCapacity
-
- Type: int
A value that specifies the capacity that the DB cluster scales to next.
- SecondsBeforeTimeout
-
- Type: int
The number of seconds before a call to
ModifyCurrentDBClusterCapacity
times out. - TimeoutAction
-
- Type: string
The timeout action of a call to
ModifyCurrentDBClusterCapacity
, eitherForceApplyCapacityChange
orRollbackCapacityChange
.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBClusterCapacityFault:
Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are2
,4
,8
,16
,32
,64
,128
, and256
.
Examples
Example 1: To scale the capacity of an Aurora Serverless DB cluster
The following example scales the capacity of an Aurora Serverless DB cluster to 8.
$result = $client->modifyCurrentDBClusterCapacity([ 'Capacity' => 8, 'DBClusterIdentifier' => 'mydbcluster', ]);
Result syntax:
[ 'CurrentCapacity' => 1, 'DBClusterIdentifier' => 'mydbcluster', 'PendingCapacity' => 8, 'SecondsBeforeTimeout' => 300, 'TimeoutAction' => 'ForceApplyCapacityChange', ]
ModifyCustomDBEngineVersion
$result = $client->modifyCustomDBEngineVersion
([/* ... */]); $promise = $client->modifyCustomDBEngineVersionAsync
([/* ... */]);
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions
.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion
event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->modifyCustomDBEngineVersion([ 'Description' => '<string>', 'Engine' => '<string>', // REQUIRED 'EngineVersion' => '<string>', // REQUIRED 'Status' => 'available|inactive|inactive-except-restore', ]);
Parameter Details
Members
- Description
-
- Type: string
An optional description of your CEV.
- Engine
-
- Required: Yes
- Type: string
The database engine. RDS Custom for Oracle supports the following values:
-
custom-oracle-ee
-
custom-oracle-ee-cdb
-
custom-oracle-se2
-
custom-oracle-se2-cdb
- EngineVersion
-
- Required: Yes
- Type: string
The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of
Engine
andEngineVersion
is unique per customer per Amazon Web Services Region. - Status
-
- Type: string
The availability status to be assigned to the CEV. Valid values are as follows:
- available
-
You can use this CEV to create a new RDS Custom DB instance.
- inactive
-
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from
available
toinactive
, and frominactive
back toavailable
. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
Result Syntax
[ 'CreateTime' => <DateTime>, 'CustomDBEngineVersionManifest' => '<string>', 'DBEngineDescription' => '<string>', 'DBEngineMediaType' => '<string>', 'DBEngineVersionArn' => '<string>', 'DBEngineVersionDescription' => '<string>', 'DBParameterGroupFamily' => '<string>', 'DatabaseInstallationFilesS3BucketName' => '<string>', 'DatabaseInstallationFilesS3Prefix' => '<string>', 'DefaultCharacterSet' => [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], 'Engine' => '<string>', 'EngineVersion' => '<string>', 'ExportableLogTypes' => ['<string>', ...], 'Image' => [ 'ImageId' => '<string>', 'Status' => '<string>', ], 'KMSKeyId' => '<string>', 'MajorEngineVersion' => '<string>', 'ServerlessV2FeaturesSupport' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, ], 'Status' => '<string>', 'SupportedCACertificateIdentifiers' => ['<string>', ...], 'SupportedCharacterSets' => [ [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], // ... ], 'SupportedEngineModes' => ['<string>', ...], 'SupportedFeatureNames' => ['<string>', ...], 'SupportedNcharCharacterSets' => [ [ 'CharacterSetDescription' => '<string>', 'CharacterSetName' => '<string>', ], // ... ], 'SupportedTimezones' => [ [ 'TimezoneName' => '<string>', ], // ... ], 'SupportsBabelfish' => true || false, 'SupportsCertificateRotationWithoutRestart' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIntegrations' => true || false, 'SupportsLimitlessDatabase' => true || false, 'SupportsLocalWriteForwarding' => true || false, 'SupportsLogExportsToCloudwatchLogs' => true || false, 'SupportsParallelQuery' => true || false, 'SupportsReadReplica' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ValidUpgradeTarget' => [ [ 'AutoUpgrade' => true || false, 'Description' => '<string>', 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IsMajorVersionUpgrade' => true || false, 'SupportedEngineModes' => ['<string>', ...], 'SupportsBabelfish' => true || false, 'SupportsGlobalDatabases' => true || false, 'SupportsIntegrations' => true || false, 'SupportsLimitlessDatabase' => true || false, 'SupportsLocalWriteForwarding' => true || false, 'SupportsParallelQuery' => true || false, ], // ... ], ]
Result Details
Members
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the DB engine version.
- CustomDBEngineVersionManifest
-
- Type: string
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
- DBEngineDescription
-
- Type: string
The description of the database engine.
- DBEngineMediaType
-
- Type: string
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
- DBEngineVersionArn
-
- Type: string
The ARN of the custom engine version.
- DBEngineVersionDescription
-
- Type: string
The description of the database engine version.
- DBParameterGroupFamily
-
- Type: string
The name of the DB parameter group family for the database engine.
- DatabaseInstallationFilesS3BucketName
-
- Type: string
The name of the Amazon S3 bucket that contains your database installation files.
- DatabaseInstallationFilesS3Prefix
-
- Type: string
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
- DefaultCharacterSet
-
- Type: CharacterSet structure
The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn't specified. - Engine
-
- Type: string
The name of the database engine.
- EngineVersion
-
- Type: string
The version number of the database engine.
- ExportableLogTypes
-
- Type: Array of strings
The types of logs that the database engine has available for export to CloudWatch Logs.
- Image
-
- Type: CustomDBEngineVersionAMI structure
The EC2 image
- KMSKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
- MajorEngineVersion
-
- Type: string
The major engine version of the CEV.
- ServerlessV2FeaturesSupport
-
- Type: ServerlessV2FeaturesSupport structure
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
- Status
-
- Type: string
The status of the DB engine version, either
available
ordeprecated
. - SupportedCACertificateIdentifiers
-
- Type: Array of strings
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- SupportedCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation. - SupportedEngineModes
-
- Type: Array of strings
A list of the supported DB engine modes.
- SupportedFeatureNames
-
- Type: Array of strings
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output. - SupportedNcharCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation. - SupportedTimezones
-
- Type: Array of Timezone structures
A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action. - SupportsBabelfish
-
- Type: boolean
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- SupportsCertificateRotationWithoutRestart
-
- Type: boolean
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
- SupportsGlobalDatabases
-
- Type: boolean
Indicates whether you can use Aurora global databases with a specific DB engine version.
- SupportsIntegrations
-
- Type: boolean
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
- SupportsLimitlessDatabase
-
- Type: boolean
Indicates whether the DB engine version supports Aurora Limitless Database.
- SupportsLocalWriteForwarding
-
- Type: boolean
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
- SupportsLogExportsToCloudwatchLogs
-
- Type: boolean
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
- SupportsParallelQuery
-
- Type: boolean
Indicates whether you can use Aurora parallel query with a specific DB engine version.
- SupportsReadReplica
-
- Type: boolean
Indicates whether the database engine version supports read replicas.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- ValidUpgradeTarget
-
- Type: Array of UpgradeTarget structures
A list of engine versions that this database engine version can be upgraded to.
Errors
- CustomDBEngineVersionNotFoundFault:
The specified CEV was not found.
- InvalidCustomDBEngineVersionStateFault:
You can't delete the CEV.
ModifyDBCluster
$result = $client->modifyDBCluster
([/* ... */]); $promise = $client->modifyDBClusterAsync
([/* ... */]);
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->modifyDBCluster([ 'AllocatedStorage' => <integer>, 'AllowEngineModeChange' => true || false, 'AllowMajorVersionUpgrade' => true || false, 'ApplyImmediately' => true || false, 'AutoMinorVersionUpgrade' => true || false, 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'CloudwatchLogsExportConfiguration' => [ 'DisableLogTypes' => ['<string>', ...], 'EnableLogTypes' => ['<string>', ...], ], 'CopyTagsToSnapshot' => true || false, 'DBClusterIdentifier' => '<string>', // REQUIRED 'DBClusterInstanceClass' => '<string>', 'DBClusterParameterGroupName' => '<string>', 'DBInstanceParameterGroupName' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DeletionProtection' => true || false, 'Domain' => '<string>', 'DomainIAMRoleName' => '<string>', 'EnableGlobalWriteForwarding' => true || false, 'EnableHttpEndpoint' => true || false, 'EnableIAMDatabaseAuthentication' => true || false, 'EnableLimitlessDatabase' => true || false, 'EnableLocalWriteForwarding' => true || false, 'EnablePerformanceInsights' => true || false, 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'Iops' => <integer>, 'ManageMasterUserPassword' => true || false, 'MasterUserPassword' => '<string>', 'MasterUserSecretKmsKeyId' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'NetworkType' => '<string>', 'NewDBClusterIdentifier' => '<string>', 'OptionGroupName' => '<string>', 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'RotateMasterUserPassword' => true || false, 'ScalingConfiguration' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'StorageType' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AllocatedStorage
-
- Type: int
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
- AllowEngineModeChange
-
- Type: boolean
Specifies whether engine mode changes from
serverless
toprovisioned
are allowed.Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
-
You must allow engine mode changes when specifying a different value for the
EngineMode
parameter from the DB cluster's current engine mode.
- AllowMajorVersionUpgrade
-
- Type: boolean
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
You must allow major version upgrades when specifying a value for the
EngineVersion
parameter that is a different major version than the DB cluster's current version.
- ApplyImmediately
-
- Type: boolean
Specifies whether the modifications in this request are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- AutoMinorVersionUpgrade
-
- Type: boolean
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
- AwsBackupRecoveryPointArn
-
- Type: string
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- BacktrackWindow
-
- Type: long (int|float)
The target backtrack window, in seconds. To disable backtracking, set this value to
0
.Valid for Cluster Type: Aurora MySQL DB clusters only
Default:
0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
- BackupRetentionPeriod
-
- Type: int
The number of days for which automated backups are retained. Specify a minimum value of
1
.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default:
1
Constraints:
-
Must be a value from 1 to 35.
- CACertificateIdentifier
-
- Type: string
The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
- CloudwatchLogsExportConfiguration
-
- Type: CloudwatchLogsExportConfiguration structure
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
-
Aurora MySQL -
audit | error | general | slowquery
-
Aurora PostgreSQL -
postgresql
-
RDS for MySQL -
error | general | slowquery
-
RDS for PostgreSQL -
postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Must match the identifier of an existing DB cluster.
- DBClusterInstanceClass
-
- Type: string
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.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 Cluster Type: Multi-AZ DB clusters only
- DBClusterParameterGroupName
-
- Type: string
The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- DBInstanceParameterGroupName
-
- Type: string
The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the
DBInstanceParameterGroupName
parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
-
The DB parameter group must be in the same DB parameter group family as this DB cluster.
-
The
DBInstanceParameterGroupName
parameter is valid in combination with theAllowMajorVersionUpgrade
parameter for a major version upgrade only.
- DatabaseInsightsMode
-
- Type: string
Specifies the mode of Database Insights to enable for the cluster.
- DeletionProtection
-
- Type: boolean
Specifies 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- Domain
-
- Type: string
The Active Directory directory ID to move the DB cluster to. Specify
none
to remove the cluster from its current domain. The domain must be created prior to this operation.For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
- EnableGlobalWriteForwarding
-
- Type: boolean
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
- EnableHttpEndpoint
-
- Type: boolean
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 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.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora Serverless v2 or provisioned DB cluster, use the
EnableHttpEndpoint
andDisableHttpEndpoint
operations.Valid for Cluster Type: Aurora DB clusters only
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies 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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- EnableLimitlessDatabase
-
- Type: boolean
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
This setting is no longer used. Instead use the
ClusterScalabilityType
setting when you create your Aurora Limitless Database DB cluster. - EnableLocalWriteForwarding
-
- Type: boolean
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
- EnablePerformanceInsights
-
- Type: boolean
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- EngineMode
-
- Type: string
The DB engine mode of the DB cluster, either
provisioned
orserverless
.The DB engine mode can be modified only from
serverless
toprovisioned
.For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
- EngineVersion
-
- Type: string
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless
ApplyImmediately
is enabled.If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- Iops
-
- Type: int
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 in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
-
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
- ManageMasterUserPassword
-
- Type: boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify
MasterUserPassword
.If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify
MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the master user specified byMasterUserPassword
.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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- MasterUserPassword
-
- Type: string
The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Must contain from 8 to 41 characters.
-
Can contain any printable ASCII character except "/", """, or "@".
-
Can't be specified if
ManageMasterUserPassword
is turned on.
- MasterUserSecretKmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
-
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
-
You are turning on
ManageMasterUserPassword
to manage the master user password in Amazon Web Services Secrets Manager.If you are turning on
ManageMasterUserPassword
and don't specifyMasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
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.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify
0
.If
MonitoringRoleArn
is specified, also setMonitoringInterval
to a value other than0
.Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
0
- MonitoringRoleArn
-
- Type: string
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than0
, supply aMonitoringRoleArn
value.Valid for Cluster Type: Multi-AZ DB clusters only
- NetworkType
-
- Type: string
The network type of the DB cluster.
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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.
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
IPV4 | DUAL
- NewDBClusterIdentifier
-
- Type: string
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster2
- OptionGroupName
-
- Type: string
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
If you don't specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.Valid for Cluster Type: Multi-AZ DB clusters only
- PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
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
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS issues an error. - Port
-
- Type: int
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
1150-65535
Default: The same port as the original DB cluster.
- PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
- PreferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
-
Must be in the format
ddd:hh24:mi-ddd:hh24:mi
. -
Days must be one of
Mon | Tue | Wed | Thu | Fri | Sat | Sun
. -
Must be in Universal Coordinated Time (UTC).
-
Must be at least 30 minutes.
- RotateMasterUserPassword
-
- Type: boolean
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated 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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
-
You must apply the change immediately when rotating the master user password.
- ScalingConfiguration
-
- Type: ScalingConfiguration structure
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.Valid for Cluster Type: Aurora DB clusters only
- ServerlessV2ScalingConfiguration
-
- Type: ServerlessV2ScalingConfiguration structure
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- StorageType
-
- Type: string
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the
Iops
parameter is required.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
-
Aurora DB clusters -
aurora | aurora-iopt1
-
Multi-AZ DB clusters -
io1 | io2 | gp3
Default:
-
Aurora DB clusters -
aurora
-
Multi-AZ DB clusters -
io1
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDBSubnetGroupStateFault:
The DB subnet group cannot be deleted because it's in use.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.- InvalidDBSecurityGroupStateFault:
The state of the DB security group doesn't allow deletion.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- DBClusterAlreadyExistsFault:
The user already has a DB cluster with the given identifier.
- DBInstanceAlreadyExistsFault:
The user already has a DB instance with the given identifier.
- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- StorageTypeNotAvailableFault:
The
aurora-iopt1
storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago.- OptionGroupNotFoundFault:
The specified option group could not be found.
Examples
Example 1: To modify a DB cluster
The following example changes the master user password for the DB cluster named cluster-2 and sets the backup retention period to 14 days. The ApplyImmediately parameter causes the changes to be made immediately, instead of waiting until the next maintenance window.
$result = $client->modifyDBCluster([ 'ApplyImmediately' => 1, 'BackupRetentionPeriod' => 14, 'DBClusterIdentifier' => 'cluster-2', 'MasterUserPassword' => 'newpassword99', ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 1, 'AssociatedRoles' => [ ], 'AvailabilityZones' => [ 'eu-central-1b', 'eu-central-1c', 'eu-central-1a', ], 'BackupRetentionPeriod' => 14, 'ClusterCreateTime' =>, 'CopyTagsToSnapshot' => 1, 'CrossAccountClone' => , 'DBClusterArn' => 'arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2', 'DBClusterIdentifier' => 'cluster-2', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => 'in-sync', 'DBInstanceIdentifier' => 'cluster-2-instance-1', 'IsClusterWriter' => 1, 'PromotionTier' => 1, ], ], 'DBClusterParameterGroup' => 'default.aurora5.6', 'DBSubnetGroup' => 'default-vpc-2305ca49', 'DatabaseName' => '', 'DbClusterResourceId' => 'cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE', 'DeletionProtection' => , 'DomainMemberships' => [ ], 'EarliestRestorableTime' => , 'Endpoint' => 'cluster-2.cluster-############.eu-central-1.rds.amazonaws.com', 'Engine' => 'aurora', 'EngineMode' => 'provisioned', 'EngineVersion' => '5.6.10a', 'HostedZoneId' => 'Z1RLNU0EXAMPLE', 'HttpEndpointEnabled' => , 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6', 'LatestRestorableTime' => , 'MasterUsername' => 'admin', 'MultiAZ' => , 'Port' => 3306, 'PreferredBackupWindow' => '01:55-02:25', 'PreferredMaintenanceWindow' => 'thu:21:14-thu:21:44', 'ReadReplicaIdentifiers' => [ ], 'ReaderEndpoint' => 'cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com', 'Status' => 'available', 'StorageEncrypted' => 1, 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-20a5c047', ], ], ], ]
ModifyDBClusterEndpoint
$result = $client->modifyDBClusterEndpoint
([/* ... */]); $promise = $client->modifyDBClusterEndpointAsync
([/* ... */]);
Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This operation only applies to Aurora DB clusters.
Parameter Syntax
$result = $client->modifyDBClusterEndpoint([ 'DBClusterEndpointIdentifier' => '<string>', // REQUIRED 'EndpointType' => '<string>', 'ExcludedMembers' => ['<string>', ...], 'StaticMembers' => ['<string>', ...], ]);
Parameter Details
Members
- DBClusterEndpointIdentifier
-
- Required: Yes
- Type: string
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
- EndpointType
-
- Type: string
The type of the endpoint. One of:
READER
,WRITER
,ANY
. - ExcludedMembers
-
- Type: Array of strings
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
- StaticMembers
-
- Type: Array of strings
List of DB instance identifiers that are part of the custom endpoint group.
Result Syntax
[ 'CustomEndpointType' => '<string>', 'DBClusterEndpointArn' => '<string>', 'DBClusterEndpointIdentifier' => '<string>', 'DBClusterEndpointResourceIdentifier' => '<string>', 'DBClusterIdentifier' => '<string>', 'Endpoint' => '<string>', 'EndpointType' => '<string>', 'ExcludedMembers' => ['<string>', ...], 'StaticMembers' => ['<string>', ...], 'Status' => '<string>', ]
Result Details
Members
- CustomEndpointType
-
- Type: string
The type associated with a custom endpoint. One of:
READER
,WRITER
,ANY
. - DBClusterEndpointArn
-
- Type: string
The Amazon Resource Name (ARN) for the endpoint.
- DBClusterEndpointIdentifier
-
- Type: string
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
- DBClusterEndpointResourceIdentifier
-
- Type: string
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
- DBClusterIdentifier
-
- Type: string
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
- Endpoint
-
- Type: string
The DNS address of the endpoint.
- EndpointType
-
- Type: string
The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
. - ExcludedMembers
-
- Type: Array of strings
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
- StaticMembers
-
- Type: Array of strings
List of DB instance identifiers that are part of the custom endpoint group.
- Status
-
- Type: string
The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that can't be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.
Errors
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBClusterEndpointStateFault:
The requested operation can't be performed on the endpoint while the endpoint is in this state.
- DBClusterEndpointNotFoundFault:
The specified custom endpoint doesn't exist.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To modify a custom DB cluster endpoint
The following example modifies the specified custom DB cluster endpoint.
$result = $client->modifyDBClusterEndpoint([ 'DBClusterEndpointIdentifier' => 'mycustomendpoint', 'StaticMembers' => [ 'dbinstance1', 'dbinstance2', 'dbinstance3', ], ]);
Result syntax:
[ 'CustomEndpointType' => 'READER', 'DBClusterEndpointArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint', 'DBClusterEndpointIdentifier' => 'mycustomendpoint', 'DBClusterEndpointResourceIdentifier' => 'cluster-endpoint-ANPAJ4AE5446DAEXAMPLE', 'DBClusterIdentifier' => 'mydbcluster', 'Endpoint' => 'mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com', 'EndpointType' => 'CUSTOM', 'ExcludedMembers' => [ ], 'StaticMembers' => [ 'dbinstance1', 'dbinstance2', 'dbinstance3', ], 'Status' => 'modifying', ]
ModifyDBClusterParameterGroup
$result = $client->modifyDBClusterParameterGroup
([/* ... */]); $promise = $client->modifyDBClusterParameterGroupAsync
([/* ... */]);
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName
, ParameterValue
, and ApplyMethod
. A maximum of 20 parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create operation before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters
operation to verify that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->modifyDBClusterParameterGroup([ 'DBClusterParameterGroupName' => '<string>', // REQUIRED 'Parameters' => [ // REQUIRED [ 'AllowedValues' => '<string>', 'ApplyMethod' => 'immediate|pending-reboot', 'ApplyType' => '<string>', 'DataType' => '<string>', 'Description' => '<string>', 'IsModifiable' => true || false, 'MinimumEngineVersion' => '<string>', 'ParameterName' => '<string>', 'ParameterValue' => '<string>', 'Source' => '<string>', 'SupportedEngineModes' => ['<string>', ...], ], // ... ], ]);
Parameter Details
Members
- DBClusterParameterGroupName
-
- Required: Yes
- Type: string
The name of the DB cluster parameter group to modify.
- Parameters
-
- Required: Yes
- Type: Array of Parameter structures
A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method):
immediate | pending-reboot
You can use the
immediate
value with dynamic parameters only. You can use thepending-reboot
value for both dynamic and static parameters.When the application method is
immediate
, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method ispending-reboot
, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
Result Syntax
[ 'DBClusterParameterGroupName' => '<string>', ]
Result Details
Members
- DBClusterParameterGroupName
-
- Type: string
The name of the DB cluster parameter group.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
Errors
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- InvalidDBParameterGroupStateFault:
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
Examples
Example 1: To modify parameters in a DB cluster parameter group
The following example modifies the values of parameters in a DB cluster parameter group.
$result = $client->modifyDBClusterParameterGroup([ 'DBClusterParameterGroupName' => 'mydbclusterpg', 'Parameters' => [ [ 'ApplyMethod' => 'immediate', 'ParameterName' => 'server_audit_logging', 'ParameterValue' => '1', ], [ 'ApplyMethod' => 'immediate', 'ParameterName' => 'server_audit_logs_upload', 'ParameterValue' => '1', ], ], ]);
Result syntax:
[ 'DBClusterParameterGroupName' => 'mydbclusterpg', ]
ModifyDBClusterSnapshotAttribute
$result = $client->modifyDBClusterSnapshotAttribute
([/* ... */]); $promise = $client->modifyDBClusterSnapshotAttributeAsync
([/* ... */]);
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore
as the AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all
to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.
Don't add the all
value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd
parameter. You can't use all
as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore
attribute.
Parameter Syntax
$result = $client->modifyDBClusterSnapshotAttribute([ 'AttributeName' => '<string>', // REQUIRED 'DBClusterSnapshotIdentifier' => '<string>', // REQUIRED 'ValuesToAdd' => ['<string>', ...], 'ValuesToRemove' => ['<string>', ...], ]);
Parameter Details
Members
- AttributeName
-
- Required: Yes
- Type: string
The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to
restore
.To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
- DBClusterSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier for the DB cluster snapshot to modify the attributes for.
- ValuesToAdd
-
- Type: Array of strings
A list of DB cluster snapshot attributes to add to the attribute specified by
AttributeName
.To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or
all
to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add theall
value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. - ValuesToRemove
-
- Type: Array of strings
A list of DB cluster snapshot attributes to remove from the attribute specified by
AttributeName
.To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or
all
to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specifyall
, an Amazon Web Services account whose account ID is explicitly added to therestore
attribute can still copy or restore a manual DB cluster snapshot.
Result Syntax
[ 'DBClusterSnapshotAttributesResult' => [ 'DBClusterSnapshotAttributes' => [ [ 'AttributeName' => '<string>', 'AttributeValues' => ['<string>', ...], ], // ... ], 'DBClusterSnapshotIdentifier' => '<string>', ], ]
Result Details
Members
- DBClusterSnapshotAttributesResult
-
- Type: DBClusterSnapshotAttributesResult structure
Contains the results of a successful call to the
DescribeDBClusterSnapshotAttributes
API action.Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.
Errors
- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.- InvalidDBClusterSnapshotStateFault:
The supplied value isn't a valid DB cluster snapshot state.
- SharedSnapshotQuotaExceededFault:
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
Examples
Example 1: To modify a DB cluster snapshot attribute
The following example makes changes to the specified DB cluster snapshot attribute.
$result = $client->modifyDBClusterSnapshotAttribute([ 'AttributeName' => 'restore', 'DBClusterSnapshotIdentifier' => 'myclustersnapshot', 'ValuesToAdd' => [ '123456789012', ], ]);
Result syntax:
[ 'DBClusterSnapshotAttributesResult' => [ 'DBClusterSnapshotAttributes' => [ [ 'AttributeName' => 'restore', 'AttributeValues' => [ '123456789012', ], ], ], 'DBClusterSnapshotIdentifier' => 'myclustersnapshot', ], ]
ModifyDBInstance
$result = $client->modifyDBInstance
([/* ... */]); $promise = $client->modifyDBInstanceAsync
([/* ... */]);
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications
before you call ModifyDBInstance
.
Parameter Syntax
$result = $client->modifyDBInstance([ 'AllocatedStorage' => <integer>, 'AllowMajorVersionUpgrade' => true || false, 'ApplyImmediately' => true || false, 'AutoMinorVersionUpgrade' => true || false, 'AutomationMode' => 'full|all-paused', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'CertificateRotationRestart' => true || false, 'CloudwatchLogsExportConfiguration' => [ 'DisableLogTypes' => ['<string>', ...], 'EnableLogTypes' => ['<string>', ...], ], 'CopyTagsToSnapshot' => true || false, 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', // REQUIRED 'DBParameterGroupName' => '<string>', 'DBPortNumber' => <integer>, 'DBSecurityGroups' => ['<string>', ...], 'DBSubnetGroupName' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DisableDomain' => true || false, 'Domain' => '<string>', 'DomainAuthSecretArn' => '<string>', 'DomainDnsIps' => ['<string>', ...], 'DomainFqdn' => '<string>', 'DomainIAMRoleName' => '<string>', 'DomainOu' => '<string>', 'EnableCustomerOwnedIp' => true || false, 'EnableIAMDatabaseAuthentication' => true || false, 'EnablePerformanceInsights' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'Iops' => <integer>, 'LicenseModel' => '<string>', 'ManageMasterUserPassword' => true || false, 'MasterUserPassword' => '<string>', 'MasterUserSecretKmsKeyId' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NetworkType' => '<string>', 'NewDBInstanceIdentifier' => '<string>', 'OptionGroupName' => '<string>', 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeMinutes' => <integer>, 'RotateMasterUserPassword' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TdeCredentialArn' => '<string>', 'TdeCredentialPassword' => '<string>', 'UseDefaultProcessorFeatures' => true || false, 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AllocatedStorage
-
- Type: int
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see
CreateDBInstance
.Constraints:
-
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (
gp3
,io1
, orio2
storage type), you must also specify theIops
parameter. You can use the current value forIops
.
- AllowMajorVersionUpgrade
-
- Type: boolean
Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
-
Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that's a different major version than the DB instance's current version.
- ApplyImmediately
-
- Type: boolean
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow
setting for the DB instance. By default, this parameter is disabled.If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling
ApplyImmediately
for each modified parameter and to determine when the changes are applied. - AutoMinorVersionUpgrade
-
- Type: boolean
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
-
The automatic upgrade is enabled for the maintenance window.
-
A newer minor version is available.
-
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
- AutomationMode
-
- Type: string
The automation mode of the RDS Custom DB instance. If
full
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set byResumeFullAutomationModeMinutes
. - AwsBackupRecoveryPointArn
-
- Type: string
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom DB instances.
- BackupRetentionPeriod
-
- Type: int
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. For more information, see
ModifyDBCluster
.Default: Uses existing setting
Constraints:
-
Must be a value from 0 to 35.
-
Can't be set to 0 if the DB instance is a source to read replicas.
-
Can't be set to 0 for an RDS Custom for Oracle DB instance.
- CACertificateIdentifier
-
- Type: string
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- CertificateRotationRestart
-
- Type: boolean
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
-
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
-
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom DB instances.
- CloudwatchLogsExportConfiguration
-
- Type: CloudwatchLogsExportConfiguration structure
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the
CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance immediately. Therefore, theApplyImmediately
parameter has no effect.This setting doesn't apply to RDS Custom DB instances.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
ModifyDBCluster
. - DBInstanceClass
-
- Type: string
The new compute and memory capacity of the DB instance, for example
db.m4.large
. 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 or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify
ApplyImmediately
in your request.Default: Uses existing setting
Constraints:
-
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DB instance.
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom DB instances.
Default: Uses existing setting
Constraints:
-
Must be in the same DB parameter group family as the DB instance.
- DBPortNumber
-
- Type: int
The port number on which the database accepts connections.
The value of the
DBPortNumber
parameter must not match any of the port values specified for options in the option group for the DB instance.If you change the
DBPortNumber
value, your database restarts regardless of the value of theApplyImmediately
parameter.This setting doesn't apply to RDS Custom DB instances.
Valid Values:
1150-65535
Default:
-
Amazon Aurora -
3306
-
RDS for Db2 -
50000
-
RDS for MariaDB -
3306
-
RDS for Microsoft SQL Server -
1433
-
RDS for MySQL -
3306
-
RDS for Oracle -
1521
-
RDS for PostgreSQL -
5432
Constraints:
-
For RDS for Microsoft SQL Server, the value can't be
1234
,1434
,3260
,3343
,3389
,47001
, or49152-49156
.
- DBSecurityGroups
-
- Type: Array of strings
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
-
If supplied, must match existing DB security groups.
- DBSubnetGroupName
-
- Type: string
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable
ApplyImmediately
.This setting doesn't apply to RDS Custom DB instances.
Constraints:
-
If supplied, must match existing DB subnet group.
Example:
mydbsubnetgroup
- DatabaseInsightsMode
-
- Type: string
Specifies the mode of Database Insights to enable for the instance.
- DedicatedLogVolume
-
- Type: boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- DeletionProtection
-
- Type: boolean
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see
ModifyDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - DisableDomain
-
- Type: boolean
Specifies whether to remove the DB instance from the Active Directory domain.
- Domain
-
- Type: string
The Active Directory directory ID to move the DB instance to. Specify
none
to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- DomainAuthSecretArn
-
- Type: string
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- DomainDnsIps
-
- Type: Array of strings
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
-
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example:
123.124.125.126,234.235.236.237
- DomainFqdn
-
- Type: string
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
-
Can't be longer than 64 characters.
Example:
mymanagedADtest.mymanagedAD.mydomain
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
- DomainOu
-
- Type: string
The Active Directory organizational unit for your DB instance to join.
Constraints:
-
Must be in the distinguished name format.
-
Can't be longer than 64 characters.
Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- EnableCustomerOwnedIp
-
- Type: boolean
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- EnablePerformanceInsights
-
- Type: boolean
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- Engine
-
- Type: string
The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
-
Make sure that you specify
oracle-ee-cdb
ororacle-se2-cdb
. -
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
-
You can't convert a CDB to a non-CDB.
-
You can't convert a replica database.
-
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
-
You can't convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with
--db-parameter-group-name
and a new option group with--option-group-name
.
- EngineVersion
-
- Type: string
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see
CreateDBInstance
, or callDescribeDBEngineVersions
.If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.Constraints:
-
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
- Iops
-
- Type: int
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints:
-
For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
-
When you increase the Provisioned IOPS, you must also specify the
AllocatedStorage
parameter. You can use the current value forAllocatedStorage
.
Default: Uses existing setting
- LicenseModel
-
- Type: string
The license model for the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
-
RDS for Db2 -
bring-your-own-license
-
RDS for MariaDB -
general-public-license
-
RDS for Microsoft SQL Server -
license-included
-
RDS for MySQL -
general-public-license
-
RDS for Oracle -
bring-your-own-license | license-included
-
RDS for PostgreSQL -
postgresql-license
- ManageMasterUserPassword
-
- Type: boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify
MasterUserPassword
.If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify
MasterUserPassword
. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified byMasterUserPassword
.For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
- MasterUserPassword
-
- Type: string
The new password for the master user.
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the
MasterUserPassword
element exists in thePendingModifiedValues
element of the operation response.Amazon RDS API operations never return the password, so this operation provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.) -
RDS Custom
Default: Uses existing setting
Constraints:
-
Can't be specified if
ManageMasterUserPassword
is turned on. -
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
-
RDS for Db2 - Must contain from 8 to 255 characters.
-
RDS for MariaDB - Must contain from 8 to 41 characters.
-
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
-
RDS for MySQL - Must contain from 8 to 41 characters.
-
RDS for Oracle - Must contain from 8 to 30 characters.
-
RDS for PostgreSQL - Must contain from 8 to 128 characters.
- MasterUserSecretKmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
-
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
-
You are turning on
ManageMasterUserPassword
to manage the master user password in Amazon Web Services Secrets Manager.If you are turning on
ManageMasterUserPassword
and don't specifyMasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
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.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
- MaxAllocatedStorage
-
- Type: int
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify
0
.If
MonitoringRoleArn
is specified, setMonitoringInterval
to a value other than0
.This setting doesn't apply to RDS Custom DB instances.
Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
0
- MonitoringRoleArn
-
- Type: string
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than0
, supply aMonitoringRoleArn
value.This setting doesn't apply to RDS Custom DB instances.
- MultiAZ
-
- Type: boolean
Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.This setting doesn't apply to RDS Custom DB instances.
- MultiTenant
-
- Type: boolean
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user name, character set, and national character set metadata with this database. The tags associated with the instance also propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the
CreateTenantDatabase
operation.The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert back to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
. - NetworkType
-
- Type: string
The network type of the DB instance.
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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 RDS User Guide.
Valid Values:
IPV4 | DUAL
- NewDBInstanceIdentifier
-
- Type: string
The new identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable
ApplyImmediately
, or will occur during the next maintenance window if you disableApplyImmediately
. This value is stored as a lowercase string.This setting doesn't apply to RDS Custom DB instances.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
- OptionGroupName
-
- Type: string
The option group to associate the DB instance with.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom DB instances.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
If you don't specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.This setting doesn't apply to RDS Custom DB instances.
- PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
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
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS returns an error. - PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. For more information, see
ModifyDBCluster
.Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
- PreferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter causes a reboot of the DB instance. If you change this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Constraints:
-
Must be in the format
ddd:hh24:mi-ddd:hh24:mi
. -
The day values must be
mon | tue | wed | thu | fri | sat | sun
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred backup window.
-
Must be at least 30 minutes.
- ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom DB instances.
- PromotionTier
-
- Type: int
The order of priority 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.
This setting doesn't apply to RDS Custom DB instances.
Default:
1
Valid Values:
0 - 15
- PubliclyAccessible
-
- Type: boolean
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't 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.
PubliclyAccessible
only applies to DB instances in a VPC. The DB instance must be part of a public subnet andPubliclyAccessible
must be enabled for it to be publicly accessible.Changes to the
PubliclyAccessible
parameter are applied immediately regardless of the value of theApplyImmediately
parameter. - ReplicaMode
-
- Type: string
A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
- ResumeFullAutomationModeMinutes
-
- Type: int
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
Default:
60
Constraints:
-
Must be at least 60.
-
Must be no more than 1,440.
- RotateMasterUserPassword
-
- Type: boolean
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
You must apply the change immediately when rotating the master user password.
- StorageThroughput
-
- Type: int
The storage throughput value for the DB instance.
This setting applies only to the
gp3
storage type.This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- StorageType
-
- Type: string
The storage type to associate with the DB instance.
If you specify
io1
,io2
, orgp3
you must also include a value for theIops
parameter.If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid Values:
gp2 | gp3 | io1 | io2 | standard
Default:
io1
, if theIops
parameter is specified. Otherwise,gp2
. - TdeCredentialArn
-
- Type: string
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom DB instances.
- TdeCredentialPassword
-
- Type: string
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom DB instances.
- UseDefaultProcessorFeatures
-
- Type: boolean
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see
ModifyDBCluster
.) -
RDS Custom
Constraints:
-
If supplied, must match existing VPC security group IDs.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- InvalidDBSecurityGroupStateFault:
The state of the DB security group doesn't allow deletion.
- DBInstanceAlreadyExistsFault:
The user already has a DB instance with the given identifier.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAZFault:
Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- DBUpgradeDependencyFailureFault:
The DB upgrade failed because a resource the DB depends on can't be modified.
- StorageTypeNotSupportedFault:
The specified
StorageType
can't be associated with the DB instance.- AuthorizationNotFoundFault:
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- CertificateNotFoundFault:
CertificateIdentifier
doesn't refer to an existing certificate.- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- BackupPolicyNotFoundFault:
- This error does not currently have a description.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- NetworkTypeNotSupported:
The network type is invalid for the DB instance. Valid nework type values are
IPV4
andDUAL
.- TenantDatabaseQuotaExceededFault:
You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
Examples
Example 1: To modify a DB instance
The following example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ApplyImmediately parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.
$result = $client->modifyDBInstance([ 'ApplyImmediately' => 1, 'DBInstanceIdentifier' => 'database-2', 'DBParameterGroupName' => 'test-sqlserver-se-2017', 'OptionGroupName' => 'test-se-2017', ]);
Result syntax:
[ 'DBInstance' => [ 'AssociatedRoles' => [ ], 'AutoMinorVersionUpgrade' => , 'AvailabilityZone' => 'us-west-2d', 'CharacterSetName' => 'SQL_Latin1_General_CP1_CI_AS', 'DBInstanceClass' => 'db.r4.large', 'DBInstanceIdentifier' => 'database-2', 'DBInstanceStatus' => 'available', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => 'test-sqlserver-se-2017', 'ParameterApplyStatus' => 'applying', ], ], 'DeletionProtection' => , 'Engine' => 'sqlserver-se', 'EngineVersion' => '14.00.3281.6.v1', 'LicenseModel' => 'license-included', 'MaxAllocatedStorage' => 1000, 'MultiAZ' => 1, 'OptionGroupMemberships' => [ [ 'OptionGroupName' => 'test-se-2017', 'Status' => 'pending-apply', ], ], 'PubliclyAccessible' => 1, 'ReadReplicaDBInstanceIdentifiers' => [ ], 'SecondaryAvailabilityZone' => 'us-west-2c', 'StorageType' => 'gp2', ], // Some output ommitted. ]
ModifyDBParameterGroup
$result = $client->modifyDBParameterGroup
([/* ... */]); $promise = $client->modifyDBParameterGroupAsync
([/* ... */]);
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName
, ParameterValue
, and ApplyMethod
. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify operation before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Parameter Syntax
$result = $client->modifyDBParameterGroup([ 'DBParameterGroupName' => '<string>', // REQUIRED 'Parameters' => [ // REQUIRED [ 'AllowedValues' => '<string>', 'ApplyMethod' => 'immediate|pending-reboot', 'ApplyType' => '<string>', 'DataType' => '<string>', 'Description' => '<string>', 'IsModifiable' => true || false, 'MinimumEngineVersion' => '<string>', 'ParameterName' => '<string>', 'ParameterValue' => '<string>', 'Source' => '<string>', 'SupportedEngineModes' => ['<string>', ...], ], // ... ], ]);
Parameter Details
Members
- DBParameterGroupName
-
- Required: Yes
- Type: string
The name of the DB parameter group.
Constraints:
-
If supplied, must match the name of an existing
DBParameterGroup
.
- Parameters
-
- Required: Yes
- Type: Array of Parameter structures
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method):
immediate | pending-reboot
You can use the
immediate
value with dynamic parameters only. You can use thepending-reboot
value for both dynamic and static parameters.When the application method is
immediate
, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.When the application method is
pending-reboot
, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.You can't use
pending-reboot
with dynamic parameters on RDS for SQL Server DB instances. Useimmediate
.For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
Result Syntax
[ 'DBParameterGroupName' => '<string>', ]
Result Details
Members
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group.
Errors
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- InvalidDBParameterGroupStateFault:
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
Examples
Example 1: To modify a DB parameter group
The following example changes the value of the clr enabled parameter in a DB parameter group. The value of the ApplyMethod parameter causes the DB parameter group to be modified immediately, instead of waiting until the next maintenance window.
$result = $client->modifyDBParameterGroup([ 'DBParameterGroupName' => 'test-sqlserver-se-2017', 'Parameters' => [ [ 'ApplyMethod' => 'immediate', 'ParameterName' => 'clr enabled', 'ParameterValue' => '1', ], ], ]);
Result syntax:
[ 'DBParameterGroupName' => 'test-sqlserver-se-2017', ]
ModifyDBProxy
$result = $client->modifyDBProxy
([/* ... */]); $promise = $client->modifyDBProxyAsync
([/* ... */]);
Changes the settings for an existing DB proxy.
Parameter Syntax
$result = $client->modifyDBProxy([ 'Auth' => [ [ 'AuthScheme' => 'SECRETS', 'ClientPasswordAuthType' => 'MYSQL_NATIVE_PASSWORD|MYSQL_CACHING_SHA2_PASSWORD|POSTGRES_SCRAM_SHA_256|POSTGRES_MD5|SQL_SERVER_AUTHENTICATION', 'Description' => '<string>', 'IAMAuth' => 'DISABLED|REQUIRED|ENABLED', 'SecretArn' => '<string>', 'UserName' => '<string>', ], // ... ], 'DBProxyName' => '<string>', // REQUIRED 'DebugLogging' => true || false, 'IdleClientTimeout' => <integer>, 'NewDBProxyName' => '<string>', 'RequireTLS' => true || false, 'RoleArn' => '<string>', 'SecurityGroups' => ['<string>', ...], ]);
Parameter Details
Members
- Auth
-
- Type: Array of UserAuthConfig structures
The new authentication settings for the
DBProxy
. - DBProxyName
-
- Required: Yes
- Type: string
The identifier for the
DBProxy
to modify. - DebugLogging
-
- Type: boolean
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
- IdleClientTimeout
-
- Type: int
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
- NewDBProxyName
-
- Type: string
The new identifier for the
DBProxy
. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. - RequireTLS
-
- Type: boolean
Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
- SecurityGroups
-
- Type: Array of strings
The new list of security groups for the
DBProxy
.
Result Syntax
[ 'DBProxy' => [ 'Auth' => [ [ 'AuthScheme' => 'SECRETS', 'ClientPasswordAuthType' => 'MYSQL_NATIVE_PASSWORD|MYSQL_CACHING_SHA2_PASSWORD|POSTGRES_SCRAM_SHA_256|POSTGRES_MD5|SQL_SERVER_AUTHENTICATION', 'Description' => '<string>', 'IAMAuth' => 'DISABLED|REQUIRED|ENABLED', 'SecretArn' => '<string>', 'UserName' => '<string>', ], // ... ], 'CreatedDate' => <DateTime>, 'DBProxyArn' => '<string>', 'DBProxyName' => '<string>', 'DebugLogging' => true || false, 'Endpoint' => '<string>', 'EngineFamily' => '<string>', 'IdleClientTimeout' => <integer>, 'RequireTLS' => true || false, 'RoleArn' => '<string>', 'Status' => 'available|modifying|incompatible-network|insufficient-resource-limits|creating|deleting|suspended|suspending|reactivating', 'UpdatedDate' => <DateTime>, 'VpcId' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- DBProxy
-
- Type: DBProxy structure
The
DBProxy
object representing the new settings for the proxy.
Errors
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyAlreadyExistsFault:
The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
ModifyDBProxyEndpoint
$result = $client->modifyDBProxyEndpoint
([/* ... */]); $promise = $client->modifyDBProxyEndpointAsync
([/* ... */]);
Changes the settings for an existing DB proxy endpoint.
Parameter Syntax
$result = $client->modifyDBProxyEndpoint([ 'DBProxyEndpointName' => '<string>', // REQUIRED 'NewDBProxyEndpointName' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- DBProxyEndpointName
-
- Required: Yes
- Type: string
The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
- NewDBProxyEndpointName
-
- Type: string
The new identifier for the
DBProxyEndpoint
. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. - VpcSecurityGroupIds
-
- Type: Array of strings
The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
Result Syntax
[ 'DBProxyEndpoint' => [ 'CreatedDate' => <DateTime>, 'DBProxyEndpointArn' => '<string>', 'DBProxyEndpointName' => '<string>', 'DBProxyName' => '<string>', 'Endpoint' => '<string>', 'IsDefault' => true || false, 'Status' => 'available|modifying|incompatible-network|insufficient-resource-limits|creating|deleting', 'TargetRole' => 'READ_WRITE|READ_ONLY', 'VpcId' => '<string>', 'VpcSecurityGroupIds' => ['<string>', ...], 'VpcSubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- DBProxyEndpoint
-
- Type: DBProxyEndpoint structure
The
DBProxyEndpoint
object representing the new settings for the DB proxy endpoint.
Errors
- DBProxyEndpointNotFoundFault:
The DB proxy endpoint doesn't exist.
- DBProxyEndpointAlreadyExistsFault:
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDBProxyEndpointStateFault:
You can't perform this operation while the DB proxy endpoint is in a particular state.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
ModifyDBProxyTargetGroup
$result = $client->modifyDBProxyTargetGroup
([/* ... */]); $promise = $client->modifyDBProxyTargetGroupAsync
([/* ... */]);
Modifies the properties of a DBProxyTargetGroup
.
Parameter Syntax
$result = $client->modifyDBProxyTargetGroup([ 'ConnectionPoolConfig' => [ 'ConnectionBorrowTimeout' => <integer>, 'InitQuery' => '<string>', 'MaxConnectionsPercent' => <integer>, 'MaxIdleConnectionsPercent' => <integer>, 'SessionPinningFilters' => ['<string>', ...], ], 'DBProxyName' => '<string>', // REQUIRED 'NewName' => '<string>', 'TargetGroupName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConnectionPoolConfig
-
- Type: ConnectionPoolConfiguration structure
The settings that determine the size and behavior of the connection pool for the target group.
- DBProxyName
-
- Required: Yes
- Type: string
The name of the proxy.
- NewName
-
- Type: string
The new name for the modified
DBProxyTarget
. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. - TargetGroupName
-
- Required: Yes
- Type: string
The name of the target group to modify.
Result Syntax
[ 'DBProxyTargetGroup' => [ 'ConnectionPoolConfig' => [ 'ConnectionBorrowTimeout' => <integer>, 'InitQuery' => '<string>', 'MaxConnectionsPercent' => <integer>, 'MaxIdleConnectionsPercent' => <integer>, 'SessionPinningFilters' => ['<string>', ...], ], 'CreatedDate' => <DateTime>, 'DBProxyName' => '<string>', 'IsDefault' => true || false, 'Status' => '<string>', 'TargetGroupArn' => '<string>', 'TargetGroupName' => '<string>', 'UpdatedDate' => <DateTime>, ], ]
Result Details
Members
- DBProxyTargetGroup
-
- Type: DBProxyTargetGroup structure
The settings of the modified
DBProxyTarget
.
Errors
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetGroupNotFoundFault:
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
ModifyDBRecommendation
$result = $client->modifyDBRecommendation
([/* ... */]); $promise = $client->modifyDBRecommendationAsync
([/* ... */]);
Updates the recommendation status and recommended action status for the specified recommendation.
Parameter Syntax
$result = $client->modifyDBRecommendation([ 'Locale' => '<string>', 'RecommendationId' => '<string>', // REQUIRED 'RecommendedActionUpdates' => [ [ 'ActionId' => '<string>', // REQUIRED 'Status' => '<string>', // REQUIRED ], // ... ], 'Status' => '<string>', ]);
Parameter Details
Members
- Locale
-
- Type: string
The language of the modified recommendation.
- RecommendationId
-
- Required: Yes
- Type: string
The identifier of the recommendation to update.
- RecommendedActionUpdates
-
- Type: Array of RecommendedActionUpdate structures
The list of recommended action status to update. You can update multiple recommended actions at one time.
- Status
-
- Type: string
The recommendation status to update.
Valid values:
-
active
-
dismissed
Result Syntax
[ 'DBRecommendation' => [ 'AdditionalInfo' => '<string>', 'Category' => '<string>', 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'Detection' => '<string>', 'Impact' => '<string>', 'IssueDetails' => [ 'PerformanceIssueDetails' => [ 'Analysis' => '<string>', 'EndTime' => <DateTime>, 'Metrics' => [ [ 'MetricQuery' => [ 'PerformanceInsightsMetricQuery' => [ 'GroupBy' => [ 'Dimensions' => ['<string>', ...], 'Group' => '<string>', 'Limit' => <integer>, ], 'Metric' => '<string>', ], ], 'Name' => '<string>', 'References' => [ [ 'Name' => '<string>', 'ReferenceDetails' => [ 'ScalarReferenceDetails' => [ 'Value' => <float>, ], ], ], // ... ], 'StatisticsDetails' => '<string>', ], // ... ], 'StartTime' => <DateTime>, ], ], 'Links' => [ [ 'Text' => '<string>', 'Url' => '<string>', ], // ... ], 'Reason' => '<string>', 'Recommendation' => '<string>', 'RecommendationId' => '<string>', 'RecommendedActions' => [ [ 'ActionId' => '<string>', 'ApplyModes' => ['<string>', ...], 'ContextAttributes' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Description' => '<string>', 'IssueDetails' => [ 'PerformanceIssueDetails' => [ 'Analysis' => '<string>', 'EndTime' => <DateTime>, 'Metrics' => [ [ 'MetricQuery' => [ 'PerformanceInsightsMetricQuery' => [ 'GroupBy' => [ 'Dimensions' => ['<string>', ...], 'Group' => '<string>', 'Limit' => <integer>, ], 'Metric' => '<string>', ], ], 'Name' => '<string>', 'References' => [ [ 'Name' => '<string>', 'ReferenceDetails' => [ 'ScalarReferenceDetails' => [ 'Value' => <float>, ], ], ], // ... ], 'StatisticsDetails' => '<string>', ], // ... ], 'StartTime' => <DateTime>, ], ], 'Operation' => '<string>', 'Parameters' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Status' => '<string>', 'Title' => '<string>', ], // ... ], 'ResourceArn' => '<string>', 'Severity' => '<string>', 'Source' => '<string>', 'Status' => '<string>', 'TypeDetection' => '<string>', 'TypeId' => '<string>', 'TypeRecommendation' => '<string>', 'UpdatedTime' => <DateTime>, ], ]
Result Details
Members
- DBRecommendation
-
- Type: DBRecommendation structure
The recommendation for your DB instances, DB clusters, and DB parameter groups.
Errors
There are no errors described for this operation.
ModifyDBShardGroup
$result = $client->modifyDBShardGroup
([/* ... */]); $promise = $client->modifyDBShardGroupAsync
([/* ... */]);
Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
Parameter Syntax
$result = $client->modifyDBShardGroup([ 'ComputeRedundancy' => <integer>, 'DBShardGroupIdentifier' => '<string>', // REQUIRED 'MaxACU' => <float>, 'MinACU' => <float>, ]);
Parameter Details
Members
- ComputeRedundancy
-
- Type: int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:
-
0 - Creates a DB shard group without a standby DB shard group. This is the default value.
-
1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
-
2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
- DBShardGroupIdentifier
-
- Required: Yes
- Type: string
The name of the DB shard group to modify.
- MaxACU
-
- Type: double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
- MinACU
-
- Type: double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
Result Syntax
[ 'ComputeRedundancy' => <integer>, 'DBClusterIdentifier' => '<string>', 'DBShardGroupArn' => '<string>', 'DBShardGroupIdentifier' => '<string>', 'DBShardGroupResourceId' => '<string>', 'Endpoint' => '<string>', 'MaxACU' => <float>, 'MinACU' => <float>, 'PubliclyAccessible' => true || false, 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- ComputeRedundancy
-
- Type: int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:
-
0 - Creates a DB shard group without a standby DB shard group. This is the default value.
-
1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
-
2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
- DBClusterIdentifier
-
- Type: string
The name of the primary DB cluster for the DB shard group.
- DBShardGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB shard group.
- DBShardGroupIdentifier
-
- Type: string
The name of the DB shard group.
- DBShardGroupResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
- Endpoint
-
- Type: string
The connection endpoint for the DB shard group.
- MaxACU
-
- Type: double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
- MinACU
-
- Type: double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
- PubliclyAccessible
-
- Type: boolean
Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
- Status
-
- Type: string
The status of the DB shard group.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Errors
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBShardGroupAlreadyExistsFault:
The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
- DBShardGroupNotFoundFault:
The specified DB shard group name wasn't found.
ModifyDBSnapshot
$result = $client->modifyDBSnapshot
([/* ... */]); $promise = $client->modifyDBSnapshotAsync
([/* ... */]);
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.
Parameter Syntax
$result = $client->modifyDBSnapshot([ 'DBSnapshotIdentifier' => '<string>', // REQUIRED 'EngineVersion' => '<string>', 'OptionGroupName' => '<string>', ]);
Parameter Details
Members
- DBSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB snapshot to modify.
- EngineVersion
-
- Type: string
The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.
Oracle
-
19.0.0.0.ru-2022-01.rur-2022-01.r1
(supported for 12.2.0.1 DB snapshots) -
19.0.0.0.ru-2022-07.rur-2022-07.r1
(supported for 12.1.0.2 DB snapshots) -
12.1.0.2.v8
(supported for 12.1.0.1 DB snapshots) -
11.2.0.4.v12
(supported for 11.2.0.2 DB snapshots) -
11.2.0.4.v11
(supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.
- OptionGroupName
-
- Type: string
The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
Result Syntax
[ 'DBSnapshot' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSnapshotArn' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DBSystemId' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'OriginalSnapshotCreateTime' => <DateTime>, 'PercentProgress' => <integer>, 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'SnapshotCreateTime' => <DateTime>, 'SnapshotDatabaseTime' => <DateTime>, 'SnapshotTarget' => '<string>', 'SnapshotType' => '<string>', 'SourceDBSnapshotIdentifier' => '<string>', 'SourceRegion' => '<string>', 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSnapshot
-
- Type: DBSnapshot structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
Errors
- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.
Examples
Example 1: To modify a DB snapshot
The following example upgrades a PostgeSQL 10.6 snapshot named db5-snapshot-upg-test to PostgreSQL 11.7. The new DB engine version is shown after the snapshot has finished upgrading and its status is available.
$result = $client->modifyDBSnapshot([ 'DBSnapshotIdentifier' => 'db5-snapshot-upg-test', 'EngineVersion' => '11.7', ]);
Result syntax:
[ 'DBSnapshot' => [ 'AllocatedStorage' => 20, 'AvailabilityZone' => 'us-west-2a', 'DBInstanceIdentifier' => 'database-5', 'DBSnapshotArn' => 'arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test', 'DBSnapshotIdentifier' => 'db5-snapshot-upg-test', 'DbiResourceId' => 'db-GJMF75LM42IL6BTFRE4UZJ5YM4', 'Encrypted' => , 'Engine' => 'postgres', 'EngineVersion' => '10.6', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'LicenseModel' => 'postgresql-license', 'MasterUsername' => 'postgres', 'OptionGroupName' => 'default:postgres-11', 'PercentProgress' => 100, 'Port' => 5432, 'ProcessorFeatures' => [ ], 'SnapshotCreateTime' => , 'SnapshotType' => 'manual', 'Status' => 'upgrading', 'StorageType' => 'gp2', 'VpcId' => 'vpc-2ff27557', ], ]
ModifyDBSnapshotAttribute
$result = $client->modifyDBSnapshotAttribute
([/* ... */]); $promise = $client->modifyDBSnapshotAttributeAsync
([/* ... */]);
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify restore
as the AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all
to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
Don't add the all
value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd
parameter. You can't use all
as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore
attribute.
Parameter Syntax
$result = $client->modifyDBSnapshotAttribute([ 'AttributeName' => '<string>', // REQUIRED 'DBSnapshotIdentifier' => '<string>', // REQUIRED 'ValuesToAdd' => ['<string>', ...], 'ValuesToRemove' => ['<string>', ...], ]);
Parameter Details
Members
- AttributeName
-
- Required: Yes
- Type: string
The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to
restore
.To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
- DBSnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier for the DB snapshot to modify the attributes for.
- ValuesToAdd
-
- Type: Array of strings
A list of DB snapshot attributes to add to the attribute specified by
AttributeName
.To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or
all
to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add theall
value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts. - ValuesToRemove
-
- Type: Array of strings
A list of DB snapshot attributes to remove from the attribute specified by
AttributeName
.To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or
all
to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specifyall
, an Amazon Web Services account whose account ID is explicitly added to therestore
attribute can still copy or restore the manual DB snapshot.
Result Syntax
[ 'DBSnapshotAttributesResult' => [ 'DBSnapshotAttributes' => [ [ 'AttributeName' => '<string>', 'AttributeValues' => ['<string>', ...], ], // ... ], 'DBSnapshotIdentifier' => '<string>', ], ]
Result Details
Members
- DBSnapshotAttributesResult
-
- Type: DBSnapshotAttributesResult structure
Contains the results of a successful call to the
DescribeDBSnapshotAttributes
API action.Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the
ModifyDBSnapshotAttribute
API action.
Errors
- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.- InvalidDBSnapshotStateFault:
The state of the DB snapshot doesn't allow deletion.
- SharedSnapshotQuotaExceededFault:
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
Examples
Example 1: To allow two AWS accounts to restore a DB snapshot
The following example grants permission to two AWS accounts, with the identifiers 111122223333 and 444455556666, to restore the DB snapshot named mydbsnapshot.
$result = $client->modifyDBSnapshotAttribute([ 'AttributeName' => 'restore', 'DBSnapshotIdentifier' => 'mydbsnapshot', 'ValuesToAdd' => [ '111122223333', '444455556666', ], ]);
Result syntax:
[ 'DBSnapshotAttributesResult' => [ 'DBSnapshotAttributes' => [ [ 'AttributeName' => 'restore', 'AttributeValues' => [ '111122223333', '444455556666', ], ], ], 'DBSnapshotIdentifier' => 'mydbsnapshot', ], ]
Example 2: To prevent an AWS account from restoring a DB snapshot
The following example removes permission from the AWS account with the identifier 444455556666 to restore the DB snapshot named mydbsnapshot.
$result = $client->modifyDBSnapshotAttribute([ 'AttributeName' => 'restore', 'DBSnapshotIdentifier' => 'mydbsnapshot', 'ValuesToRemove' => [ '444455556666', ], ]);
Result syntax:
[ 'DBSnapshotAttributesResult' => [ 'DBSnapshotAttributes' => [ [ 'AttributeName' => 'restore', 'AttributeValues' => [ '111122223333', ], ], ], 'DBSnapshotIdentifier' => 'mydbsnapshot', ], ]
ModifyDBSubnetGroup
$result = $client->modifyDBSubnetGroup
([/* ... */]); $promise = $client->modifyDBSubnetGroupAsync
([/* ... */]);
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
Parameter Syntax
$result = $client->modifyDBSubnetGroup([ 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', // REQUIRED 'SubnetIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- DBSubnetGroupDescription
-
- Type: string
The description for the DB subnet group.
- DBSubnetGroupName
-
- Required: Yes
- Type: string
The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example:
mydbsubnetgroup
- SubnetIds
-
- Required: Yes
- Type: Array of strings
The EC2 subnet IDs for the DB subnet group.
Result Syntax
[ 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSubnetGroup
-
- Type: DBSubnetGroup structure
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the
DescribeDBSubnetGroups
action.
Errors
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- DBSubnetQuotaExceededFault:
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
- SubnetAlreadyInUse:
The DB subnet is already in use in the Availability Zone.
- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
Examples
Example 1: To modify a DB subnet group
The following example adds a subnet with the ID subnet-08e41f9e230222222 to the DB subnet group named mysubnetgroup. To keep the existing subnets in the subnet group, include their IDs as values in the --subnet-ids option. Make sure to have subnets with at least two different Availability Zones in the DB subnet group.
$result = $client->modifyDBSubnetGroup([ 'DBSubnetGroupDescription' => '', 'DBSubnetGroupName' => 'mysubnetgroup', 'SubnetIds' => [ 'subnet-0a1dc4e1a6f123456', 'subnet-070dd7ecb3aaaaaaa', 'subnet-00f5b198bc0abcdef', 'subnet-08e41f9e230222222', ], ]);
Result syntax:
[ 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => 'arn:aws:rds:us-west-2:123456789012:subgrp:mysubnetgroup', 'DBSubnetGroupDescription' => 'test DB subnet group', 'DBSubnetGroupName' => 'mysubnetgroup', 'SubnetGroupStatus' => 'Complete', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2a', ], 'SubnetIdentifier' => 'subnet-08e41f9e230222222', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2b', ], 'SubnetIdentifier' => 'subnet-070dd7ecb3aaaaaaa', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2d', ], 'SubnetIdentifier' => 'subnet-00f5b198bc0abcdef', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2b', ], 'SubnetIdentifier' => 'subnet-0a1dc4e1a6f123456', 'SubnetStatus' => 'Active', ], ], 'VpcId' => 'vpc-0f08e7610a1b2c3d4', ], ]
ModifyEventSubscription
$result = $client->modifyEventSubscription
([/* ... */]); $promise = $client->modifyEventSubscriptionAsync
([/* ... */]);
Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription
and RemoveSourceIdentifierFromSubscription
calls.
You can see a list of the event categories for a given source type (SourceType
) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories
operation.
Parameter Syntax
$result = $client->modifyEventSubscription([ 'Enabled' => true || false, 'EventCategories' => ['<string>', ...], 'SnsTopicArn' => '<string>', 'SourceType' => '<string>', 'SubscriptionName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Enabled
-
- Type: boolean
Specifies whether to activate the subscription.
- EventCategories
-
- Type: Array of strings
A list of event categories for a source type (
SourceType
) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using theDescribeEventCategories
operation. - SnsTopicArn
-
- Type: string
The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
- SourceType
-
- Type: string
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify
db-proxy
. If this value isn't specified, all events are returned.Valid Values:
db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
- SubscriptionName
-
- Required: Yes
- Type: string
The name of the RDS event notification subscription.
Result Syntax
[ 'EventSubscription' => [ 'CustSubscriptionId' => '<string>', 'CustomerAwsId' => '<string>', 'Enabled' => true || false, 'EventCategoriesList' => ['<string>', ...], 'EventSubscriptionArn' => '<string>', 'SnsTopicArn' => '<string>', 'SourceIdsList' => ['<string>', ...], 'SourceType' => '<string>', 'Status' => '<string>', 'SubscriptionCreationTime' => '<string>', ], ]
Result Details
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
Errors
- EventSubscriptionQuotaExceededFault:
You have reached the maximum number of event subscriptions.
- SubscriptionNotFoundFault:
The subscription name does not exist.
- SNSInvalidTopicFault:
SNS has responded that there is a problem with the SNS topic specified.
- SNSNoAuthorizationFault:
You do not have permission to publish to the SNS topic ARN.
- SNSTopicArnNotFoundFault:
The SNS topic ARN does not exist.
- SubscriptionCategoryNotFoundFault:
The supplied category does not exist.
Examples
Example 1: To modify an event subscription
The following example turns off the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic.
$result = $client->modifyEventSubscription([ 'Enabled' => , 'SubscriptionName' => 'my-instance-events', ]);
Result syntax:
[ 'EventSubscription' => [ 'CustSubscriptionId' => 'my-instance-events', 'CustomerAwsId' => '123456789012', 'Enabled' => , 'EventCategoriesList' => [ 'backup', 'recovery', ], 'EventSubscriptionArn' => 'arn:aws:rds:us-east-1:123456789012:es:my-instance-events', 'SnsTopicArn' => 'arn:aws:sns:us-east-1:123456789012:interesting-events', 'SourceType' => 'db-instance', 'Status' => 'modifying', 'SubscriptionCreationTime' => 'Tue Jul 31 23:22:01 UTC 2018', ], ]
ModifyGlobalCluster
$result = $client->modifyGlobalCluster
([/* ... */]); $promise = $client->modifyGlobalClusterAsync
([/* ... */]);
Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora global database clusters.
Parameter Syntax
$result = $client->modifyGlobalCluster([ 'AllowMajorVersionUpgrade' => true || false, 'DeletionProtection' => true || false, 'EngineVersion' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'NewGlobalClusterIdentifier' => '<string>', ]);
Parameter Details
Members
- AllowMajorVersionUpgrade
-
- Type: boolean
Specifies whether to allow major version upgrades.
Constraints: Must be enabled if you specify a value for the
EngineVersion
parameter that's a different major version than the global cluster's current version.If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
- DeletionProtection
-
- Type: boolean
Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.
- EngineVersion
-
- Type: string
The version number of the database engine to which you want to upgrade.
To list all of the available engine versions for
aurora-mysql
(for MySQL-based Aurora global databases), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for
aurora-postgresql
(for PostgreSQL-based Aurora global databases), use the following command:aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
- GlobalClusterIdentifier
-
- Type: string
The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing global database cluster.
- NewGlobalClusterIdentifier
-
- Type: string
The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster2
Result Syntax
[ 'GlobalCluster' => [ 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'FailoverState' => [ 'FromDbClusterArn' => '<string>', 'IsDataLossAllowed' => true || false, 'Status' => 'pending|failing-over|cancelling', 'ToDbClusterArn' => '<string>', ], 'GlobalClusterArn' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'GlobalClusterMembers' => [ [ 'DBClusterArn' => '<string>', 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'IsWriter' => true || false, 'Readers' => ['<string>', ...], 'SynchronizationStatus' => 'connected|pending-resync', ], // ... ], 'GlobalClusterResourceId' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
Errors
- GlobalClusterNotFoundFault:
The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster.- GlobalClusterAlreadyExistsFault:
The
GlobalClusterIdentifier
already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.- InvalidGlobalClusterStateFault:
The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To modify a global database cluster
The following example enables deletion protection for an Aurora MySQL-based global database cluster.
$result = $client->modifyGlobalCluster([ 'DeletionProtection' => 1, 'GlobalClusterIdentifier' => 'myglobalcluster', ]);
Result syntax:
[ 'GlobalCluster' => [ 'DeletionProtection' => 1, 'Engine' => 'aurora-mysql', 'EngineVersion' => '5.7.mysql_aurora.2.07.2', 'GlobalClusterArn' => 'arn:aws:rds::123456789012:global-cluster:myglobalcluster', 'GlobalClusterIdentifier' => 'myglobalcluster', 'GlobalClusterMembers' => [ ], 'GlobalClusterResourceId' => 'cluster-f0e523bfe07aabb', 'Status' => 'available', 'StorageEncrypted' => , ], ]
ModifyIntegration
$result = $client->modifyIntegration
([/* ... */]); $promise = $client->modifyIntegrationAsync
([/* ... */]);
Modifies a zero-ETL integration with Amazon Redshift.
Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.
Parameter Syntax
$result = $client->modifyIntegration([ 'DataFilter' => '<string>', 'Description' => '<string>', 'IntegrationIdentifier' => '<string>', // REQUIRED 'IntegrationName' => '<string>', ]);
Parameter Details
Members
- DataFilter
-
- Type: string
A new data filter for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.
- Description
-
- Type: string
A new description for the integration.
- IntegrationIdentifier
-
- Required: Yes
- Type: string
The unique identifier of the integration to modify.
- IntegrationName
-
- Type: string
A new name for the integration.
Result Syntax
[ 'AdditionalEncryptionContext' => ['<string>', ...], 'CreateTime' => <DateTime>, 'DataFilter' => '<string>', 'Description' => '<string>', 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', ], // ... ], 'IntegrationArn' => '<string>', 'IntegrationName' => '<string>', 'KMSKeyId' => '<string>', 'SourceArn' => '<string>', 'Status' => 'creating|active|modifying|failed|deleting|syncing|needs_attention', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetArn' => '<string>', ]
Result Details
Members
- AdditionalEncryptionContext
-
- Type: Associative array of custom strings keys (String) to strings
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the integration was created, in Universal Coordinated Time (UTC).
- DataFilter
-
- Type: string
Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
- Description
-
- Type: string
A description of the integration.
- Errors
-
- Type: Array of IntegrationError structures
Any errors associated with the integration.
- IntegrationArn
-
- Type: string
The ARN of the integration.
- IntegrationName
-
- Type: string
The name of the integration.
- KMSKeyId
-
- Type: string
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the database used as the source for replication.
- Status
-
- Type: string
The current status of the integration.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetArn
-
- Type: string
The ARN of the Redshift data warehouse used as the target for replication.
Errors
- IntegrationNotFoundFault:
The specified integration could not be found.
- InvalidIntegrationStateFault:
The integration is in an invalid state and can't perform the requested operation.
- IntegrationConflictOperationFault:
A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
Examples
Example 1: To modify a zero-ETL integration
The following example modifies the name of an existing zero-ETL integration.
$result = $client->modifyIntegration([ 'IntegrationIdentifier' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111', 'IntegrationName' => 'my-renamed-integration', ]);
Result syntax:
[ 'CreateTime' =>, 'DataFilter' => 'include: *.*', 'IntegrationArn' => 'arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231', 'IntegrationName' => 'my-renamed-integration', 'KMSKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa', 'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-cluster', 'Status' => 'active', 'Tags' => [ ], 'TargetArn' => 'arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8', ]
ModifyOptionGroup
$result = $client->modifyOptionGroup
([/* ... */]); $promise = $client->modifyOptionGroupAsync
([/* ... */]);
Modifies an existing option group.
Parameter Syntax
$result = $client->modifyOptionGroup([ 'ApplyImmediately' => true || false, 'OptionGroupName' => '<string>', // REQUIRED 'OptionsToInclude' => [ [ 'DBSecurityGroupMemberships' => ['<string>', ...], 'OptionName' => '<string>', // REQUIRED 'OptionSettings' => [ [ 'AllowedValues' => '<string>', 'ApplyType' => '<string>', 'DataType' => '<string>', 'DefaultValue' => '<string>', 'Description' => '<string>', 'IsCollection' => true || false, 'IsModifiable' => true || false, 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'OptionVersion' => '<string>', 'Port' => <integer>, 'VpcSecurityGroupMemberships' => ['<string>', ...], ], // ... ], 'OptionsToRemove' => ['<string>', ...], ]);
Parameter Details
Members
- ApplyImmediately
-
- Type: boolean
Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
- OptionGroupName
-
- Required: Yes
- Type: string
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
- OptionsToInclude
-
- Type: Array of OptionConfiguration structures
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
- OptionsToRemove
-
- Type: Array of strings
Options in this list are removed from the option group.
Result Syntax
[ 'OptionGroup' => [ 'AllowsVpcAndNonVpcInstanceMemberships' => true || false, 'CopyTimestamp' => <DateTime>, 'EngineName' => '<string>', 'MajorEngineVersion' => '<string>', 'OptionGroupArn' => '<string>', 'OptionGroupDescription' => '<string>', 'OptionGroupName' => '<string>', 'Options' => [ [ 'DBSecurityGroupMemberships' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'OptionDescription' => '<string>', 'OptionName' => '<string>', 'OptionSettings' => [ [ 'AllowedValues' => '<string>', 'ApplyType' => '<string>', 'DataType' => '<string>', 'DefaultValue' => '<string>', 'Description' => '<string>', 'IsCollection' => true || false, 'IsModifiable' => true || false, 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'OptionVersion' => '<string>', 'Permanent' => true || false, 'Persistent' => true || false, 'Port' => <integer>, 'VpcSecurityGroupMemberships' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], // ... ], 'SourceAccountId' => '<string>', 'SourceOptionGroup' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- OptionGroup
-
- Type: OptionGroup structure
Errors
- InvalidOptionGroupStateFault:
The option group isn't in the available state.
- OptionGroupNotFoundFault:
The specified option group could not be found.
Examples
Example 1: To modify an option group
The following example adds an option to an option group.
$result = $client->modifyOptionGroup([ 'ApplyImmediately' => 1, 'OptionGroupName' => 'myawsuser-og02', 'OptionsToInclude' => [ [ 'DBSecurityGroupMemberships' => [ 'default', ], 'OptionName' => 'MEMCACHED', ], ], ]);
Result syntax:
[ 'OptionGroup' => [ ], ]
ModifyTenantDatabase
$result = $client->modifyTenantDatabase
([/* ... */]); $promise = $client->modifyTenantDatabaseAsync
([/* ... */]);
Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
Parameter Syntax
$result = $client->modifyTenantDatabase([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'MasterUserPassword' => '<string>', 'NewTenantDBName' => '<string>', 'TenantDBName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DB instance.
- MasterUserPassword
-
- Type: string
The new password for the master user of the specified tenant database in your DB instance.
Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
Constraints:
-
Can include any printable ASCII character except
/
,"
(double quote),@
,&
(ampersand), and'
(single quote).
Length constraints:
-
Must contain between 8 and 30 characters.
- NewTenantDBName
-
- Type: string
The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.
Constraints:
-
Can't be the string null or any other reserved word.
-
Can't be longer than 8 characters.
- TenantDBName
-
- Required: Yes
- Type: string
The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing tenant database.
Result Syntax
[ 'TenantDatabase' => [ 'CharacterSetName' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'DeletionProtection' => true || false, 'MasterUsername' => '<string>', 'NcharCharacterSetName' => '<string>', 'PendingModifiedValues' => [ 'MasterUserPassword' => '<string>', 'TenantDBName' => '<string>', ], 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TenantDBName' => '<string>', 'TenantDatabaseARN' => '<string>', 'TenantDatabaseCreateTime' => <DateTime>, 'TenantDatabaseResourceId' => '<string>', ], ]
Result Details
Members
- TenantDatabase
-
- Type: TenantDatabase structure
A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- TenantDatabaseNotFoundFault:
The specified tenant database wasn't found in the DB instance.
- TenantDatabaseAlreadyExistsFault:
You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
PromoteReadReplica
$result = $client->promoteReadReplica
([/* ... */]); $promise = $client->promoteReadReplicaAsync
([/* ... */]);
Promotes a read replica DB instance to a standalone DB instance.
-
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the
backing-up
status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. -
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
Parameter Syntax
$result = $client->promoteReadReplica([ 'BackupRetentionPeriod' => <integer>, 'DBInstanceIdentifier' => '<string>', // REQUIRED 'PreferredBackupWindow' => '<string>', ]);
Parameter Details
Members
- BackupRetentionPeriod
-
- Type: int
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
-
Must be a value from 0 to 35.
-
Can't be set to 0 if the DB instance is a source to read replicas.
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing read replica DB instance.
Example:
mydbinstance
- PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.
Examples
Example 1: To promote a read replica
The following example promotes the specified read replica to become a standalone DB instance.
$result = $client->promoteReadReplica([ 'DBInstanceIdentifier' => 'test-instance-repl', ]);
Result syntax:
[ 'DBInstance' => [ 'DBInstanceArn' => 'arn:aws:rds:us-east-1:123456789012:db:test-instance-repl', 'DBInstanceStatus' => 'modifying', 'ReadReplicaSourceDBInstanceIdentifier' => 'test-instance', 'StorageType' => 'standard', ], // Some output ommitted. ]
PromoteReadReplicaDBCluster
$result = $client->promoteReadReplicaDBCluster
([/* ... */]); $promise = $client->promoteReadReplicaDBClusterAsync
([/* ... */]);
Promotes a read replica DB cluster to a standalone DB cluster.
Parameter Syntax
$result = $client->promoteReadReplicaDBCluster([ 'DBClusterIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DB cluster read replica.
Example:
my-cluster-replica1
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
PurchaseReservedDBInstancesOffering
$result = $client->purchaseReservedDBInstancesOffering
([/* ... */]); $promise = $client->purchaseReservedDBInstancesOfferingAsync
([/* ... */]);
Purchases a reserved DB instance offering.
Parameter Syntax
$result = $client->purchaseReservedDBInstancesOffering([ 'DBInstanceCount' => <integer>, 'ReservedDBInstanceId' => '<string>', 'ReservedDBInstancesOfferingId' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- DBInstanceCount
-
- Type: int
The number of instances to reserve.
Default:
1
- ReservedDBInstanceId
-
- Type: string
Customer-specified identifier to track this reservation.
Example: myreservationID
- ReservedDBInstancesOfferingId
-
- Required: Yes
- Type: string
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Result Syntax
[ 'ReservedDBInstance' => [ 'CurrencyCode' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceCount' => <integer>, 'Duration' => <integer>, 'FixedPrice' => <float>, 'LeaseId' => '<string>', 'MultiAZ' => true || false, 'OfferingType' => '<string>', 'ProductDescription' => '<string>', 'RecurringCharges' => [ [ 'RecurringChargeAmount' => <float>, 'RecurringChargeFrequency' => '<string>', ], // ... ], 'ReservedDBInstanceArn' => '<string>', 'ReservedDBInstanceId' => '<string>', 'ReservedDBInstancesOfferingId' => '<string>', 'StartTime' => <DateTime>, 'State' => '<string>', 'UsagePrice' => <float>, ], ]
Result Details
Members
- ReservedDBInstance
-
- Type: ReservedDBInstance structure
This data type is used as a response element in the
DescribeReservedDBInstances
andPurchaseReservedDBInstancesOffering
actions.
Errors
- ReservedDBInstancesOfferingNotFoundFault:
Specified offering does not exist.
- ReservedDBInstanceAlreadyExistsFault:
User already has a reservation with the given identifier.
- ReservedDBInstanceQuotaExceededFault:
Request would exceed the user's DB Instance quota.
Examples
Example 1: To purchase a reserved DB instance
The following example shows how to buy the reserved DB instance offering from the previous example.
$result = $client->purchaseReservedDBInstancesOffering([ 'ReservedDBInstanceId' => '8ba30be1-b9ec-447f-8f23-6114e3f4c7b4', 'ReservedDBInstancesOfferingId' => '', ]);
Result syntax:
[ 'ReservedDBInstance' => [ 'CurrencyCode' => 'USD', 'DBInstanceClass' => 'db.t2.micro', 'DBInstanceCount' => 1, 'Duration' => 31536000, 'FixedPrice' => 51, 'MultiAZ' => , 'OfferingType' => 'Partial Upfront', 'ProductDescription' => 'mysql', 'RecurringCharges' => [ [ 'RecurringChargeAmount' => 0.006, 'RecurringChargeFrequency' => 'Hourly', ], ], 'ReservedDBInstanceArn' => 'arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670', 'ReservedDBInstanceId' => 'ri-2020-06-29-16-54-57-670', 'ReservedDBInstancesOfferingId' => '8ba30be1-b9ec-447f-8f23-6114e3f4c7b4', 'StartTime' =>, 'State' => 'payment-pending', 'UsagePrice' => 0, ], ]
RebootDBCluster
$result = $client->rebootDBCluster
([/* ... */]); $promise = $client->rebootDBClusterAsync
([/* ... */]);
You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->rebootDBCluster([ 'DBClusterIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DBCluster.
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
RebootDBInstance
$result = $client->rebootDBInstance
([/* ... */]); $promise = $client->rebootDBInstanceAsync
([/* ... */]);
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster
operation.
Parameter Syntax
$result = $client->rebootDBInstance([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'ForceFailover' => true || false, ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DBInstance.
- ForceFailover
-
- Type: boolean
Specifies whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.
Examples
Example 1: To reboot a DB instance
The following example starts a reboot of the specified DB instance.
$result = $client->rebootDBInstance([ 'DBInstanceIdentifier' => 'test-mysql-instance', ]);
Result syntax:
[ 'DBInstance' => [ 'DBInstanceClass' => 'db.t3.micro', 'DBInstanceIdentifier' => 'test-mysql-instance', 'DBInstanceStatus' => 'rebooting', 'Endpoint' => [ 'Address' => 'test-mysql-instance.############.us-west-2.rds.amazonaws.com', 'HostedZoneId' => 'Z1PVIF0EXAMPLE', 'Port' => 3306, ], 'Engine' => 'mysql', 'MasterUsername' => 'admin', ], // Some output ommitted. ]
RebootDBShardGroup
$result = $client->rebootDBShardGroup
([/* ... */]); $promise = $client->rebootDBShardGroupAsync
([/* ... */]);
You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect.
This operation applies only to Aurora Limitless Database DBb shard groups.
Parameter Syntax
$result = $client->rebootDBShardGroup([ 'DBShardGroupIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBShardGroupIdentifier
-
- Required: Yes
- Type: string
The name of the DB shard group to reboot.
Result Syntax
[ 'ComputeRedundancy' => <integer>, 'DBClusterIdentifier' => '<string>', 'DBShardGroupArn' => '<string>', 'DBShardGroupIdentifier' => '<string>', 'DBShardGroupResourceId' => '<string>', 'Endpoint' => '<string>', 'MaxACU' => <float>, 'MinACU' => <float>, 'PubliclyAccessible' => true || false, 'Status' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- ComputeRedundancy
-
- Type: int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:
-
0 - Creates a DB shard group without a standby DB shard group. This is the default value.
-
1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
-
2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
- DBClusterIdentifier
-
- Type: string
The name of the primary DB cluster for the DB shard group.
- DBShardGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB shard group.
- DBShardGroupIdentifier
-
- Type: string
The name of the DB shard group.
- DBShardGroupResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
- Endpoint
-
- Type: string
The connection endpoint for the DB shard group.
- MaxACU
-
- Type: double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
- MinACU
-
- Type: double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
- PubliclyAccessible
-
- Type: boolean
Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
- Status
-
- Type: string
The status of the DB shard group.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Errors
- DBShardGroupNotFoundFault:
The specified DB shard group name wasn't found.
- InvalidDBShardGroupStateFault:
The DB shard group must be in the available state.
RegisterDBProxyTargets
$result = $client->registerDBProxyTargets
([/* ... */]); $promise = $client->registerDBProxyTargetsAsync
([/* ... */]);
Associate one or more DBProxyTarget
data structures with a DBProxyTargetGroup
.
Parameter Syntax
$result = $client->registerDBProxyTargets([ 'DBClusterIdentifiers' => ['<string>', ...], 'DBInstanceIdentifiers' => ['<string>', ...], 'DBProxyName' => '<string>', // REQUIRED 'TargetGroupName' => '<string>', ]);
Parameter Details
Members
- DBClusterIdentifiers
-
- Type: Array of strings
One or more DB cluster identifiers.
- DBInstanceIdentifiers
-
- Type: Array of strings
One or more DB instance identifiers.
- DBProxyName
-
- Required: Yes
- Type: string
The identifier of the
DBProxy
that is associated with theDBProxyTargetGroup
. - TargetGroupName
-
- Type: string
The identifier of the
DBProxyTargetGroup
.
Result Syntax
[ 'DBProxyTargets' => [ [ 'Endpoint' => '<string>', 'Port' => <integer>, 'RdsResourceId' => '<string>', 'Role' => 'READ_WRITE|READ_ONLY|UNKNOWN', 'TargetArn' => '<string>', 'TargetHealth' => [ 'Description' => '<string>', 'Reason' => 'UNREACHABLE|CONNECTION_FAILED|AUTH_FAILURE|PENDING_PROXY_CAPACITY|INVALID_REPLICATION_STATE', 'State' => 'REGISTERING|AVAILABLE|UNAVAILABLE', ], 'TrackedClusterId' => '<string>', 'Type' => 'RDS_INSTANCE|RDS_SERVERLESS_ENDPOINT|TRACKED_CLUSTER', ], // ... ], ]
Result Details
Members
- DBProxyTargets
-
- Type: Array of DBProxyTarget structures
One or more
DBProxyTarget
objects that are created when you register targets with a target group.
Errors
- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetGroupNotFoundFault:
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBProxyTargetAlreadyRegisteredFault:
The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBProxyStateFault:
The requested operation can't be performed while the proxy is in this state.
- InsufficientAvailableIPsInSubnetFault:
The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.
RemoveFromGlobalCluster
$result = $client->removeFromGlobalCluster
([/* ... */]); $promise = $client->removeFromGlobalClusterAsync
([/* ... */]);
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This operation only applies to Aurora DB clusters.
Parameter Syntax
$result = $client->removeFromGlobalCluster([ 'DbClusterIdentifier' => '<string>', 'GlobalClusterIdentifier' => '<string>', ]);
Parameter Details
Members
- DbClusterIdentifier
-
- Type: string
The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
- GlobalClusterIdentifier
-
- Type: string
The cluster identifier to detach from the Aurora global database cluster.
Result Syntax
[ 'GlobalCluster' => [ 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'FailoverState' => [ 'FromDbClusterArn' => '<string>', 'IsDataLossAllowed' => true || false, 'Status' => 'pending|failing-over|cancelling', 'ToDbClusterArn' => '<string>', ], 'GlobalClusterArn' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'GlobalClusterMembers' => [ [ 'DBClusterArn' => '<string>', 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'IsWriter' => true || false, 'Readers' => ['<string>', ...], 'SynchronizationStatus' => 'connected|pending-resync', ], // ... ], 'GlobalClusterResourceId' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
Errors
- GlobalClusterNotFoundFault:
The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster.- InvalidGlobalClusterStateFault:
The global cluster is in an invalid state and can't perform the requested operation.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.
Examples
Example 1: To detach an Aurora secondary cluster from an Aurora global database cluster
The following example detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster changes from being read-only to a standalone cluster with read-write capability.
$result = $client->removeFromGlobalCluster([ 'DbClusterIdentifier' => 'arn:aws:rds:us-west-2:123456789012:cluster:DB-1', 'GlobalClusterIdentifier' => 'myglobalcluster', ]);
Result syntax:
[ 'GlobalCluster' => [ 'DeletionProtection' => , 'Engine' => 'aurora-postgresql', 'EngineVersion' => '10.11', 'GlobalClusterArn' => 'arn:aws:rds::123456789012:global-cluster:myglobalcluster', 'GlobalClusterIdentifier' => 'myglobalcluster', 'GlobalClusterMembers' => [ [ 'DBClusterArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster', 'IsWriter' => 1, 'Readers' => [ 'arn:aws:rds:us-west-2:123456789012:cluster:DB-1', ], ], [ 'DBClusterArn' => 'arn:aws:rds:us-west-2:123456789012:cluster:DB-1', 'GlobalWriteForwardingStatus' => 'disabled', 'IsWriter' => , 'Readers' => [ ], ], ], 'GlobalClusterResourceId' => 'cluster-abc123def456gh', 'Status' => 'available', 'StorageEncrypted' => 1, ], ]
RemoveRoleFromDBCluster
$result = $client->removeRoleFromDBCluster
([/* ... */]); $promise = $client->removeRoleFromDBClusterAsync
([/* ... */]);
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->removeRoleFromDBCluster([ 'DBClusterIdentifier' => '<string>', // REQUIRED 'FeatureName' => '<string>', 'RoleArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The name of the DB cluster to disassociate the IAM role from.
- FeatureName
-
- Type: string
The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole
.
Result Syntax
[]
Result Details
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBClusterRoleNotFoundFault:
The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
Examples
Example 1: To disassociate an Identity and Access Management (IAM) role from a DB cluster
The following example removes a role from a DB cluster.
$result = $client->removeRoleFromDBCluster([ 'DBClusterIdentifier' => 'mydbcluster', 'RoleArn' => 'arn:aws:iam::123456789012:role/RDSLoadFromS3', ]);
RemoveRoleFromDBInstance
$result = $client->removeRoleFromDBInstance
([/* ... */]); $promise = $client->removeRoleFromDBInstanceAsync
([/* ... */]);
Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
Parameter Syntax
$result = $client->removeRoleFromDBInstance([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'FeatureName' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The name of the DB instance to disassociate the IAM role from.
- FeatureName
-
- Required: Yes
- Type: string
The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see
DBEngineVersion
. - RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example,
arn:aws:iam::123456789012:role/AccessRole
.
Result Syntax
[]
Result Details
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBInstanceRoleNotFoundFault:
The specified
RoleArn
value doesn't match the specified feature for the DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
RemoveSourceIdentifierFromSubscription
$result = $client->removeSourceIdentifierFromSubscription
([/* ... */]); $promise = $client->removeSourceIdentifierFromSubscriptionAsync
([/* ... */]);
Removes a source identifier from an existing RDS event notification subscription.
Parameter Syntax
$result = $client->removeSourceIdentifierFromSubscription([ 'SourceIdentifier' => '<string>', // REQUIRED 'SubscriptionName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SourceIdentifier
-
- Required: Yes
- Type: string
The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
- SubscriptionName
-
- Required: Yes
- Type: string
The name of the RDS event notification subscription you want to remove a source identifier from.
Result Syntax
[ 'EventSubscription' => [ 'CustSubscriptionId' => '<string>', 'CustomerAwsId' => '<string>', 'Enabled' => true || false, 'EventCategoriesList' => ['<string>', ...], 'EventSubscriptionArn' => '<string>', 'SnsTopicArn' => '<string>', 'SourceIdsList' => ['<string>', ...], 'SourceType' => '<string>', 'Status' => '<string>', 'SubscriptionCreationTime' => '<string>', ], ]
Result Details
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
Errors
- SubscriptionNotFoundFault:
The subscription name does not exist.
- SourceNotFoundFault:
The requested source could not be found.
Examples
Example 1: To remove a source identifier from a subscription
The following example removes the specified source identifier from an existing subscription.
$result = $client->removeSourceIdentifierFromSubscription([ 'SourceIdentifier' => 'test-instance-repl', 'SubscriptionName' => 'my-instance-events', ]);
Result syntax:
[ 'EventSubscription' => [ 'CustSubscriptionId' => 'my-instance-events', 'CustomerAwsId' => '123456789012', 'Enabled' => , 'EventCategoriesList' => [ 'backup', 'recovery', ], 'EventSubscriptionArn' => 'arn:aws:rds:us-east-1:123456789012:es:my-instance-events', 'SnsTopicArn' => 'arn:aws:sns:us-east-1:123456789012:interesting-events', 'SourceIdsList' => [ 'test-instance', ], 'SourceType' => 'db-instance', 'Status' => 'modifying', 'SubscriptionCreationTime' => 'Tue Jul 31 23:22:01 UTC 2018', ], ]
RemoveTagsFromResource
$result = $client->removeTagsFromResource
([/* ... */]); $promise = $client->removeTagsFromResourceAsync
([/* ... */]);
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->removeTagsFromResource([ 'ResourceName' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceName
-
- Required: Yes
- Type: string
The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The tag key (name) of the tag to be removed.
Result Syntax
[]
Result Details
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBProxyNotFoundFault:
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DBProxyTargetGroupNotFoundFault:
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundFault:
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.- IntegrationNotFoundFault:
The specified integration could not be found.
- TenantDatabaseNotFoundFault:
The specified tenant database wasn't found in the DB instance.
- DBSnapshotTenantDatabaseNotFoundFault:
The specified snapshot tenant database wasn't found.
Examples
Example 1: To remove tags from a resource
The following example removes tags from a resource.
$result = $client->removeTagsFromResource([ 'ResourceName' => 'arn:aws:rds:us-east-1:123456789012:db:mydbinstance', 'TagKeys' => [ 'Name', 'Environment', ], ]);
ResetDBClusterParameterGroup
$result = $client->resetDBClusterParameterGroup
([/* ... */]); $promise = $client->resetDBClusterParameterGroupAsync
([/* ... */]);
Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName
and ApplyMethod
. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName
and ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot
to take effect on the next DB instance restart or RebootDBInstance
request. You must call RebootDBInstance
for every DB instance in your DB cluster that you want the updated static parameter to apply to.
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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->resetDBClusterParameterGroup([ 'DBClusterParameterGroupName' => '<string>', // REQUIRED 'Parameters' => [ [ 'AllowedValues' => '<string>', 'ApplyMethod' => 'immediate|pending-reboot', 'ApplyType' => '<string>', 'DataType' => '<string>', 'Description' => '<string>', 'IsModifiable' => true || false, 'MinimumEngineVersion' => '<string>', 'ParameterName' => '<string>', 'ParameterValue' => '<string>', 'Source' => '<string>', 'SupportedEngineModes' => ['<string>', ...], ], // ... ], 'ResetAllParameters' => true || false, ]);
Parameter Details
Members
- DBClusterParameterGroupName
-
- Required: Yes
- Type: string
The name of the DB cluster parameter group to reset.
- Parameters
-
- Type: Array of Parameter structures
A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the
ResetAllParameters
parameter is enabled. - ResetAllParameters
-
- Type: boolean
Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the
Parameters
parameter.
Result Syntax
[ 'DBClusterParameterGroupName' => '<string>', ]
Result Details
Members
- DBClusterParameterGroupName
-
- Type: string
The name of the DB cluster parameter group.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
Errors
- InvalidDBParameterGroupStateFault:
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Examples
Example 1: To reset all parameters to their default values
The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.
$result = $client->resetDBClusterParameterGroup([ 'DBClusterParameterGroupName' => 'mydbclpg', 'ResetAllParameters' => 1, ]);
Result syntax:
[ 'DBClusterParameterGroupName' => 'mydbclpg', ]
ResetDBParameterGroup
$result = $client->resetDBParameterGroup
([/* ... */]); $promise = $client->resetDBParameterGroupAsync
([/* ... */]);
Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName
and ApplyMethod
. To reset the entire DB parameter group, specify the DBParameterGroup
name and ResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot
to take effect on the next DB instance restart or RebootDBInstance
request.
Parameter Syntax
$result = $client->resetDBParameterGroup([ 'DBParameterGroupName' => '<string>', // REQUIRED 'Parameters' => [ [ 'AllowedValues' => '<string>', 'ApplyMethod' => 'immediate|pending-reboot', 'ApplyType' => '<string>', 'DataType' => '<string>', 'Description' => '<string>', 'IsModifiable' => true || false, 'MinimumEngineVersion' => '<string>', 'ParameterName' => '<string>', 'ParameterValue' => '<string>', 'Source' => '<string>', 'SupportedEngineModes' => ['<string>', ...], ], // ... ], 'ResetAllParameters' => true || false, ]);
Parameter Details
Members
- DBParameterGroupName
-
- Required: Yes
- Type: string
The name of the DB parameter group.
Constraints:
-
Must match the name of an existing
DBParameterGroup
.
- Parameters
-
- Type: Array of Parameter structures
To reset the entire DB parameter group, specify the
DBParameterGroup
name andResetAllParameters
parameters. To reset specific parameters, provide a list of the following:ParameterName
andApplyMethod
. A maximum of 20 parameters can be modified in a single request.MySQL
Valid Values (for Apply method):
immediate
|pending-reboot
You can use the immediate value with dynamic parameters only. You can use the
pending-reboot
value for both dynamic and static parameters, and changes are applied when DB instance reboots.MariaDB
Valid Values (for Apply method):
immediate
|pending-reboot
You can use the immediate value with dynamic parameters only. You can use the
pending-reboot
value for both dynamic and static parameters, and changes are applied when DB instance reboots.Oracle
Valid Values (for Apply method):
pending-reboot
- ResetAllParameters
-
- Type: boolean
Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
Result Syntax
[ 'DBParameterGroupName' => '<string>', ]
Result Details
Members
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group.
Errors
- InvalidDBParameterGroupStateFault:
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Examples
Example 1: To reset all parameters to their default values
The following example resets all parameter values in a customer-created DB parameter group to their default values.
$result = $client->resetDBParameterGroup([ 'DBParameterGroupName' => 'mypg', 'ResetAllParameters' => 1, ]);
Result syntax:
[ 'DBParameterGroupName' => 'mypg', ]
RestoreDBClusterFromS3
$result = $client->restoreDBClusterFromS3
([/* ... */]); $promise = $client->restoreDBClusterFromS3Async
([/* ... */]);
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance
operation 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 RestoreDBClusterFromS3
operation has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
Parameter Syntax
$result = $client->restoreDBClusterFromS3([ 'AvailabilityZones' => ['<string>', ...], 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'DBClusterIdentifier' => '<string>', // REQUIRED 'DBClusterParameterGroupName' => '<string>', 'DBSubnetGroupName' => '<string>', 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Domain' => '<string>', 'DomainIAMRoleName' => '<string>', 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableIAMDatabaseAuthentication' => true || false, 'Engine' => '<string>', // REQUIRED 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'KmsKeyId' => '<string>', 'ManageMasterUserPassword' => true || false, 'MasterUserPassword' => '<string>', 'MasterUserSecretKmsKeyId' => '<string>', 'MasterUsername' => '<string>', // REQUIRED 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'S3BucketName' => '<string>', // REQUIRED 'S3IngestionRoleArn' => '<string>', // REQUIRED 'S3Prefix' => '<string>', 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'SourceEngine' => '<string>', // REQUIRED 'SourceEngineVersion' => '<string>', // REQUIRED 'StorageEncrypted' => true || false, 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AvailabilityZones
-
- Type: Array of strings
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
- BacktrackWindow
-
- Type: long (int|float)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
- BackupRetentionPeriod
-
- Type: int
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
-
Must be a value from 1 to 35
- CharacterSetName
-
- Type: string
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
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.
Example:
my-cluster1
- DBClusterParameterGroupName
-
- Type: string
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
- DBSubnetGroupName
-
- Type: string
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
- DatabaseName
-
- Type: string
The database name for the restored DB cluster.
- DeletionProtection
-
- Type: boolean
Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
- Domain
-
- Type: 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.
- DomainIAMRoleName
-
- Type: string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
- EnableCloudwatchLogsExports
-
- Type: Array of strings
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.
Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies 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.
- Engine
-
- Required: Yes
- Type: string
The name of the database engine to be used for this DB cluster.
Valid Values:
aurora-mysql
(for Aurora MySQL) - EngineLifecycleSupport
-
- Type: string
The life cycle type for this DB cluster.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
-
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
-
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- EngineVersion
-
- Type: string
The version number of the database engine to use.
To list all of the available engine versions for
aurora-mysql
(Aurora MySQL), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Examples:
5.7.mysql_aurora.2.12.0
,8.0.mysql_aurora.3.04.0
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for 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.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. - ManageMasterUserPassword
-
- Type: boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
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.
Constraints:
-
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
- MasterUserPassword
-
- Type: string
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints:
-
Must contain from 8 to 41 characters.
-
Can't be specified if
ManageMasterUserPassword
is turned on.
- MasterUserSecretKmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the 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.
If you don't specify
MasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
- MasterUsername
-
- Required: Yes
- Type: string
The name of the master user for the restored DB cluster.
Constraints:
-
Must be 1 to 16 letters or numbers.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
- NetworkType
-
- Type: string
The network type of the DB cluster.
Valid Values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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.
- OptionGroupName
-
- Type: string
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
- Port
-
- Type: int
The port number on which the instances in the restored DB cluster accept connections.
Default:
3306
- PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
- PreferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
- S3BucketName
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
- S3IngestionRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
- S3Prefix
-
- Type: string
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
- ServerlessV2ScalingConfiguration
-
- Type: ServerlessV2ScalingConfiguration structure
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- SourceEngine
-
- Required: Yes
- Type: string
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid Values:
mysql
- SourceEngineVersion
-
- Required: Yes
- Type: string
The version of the database that the backup files were created from.
MySQL versions 5.7 and 8.0 are supported.
Example:
5.7.40
,8.0.28
- StorageEncrypted
-
- Type: boolean
Specifies whether the restored DB cluster is encrypted.
- StorageType
-
- Type: string
Specifies the storage type to be associated with the DB cluster.
Valid Values:
aurora
,aurora-iopt1
Default:
aurora
Valid for: Aurora DB clusters only
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of EC2 VPC security groups to associate with the restored DB cluster.
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterAlreadyExistsFault:
The user already has a DB cluster with the given identifier.
- DBClusterQuotaExceededFault:
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBSubnetGroupStateFault:
The DB subnet group cannot be deleted because it's in use.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidS3BucketFault:
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- InsufficientStorageClusterCapacityFault:
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
- StorageTypeNotSupportedFault:
The specified
StorageType
can't be associated with the DB instance.
Examples
Example 1: To restore an Amazon Aurora DB cluster from Amazon S3
The following example restores an Amazon Aurora MySQL version 5.7-compatible DB cluster from a MySQL 5.7 DB backup file in Amazon S3.
$result = $client->restoreDBClusterFromS3([ 'DBClusterIdentifier' => 'cluster-s3-restore', 'Engine' => 'aurora-mysql', 'MasterUserPassword' => 'mypassword', 'MasterUsername' => 'admin', 'S3BucketName' => 'mybucket', 'S3IngestionRoleArn' => 'arn:aws:iam::123456789012:role/service-role/TestBackup', 'S3Prefix' => 'test-backup', 'SourceEngine' => 'mysql', 'SourceEngineVersion' => '5.7.28', ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 1, 'AssociatedRoles' => [ ], 'AvailabilityZones' => [ 'us-west-2c', 'us-west-2a', 'us-west-2b', ], 'BackupRetentionPeriod' => 1, 'ClusterCreateTime' =>, 'CopyTagsToSnapshot' => , 'CrossAccountClone' => , 'DBClusterArn' => 'arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore', 'DBClusterIdentifier' => 'cluster-s3-restore', 'DBClusterMembers' => [ ], 'DBClusterParameterGroup' => 'default.aurora-mysql5.7', 'DBSubnetGroup' => 'default', 'DbClusterResourceId' => 'cluster-SU5THYQQHOWCXZZDGXREXAMPLE', 'DeletionProtection' => , 'DomainMemberships' => [ ], 'Endpoint' => 'cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com', 'Engine' => 'aurora-mysql', 'EngineMode' => 'provisioned', 'EngineVersion' => '5.7.12', 'HostedZoneId' => 'Z1PVIF0EXAMPLE', 'HttpEndpointEnabled' => , 'IAMDatabaseAuthenticationEnabled' => , 'MasterUsername' => 'admin', 'MultiAZ' => , 'Port' => 3306, 'PreferredBackupWindow' => '11:15-11:45', 'PreferredMaintenanceWindow' => 'thu:12:19-thu:12:49', 'ReadReplicaIdentifiers' => [ ], 'ReaderEndpoint' => 'cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com', 'Status' => 'creating', 'StorageEncrypted' => , 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-########', ], ], ], ]
RestoreDBClusterFromSnapshot
$result = $client->restoreDBClusterFromSnapshot
([/* ... */]); $promise = $client->restoreDBClusterFromSnapshotAsync
([/* ... */]);
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance
operation 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 RestoreDBClusterFromSnapshot
operation 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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->restoreDBClusterFromSnapshot([ 'AvailabilityZones' => ['<string>', ...], 'BacktrackWindow' => <integer>, 'CopyTagsToSnapshot' => true || false, 'DBClusterIdentifier' => '<string>', // REQUIRED 'DBClusterInstanceClass' => '<string>', 'DBClusterParameterGroupName' => '<string>', 'DBSubnetGroupName' => '<string>', 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Domain' => '<string>', 'DomainIAMRoleName' => '<string>', 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableIAMDatabaseAuthentication' => true || false, 'EnablePerformanceInsights' => true || false, 'Engine' => '<string>', // REQUIRED 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ScalingConfiguration' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'SnapshotIdentifier' => '<string>', // REQUIRED 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AvailabilityZones
-
- Type: Array of strings
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
- BacktrackWindow
-
- Type: long (int|float)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
- CopyTagsToSnapshot
-
- Type: boolean
Specifies 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 and Multi-AZ DB clusters
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
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
Example:
my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- DBClusterInstanceClass
-
- Type: string
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.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
- DBClusterParameterGroupName
-
- Type: 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 default 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
- DBSubnetGroupName
-
- Type: string
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example:
mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- DatabaseName
-
- Type: string
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- DeletionProtection
-
- Type: boolean
Specifies whether to enable deletion protection for the DB cluster. 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
- Domain
-
- Type: string
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are
error
,general
, andslowquery
.RDS for PostgreSQL
Possible values are
postgresql
andupgrade
.Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies 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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- EnablePerformanceInsights
-
- Type: boolean
Specifies whether to turn on Performance Insights for the DB cluster.
- Engine
-
- Required: Yes
- Type: string
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- EngineLifecycleSupport
-
- Type: string
The life cycle type for this DB cluster.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
-
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
-
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- EngineMode
-
- Type: string
The DB engine mode of the DB cluster, either
provisioned
orserverless
.For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
- EngineVersion
-
- Type: string
The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Iops
-
- Type: int
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 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: Aurora DB clusters and Multi-AZ DB clusters
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
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.
When you don't specify a value for the
KmsKeyId
parameter, then the following occurs:-
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. -
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify
0
.If
MonitoringRoleArn
is specified, also setMonitoringInterval
to a value other than0
.Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
0
- MonitoringRoleArn
-
- Type: string
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess
.If
MonitoringInterval
is set to a value other than0
, supply aMonitoringRoleArn
value. - NetworkType
-
- Type: string
The network type of the DB cluster.
Valid Values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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.
Valid for: Aurora DB clusters only
- OptionGroupName
-
- Type: string
The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
If you don't specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. - PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data.
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
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS issues an error. - Port
-
- Type: int
The port number on which the new DB cluster accepts connections.
Constraints: This value must be
1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- PubliclyAccessible
-
- Type: boolean
Specifies 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: Aurora DB clusters and Multi-AZ DB clusters
- RdsCustomClusterConfiguration
-
- Type: RdsCustomClusterConfiguration structure
Reserved for future use.
- ScalingConfiguration
-
- Type: ScalingConfiguration structure
For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
- ServerlessV2ScalingConfiguration
-
- Type: ServerlessV2ScalingConfiguration structure
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- SnapshotIdentifier
-
- Required: Yes
- Type: string
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
-
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- StorageType
-
- Type: string
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the
Iops
parameter is required.Valid Values:
aurora
,aurora-iopt1
(Aurora DB clusters);io1
(Multi-AZ DB clusters)Default:
aurora
(Aurora DB clusters);io1
(Multi-AZ DB clusters)Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Tags
-
- Type: Array of Tag structures
The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterAlreadyExistsFault:
The user already has a DB cluster with the given identifier.
- DBClusterQuotaExceededFault:
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.- InsufficientDBClusterCapacityFault:
The DB cluster doesn't have enough capacity for the current operation.
- InsufficientStorageClusterCapacityFault:
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
- InvalidDBSnapshotStateFault:
The state of the DB snapshot doesn't allow deletion.
- InvalidDBClusterSnapshotStateFault:
The supplied value isn't a valid DB cluster snapshot state.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidRestoreFault:
Cannot restore from VPC backup to non-VPC DB instance.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
Examples
Example 1: To restore a DB cluster from a snapshot
The following example restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named test-instance-snapshot.
$result = $client->restoreDBClusterFromSnapshot([ 'DBClusterIdentifier' => 'newdbcluster', 'Engine' => 'aurora-postgresql', 'EngineVersion' => '10.7', 'SnapshotIdentifier' => 'test-instance-snapshot', ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 1, 'AssociatedRoles' => [ ], 'AvailabilityZones' => [ 'us-west-2c', 'us-west-2a', 'us-west-2b', ], 'BackupRetentionPeriod' => 7, 'ClusterCreateTime' =>, 'CopyTagsToSnapshot' => , 'CrossAccountClone' => , 'DBClusterArn' => 'arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster', 'DBClusterIdentifier' => 'newdbcluster', 'DBClusterMembers' => [ ], 'DBClusterParameterGroup' => 'default.aurora-postgresql10', 'DBSubnetGroup' => 'default', 'DatabaseName' => '', 'DbClusterResourceId' => 'cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE', 'DeletionProtection' => , 'DomainMemberships' => [ ], 'Endpoint' => 'newdbcluster.cluster-############.us-west-2.rds.amazonaws.com', 'Engine' => 'aurora-postgresql', 'EngineMode' => 'provisioned', 'EngineVersion' => '10.7', 'HostedZoneId' => 'Z1PVIF0EXAMPLE', 'HttpEndpointEnabled' => , 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6', 'MasterUsername' => 'postgres', 'MultiAZ' => , 'Port' => 5432, 'PreferredBackupWindow' => '09:33-10:03', 'PreferredMaintenanceWindow' => 'sun:12:22-sun:12:52', 'ReadReplicaIdentifiers' => [ ], 'ReaderEndpoint' => 'newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com', 'Status' => 'creating', 'StorageEncrypted' => 1, 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-########', ], ], ], ]
RestoreDBClusterToPointInTime
$result = $client->restoreDBClusterToPointInTime
([/* ... */]); $promise = $client->restoreDBClusterToPointInTimeAsync
([/* ... */]);
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.
For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance
operation 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
operation 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 DB cluster deployments in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->restoreDBClusterToPointInTime([ 'BacktrackWindow' => <integer>, 'CopyTagsToSnapshot' => true || false, 'DBClusterIdentifier' => '<string>', // REQUIRED 'DBClusterInstanceClass' => '<string>', 'DBClusterParameterGroupName' => '<string>', 'DBSubnetGroupName' => '<string>', 'DeletionProtection' => true || false, 'Domain' => '<string>', 'DomainIAMRoleName' => '<string>', 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableIAMDatabaseAuthentication' => true || false, 'EnablePerformanceInsights' => true || false, 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'RestoreToTime' => <integer || string || DateTime>, 'RestoreType' => '<string>', 'ScalingConfiguration' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'SourceDBClusterIdentifier' => '<string>', 'SourceDbClusterResourceId' => '<string>', 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'UseLatestRestorableTime' => true || false, 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- BacktrackWindow
-
- Type: long (int|float)
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
- CopyTagsToSnapshot
-
- Type: boolean
Specifies 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 and Multi-AZ DB clusters
- DBClusterIdentifier
-
- Required: Yes
- Type: 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
- DBClusterInstanceClass
-
- Type: string
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.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
- DBClusterParameterGroupName
-
- Type: string
The name of the custom DB cluster parameter group to associate with this DB cluster.
If the
DBClusterParameterGroupName
parameter 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
- DBSubnetGroupName
-
- Type: 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
- DeletionProtection
-
- Type: boolean
Specifies whether to enable deletion protection for the DB cluster. 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
- Domain
-
- Type: string
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
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
- EnableCloudwatchLogsExports
-
- Type: Array of strings
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.
RDS for MySQL
Possible values are
error
,general
, andslowquery
.RDS for PostgreSQL
Possible values are
postgresql
andupgrade
.Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies 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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- EnablePerformanceInsights
-
- Type: boolean
Specifies whether to turn on Performance Insights for the DB cluster.
- EngineLifecycleSupport
-
- Type: string
The life cycle type for this DB cluster.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
-
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
-
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- EngineMode
-
- Type: 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 v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.Valid for: Aurora DB clusters only
- Iops
-
- Type: int
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 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
- KmsKeyId
-
- Type: 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
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify
0
.If
MonitoringRoleArn
is specified, also setMonitoringInterval
to a value other than0
.Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
0
- MonitoringRoleArn
-
- Type: string
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess
.If
MonitoringInterval
is set to a value other than0
, supply aMonitoringRoleArn
value. - NetworkType
-
- Type: string
The network type of the DB cluster.
Valid Values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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.
Valid for: Aurora DB clusters only
- OptionGroupName
-
- Type: 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.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
If you don't specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. - PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data.
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
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS issues an error. - Port
-
- Type: int
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
- PubliclyAccessible
-
- Type: boolean
Specifies 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
- RdsCustomClusterConfiguration
-
- Type: RdsCustomClusterConfiguration structure
Reserved for future use.
- RestoreToTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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 provided -
Can't be specified if the
UseLatestRestorableTime
parameter is enabled -
Can'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
- RestoreType
-
- 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.
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
- ScalingConfiguration
-
- Type: ScalingConfiguration structure
For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
- ServerlessV2ScalingConfiguration
-
- Type: ServerlessV2ScalingConfiguration structure
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- SourceDBClusterIdentifier
-
- Type: 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
- SourceDbClusterResourceId
-
- Type: string
The resource ID of the source DB cluster from which to restore.
- StorageType
-
- Type: string
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the
Iops
parameter is required.Valid Values:
aurora
,aurora-iopt1
(Aurora DB clusters);io1
(Multi-AZ DB clusters)Default:
aurora
(Aurora DB clusters);io1
(Multi-AZ DB clusters)Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- UseLatestRestorableTime
-
- Type: boolean
Specifies 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
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterAlreadyExistsFault:
The user already has a DB cluster with the given identifier.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBClusterQuotaExceededFault:
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- InsufficientDBClusterCapacityFault:
The DB cluster doesn't have enough capacity for the current operation.
- InsufficientStorageClusterCapacityFault:
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
- InvalidDBClusterSnapshotStateFault:
The supplied value isn't a valid DB cluster snapshot state.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBSnapshotStateFault:
The state of the DB snapshot doesn't allow deletion.
- InvalidRestoreFault:
Cannot restore from VPC backup to non-VPC DB instance.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.- DBClusterAutomatedBackupNotFoundFault:
No automated backup for this DB cluster was found.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
Examples
Example 1: To restore a DB cluster to a specified time
The following 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.
$result = $client->restoreDBClusterToPointInTime([ 'DBClusterIdentifier' => 'sample-cluster-clone', 'RestoreType' => 'copy-on-write', 'SourceDBClusterIdentifier' => 'database-4', 'UseLatestRestorableTime' => 1, ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 1, 'AssociatedRoles' => [ ], 'AvailabilityZones' => [ 'us-west-2c', 'us-west-2a', 'us-west-2b', ], 'BackupRetentionPeriod' => 7, 'CloneGroupId' => '8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd', 'ClusterCreateTime' =>, 'CopyTagsToSnapshot' => , 'CrossAccountClone' => , 'DBClusterArn' => 'arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone', 'DBClusterIdentifier' => 'sample-cluster-clone', 'DBClusterMembers' => [ ], 'DBClusterParameterGroup' => 'default.aurora-postgresql10', 'DBSubnetGroup' => 'default', 'DatabaseName' => '', 'DbClusterResourceId' => 'cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE', 'DeletionProtection' => , 'Endpoint' => 'sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com', 'Engine' => 'aurora-postgresql', 'EngineMode' => 'provisioned', 'EngineVersion' => '10.7', 'HostedZoneId' => 'Z1PVIF0EXAMPLE', 'HttpEndpointEnabled' => , 'IAMDatabaseAuthenticationEnabled' => , 'KmsKeyId' => 'arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6', 'MasterUsername' => 'postgres', 'MultiAZ' => , 'Port' => 5432, 'PreferredBackupWindow' => '09:33-10:03', 'PreferredMaintenanceWindow' => 'sun:12:22-sun:12:52', 'ReadReplicaIdentifiers' => [ ], 'ReaderEndpoint' => 'sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com', 'Status' => 'creating', 'StorageEncrypted' => 1, 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-########', ], ], ], ]
RestoreDBInstanceFromDBSnapshot
$result = $client->restoreDBInstanceFromDBSnapshot
([/* ... */]); $promise = $client->restoreDBInstanceFromDBSnapshotAsync
([/* ... */]);
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot
operation. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier
in the call to the RestoreDBInstanceFromDBSnapshot
operation. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
To restore from a DB snapshot with an unsupported engine version, you must first upgrade the engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see Upgrading a MySQL DB snapshot engine version. For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, Upgrading a PostgreSQL DB snapshot engine version.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot
.
Parameter Syntax
$result = $client->restoreDBInstanceFromDBSnapshot([ 'AllocatedStorage' => <integer>, 'AutoMinorVersionUpgrade' => true || false, 'AvailabilityZone' => '<string>', 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'DBClusterSnapshotIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', // REQUIRED 'DBName' => '<string>', 'DBParameterGroupName' => '<string>', 'DBSnapshotIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'Domain' => '<string>', 'DomainAuthSecretArn' => '<string>', 'DomainDnsIps' => ['<string>', ...], 'DomainFqdn' => '<string>', 'DomainIAMRoleName' => '<string>', 'DomainOu' => '<string>', 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableCustomerOwnedIp' => true || false, 'EnableIAMDatabaseAuthentication' => true || false, 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PubliclyAccessible' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'TdeCredentialPassword' => '<string>', 'UseDefaultProcessorFeatures' => true || false, 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AllocatedStorage
-
- Type: int
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
- AutoMinorVersionUpgrade
-
- Type: boolean
Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
- AvailabilityZone
-
- Type: string
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.Example:
us-east-1a
- BackupTarget
-
- Type: string
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are
outposts
(Amazon Web Services Outposts) andregion
(Amazon Web Services Region). The default isregion
.For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- CACertificateIdentifier
-
- Type: string
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
- CustomIamInstanceProfile
-
- Type: string
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
- DBClusterSnapshotIdentifier
-
- Type: string
The identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
-
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
-
Can't be specified when
DBSnapshotIdentifier
is specified. -
Must be specified when
DBSnapshotIdentifier
isn't specified. -
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the
DBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. -
Can't be the identifier of an Aurora DB cluster snapshot.
- DBInstanceClass
-
- Type: string
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. 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.
Default: The same DBInstanceClass as the original DB instance.
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
-
Must contain from 1 to 63 numbers, letters, or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
my-snapshot-id
- DBName
-
- Type: string
The name of the database for the restored DB instance.
This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances.
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for
DBParameterGroupName
, then RDS uses the defaultDBParameterGroup
for the specified DB engine.This setting doesn't apply to RDS Custom.
Constraints:
-
If supplied, must match the name of an existing DB 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.
- DBSnapshotIdentifier
-
- Type: string
The identifier for the DB snapshot to restore from.
Constraints:
-
Must match the identifier of an existing DB snapshot.
-
Can't be specified when
DBClusterSnapshotIdentifier
is specified. -
Must be specified when
DBClusterSnapshotIdentifier
isn't specified. -
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
- DBSubnetGroupName
-
- Type: string
The name of the DB subnet group to use for the new instance.
Constraints:
-
If supplied, must match the name of an existing DB subnet group.
Example:
mydbsubnetgroup
- DedicatedLogVolume
-
- Type: boolean
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
- DeletionProtection
-
- Type: boolean
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
- Domain
-
- Type: string
The Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
- DomainAuthSecretArn
-
- Type: string
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
-
Can't be longer than 64 characters.
Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- DomainDnsIps
-
- Type: Array of strings
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
-
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example:
123.124.125.126,234.235.236.237
- DomainFqdn
-
- Type: string
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
-
Can't be longer than 64 characters.
Example:
mymanagedADtest.mymanagedAD.mydomain
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
- DomainOu
-
- Type: string
The Active Directory organizational unit for your DB instance to join.
Constraints:
-
Must be in the distinguished name format.
-
Can't be longer than 64 characters.
Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
- EnableCustomerOwnedIp
-
- Type: boolean
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
- Engine
-
- Type: string
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
-
db2-ae
-
db2-se
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
- EngineLifecycleSupport
-
- Type: string
The life cycle type for this DB instance.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- Iops
-
- Type: int
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
- LicenseModel
-
- Type: string
License model information for the restored DB instance.
License models for RDS for Db2 require additional configuration. The Bring Your Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
-
RDS for Db2 -
bring-your-own-license | marketplace-license
-
RDS for MariaDB -
general-public-license
-
RDS for Microsoft SQL Server -
license-included
-
RDS for MySQL -
general-public-license
-
RDS for Oracle -
bring-your-own-license | license-included
-
RDS for PostgreSQL -
postgresql-license
Default: Same as the source.
- MultiAZ
-
- Type: boolean
Specifies whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment. - NetworkType
-
- Type: string
The network type of the DB instance.
Valid Values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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 RDS User Guide.
- OptionGroupName
-
- Type: string
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
- Port
-
- Type: int
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be
1150-65535
- ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
- PubliclyAccessible
-
- Type: boolean
Specifies whether the DB instance is publicly accessible.
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.
- StorageThroughput
-
- Type: int
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
- StorageType
-
- Type: string
Specifies the storage type to be associated with the DB instance.
Valid Values:
gp2 | gp3 | io1 | io2 | standard
If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified, otherwisegp2
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TdeCredentialArn
-
- Type: string
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
- TdeCredentialPassword
-
- Type: string
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
- UseDefaultProcessorFeatures
-
- Type: boolean
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceAlreadyExistsFault:
The user already has a DB instance with the given identifier.
- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.- InstanceQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB instances.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
- InvalidDBSnapshotStateFault:
The state of the DB snapshot doesn't allow deletion.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidRestoreFault:
Cannot restore from VPC backup to non-VPC DB instance.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- ProvisionedIopsNotAvailableInAZFault:
Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- StorageTypeNotSupportedFault:
The specified
StorageType
can't be associated with the DB instance.- AuthorizationNotFoundFault:
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- BackupPolicyNotFoundFault:
- This error does not currently have a description.
- NetworkTypeNotSupported:
The network type is invalid for the DB instance. Valid nework type values are
IPV4
andDUAL
.- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.- CertificateNotFoundFault:
CertificateIdentifier
doesn't refer to an existing certificate.- TenantDatabaseQuotaExceededFault:
You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
Examples
Example 1: To restore a DB instance from a DB snapshot
The following example creates a new DB instance named db7-new-instance with the db.t3.small DB instance class from the specified DB snapshot. The source DB instance from which the snapshot was taken uses a deprecated DB instance class, so you can't upgrade it.
$result = $client->restoreDBInstanceFromDBSnapshot([ 'DBInstanceClass' => 'db.t3.small', 'DBInstanceIdentifier' => 'db7-new-instance', 'DBSnapshotIdentifier' => 'db7-test-snapshot', ]);
Result syntax:
[ 'DBInstance' => [ 'AssociatedRoles' => [ ], 'AutoMinorVersionUpgrade' => 1, 'DBInstanceArn' => 'arn:aws:rds:us-west-2:123456789012:db:db7-new-instance', 'DBInstanceClass' => 'db.t3.small', 'DBInstanceIdentifier' => 'db7-new-instance', 'DBInstanceStatus' => 'creating', 'DeletionProtection' => , 'Engine' => 'mysql', 'EngineVersion' => '5.7.22', 'IAMDatabaseAuthenticationEnabled' => , 'LicenseModel' => 'general-public-license', 'MultiAZ' => , 'PendingModifiedValues' => [ ], 'PerformanceInsightsEnabled' => , 'PreferredMaintenanceWindow' => 'mon:07:37-mon:08:07', 'ReadReplicaDBInstanceIdentifiers' => [ ], ], // Some output ommitted. ]
RestoreDBInstanceFromS3
$result = $client->restoreDBInstanceFromS3
([/* ... */]); $promise = $client->restoreDBInstanceFromS3Async
([/* ... */]);
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This operation doesn't apply to RDS Custom.
Parameter Syntax
$result = $client->restoreDBInstanceFromS3([ 'AllocatedStorage' => <integer>, 'AutoMinorVersionUpgrade' => true || false, 'AvailabilityZone' => '<string>', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'CopyTagsToSnapshot' => true || false, 'DBInstanceClass' => '<string>', // REQUIRED 'DBInstanceIdentifier' => '<string>', // REQUIRED 'DBName' => '<string>', 'DBParameterGroupName' => '<string>', 'DBSecurityGroups' => ['<string>', ...], 'DBSubnetGroupName' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableIAMDatabaseAuthentication' => true || false, 'EnablePerformanceInsights' => true || false, 'Engine' => '<string>', // REQUIRED 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'ManageMasterUserPassword' => true || false, 'MasterUserPassword' => '<string>', 'MasterUserSecretKmsKeyId' => '<string>', 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PubliclyAccessible' => true || false, 'S3BucketName' => '<string>', // REQUIRED 'S3IngestionRoleArn' => '<string>', // REQUIRED 'S3Prefix' => '<string>', 'SourceEngine' => '<string>', // REQUIRED 'SourceEngineVersion' => '<string>', // REQUIRED 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'UseDefaultProcessorFeatures' => true || false, 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AllocatedStorage
-
- Type: int
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in
CreateDBInstance
.Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
- AutoMinorVersionUpgrade
-
- Type: boolean
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
- AvailabilityZone
-
- Type: string
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example:
us-east-1d
Constraint: The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint. - BackupRetentionPeriod
-
- Type: int
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see
CreateDBInstance
. - CACertificateIdentifier
-
- Type: string
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
- DBInstanceClass
-
- Required: Yes
- Type: string
The compute and memory capacity of the DB instance, for example db.m4.large. 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.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The DB instance identifier. This parameter is stored as a lowercase string.
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.
Example:
mydbinstance
- DBName
-
- Type: string
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
. - DBParameterGroupName
-
- Type: string
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for
DBParameterGroupName
, then the defaultDBParameterGroup
for the specified DB engine is used. - DBSecurityGroups
-
- Type: Array of strings
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
- DBSubnetGroupName
-
- Type: string
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
- DatabaseInsightsMode
-
- Type: string
Specifies the mode of Database Insights to enable for the instance.
- DedicatedLogVolume
-
- Type: boolean
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
- DeletionProtection
-
- Type: boolean
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of logs that the restored DB instance 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 RDS User Guide.
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies 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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
- EnablePerformanceInsights
-
- Type: boolean
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
- Engine
-
- Required: Yes
- Type: string
The name of the database engine to be used for this instance.
Valid Values:
mysql
- EngineLifecycleSupport
-
- Type: string
The life cycle type for this DB instance.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- EngineVersion
-
- Type: string
The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see
CreateDBInstance
, or callDescribeDBEngineVersions
. - Iops
-
- Type: int
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted DB instance.
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.
If the
StorageEncrypted
parameter is enabled, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. - LicenseModel
-
- Type: string
The license model for this DB instance. Use
general-public-license
. - ManageMasterUserPassword
-
- Type: boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
- MasterUserPassword
-
- Type: string
The password for the master user.
Constraints:
-
Can't be specified if
ManageMasterUserPassword
is turned on. -
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
-
RDS for Db2 - Must contain from 8 to 128 characters.
-
RDS for MariaDB - Must contain from 8 to 41 characters.
-
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
-
RDS for MySQL - Must contain from 8 to 41 characters.
-
RDS for Oracle - Must contain from 8 to 30 characters.
-
RDS for PostgreSQL - Must contain from 8 to 128 characters.
- MasterUserSecretKmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
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.
If you don't specify
MasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
- MasterUsername
-
- Type: string
The name for the master user.
Constraints:
-
Must be 1 to 16 letters or numbers.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
- MaxAllocatedStorage
-
- Type: int
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values: 0, 1, 5, 10, 15, 30, 60
Default:
0
- MonitoringRoleArn
-
- Type: string
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value. - MultiAZ
-
- Type: boolean
Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the
AvailabilityZone
parameter. - NetworkType
-
- Type: string
The network type of the DB instance.
Valid Values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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 RDS User Guide.
- OptionGroupName
-
- Type: string
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. - PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
- Port
-
- Type: int
The port number on which the database accepts connections.
Type: Integer
Valid Values:
1150
-65535
Default:
3306
- PreferredBackupWindow
-
- Type: string
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
- PreferredMaintenanceWindow
-
- Type: string
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
-
Must be in the format
ddd:hh24:mi-ddd:hh24:mi
. -
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
-
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred backup window.
-
Must be at least 30 minutes.
- ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- PubliclyAccessible
-
- Type: boolean
Specifies whether the DB instance is publicly accessible.
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.
- S3BucketName
-
- Required: Yes
- Type: string
The name of your Amazon S3 bucket that contains your database backup file.
- S3IngestionRoleArn
-
- Required: Yes
- Type: string
An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.
- S3Prefix
-
- Type: string
The prefix of your Amazon S3 bucket.
- SourceEngine
-
- Required: Yes
- Type: string
The name of the engine of your source database.
Valid Values:
mysql
- SourceEngineVersion
-
- Required: Yes
- Type: string
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example:
5.6.40
- StorageEncrypted
-
- Type: boolean
Specifies whether the new DB instance is encrypted or not.
- StorageThroughput
-
- Type: int
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
- StorageType
-
- Type: string
Specifies the storage type to be associated with the DB instance.
Valid Values:
gp2 | gp3 | io1 | io2 | standard
If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisegp2
- Tags
-
- Type: Array of Tag structures
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- UseDefaultProcessorFeatures
-
- Type: boolean
Specifies whether the DB instance class of the DB instance uses its default processor features.
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of VPC security groups to associate with this DB instance.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceAlreadyExistsFault:
The user already has a DB instance with the given identifier.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.- InstanceQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidS3BucketFault:
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- ProvisionedIopsNotAvailableInAZFault:
Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- StorageTypeNotSupportedFault:
The specified
StorageType
can't be associated with the DB instance.- AuthorizationNotFoundFault:
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- BackupPolicyNotFoundFault:
- This error does not currently have a description.
- NetworkTypeNotSupported:
The network type is invalid for the DB instance. Valid nework type values are
IPV4
andDUAL
.- CertificateNotFoundFault:
CertificateIdentifier
doesn't refer to an existing certificate.
RestoreDBInstanceToPointInTime
$result = $client->restoreDBInstanceToPointInTime
([/* ... */]); $promise = $client->restoreDBInstanceToPointInTimeAsync
([/* ... */]);
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime
property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod
property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime
.
Parameter Syntax
$result = $client->restoreDBInstanceToPointInTime([ 'AllocatedStorage' => <integer>, 'AutoMinorVersionUpgrade' => true || false, 'AvailabilityZone' => '<string>', 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'DBInstanceClass' => '<string>', 'DBName' => '<string>', 'DBParameterGroupName' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'Domain' => '<string>', 'DomainAuthSecretArn' => '<string>', 'DomainDnsIps' => ['<string>', ...], 'DomainFqdn' => '<string>', 'DomainIAMRoleName' => '<string>', 'DomainOu' => '<string>', 'EnableCloudwatchLogsExports' => ['<string>', ...], 'EnableCustomerOwnedIp' => true || false, 'EnableIAMDatabaseAuthentication' => true || false, 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'OptionGroupName' => '<string>', 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PubliclyAccessible' => true || false, 'RestoreTime' => <integer || string || DateTime>, 'SourceDBInstanceAutomatedBackupsArn' => '<string>', 'SourceDBInstanceIdentifier' => '<string>', 'SourceDbiResourceId' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TargetDBInstanceIdentifier' => '<string>', // REQUIRED 'TdeCredentialArn' => '<string>', 'TdeCredentialPassword' => '<string>', 'UseDefaultProcessorFeatures' => true || false, 'UseLatestRestorableTime' => true || false, 'VpcSecurityGroupIds' => ['<string>', ...], ]);
Parameter Details
Members
- AllocatedStorage
-
- Type: int
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in
CreateDBInstance
.Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
- AutoMinorVersionUpgrade
-
- Type: boolean
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
- AvailabilityZone
-
- Type: string
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraints:
-
You can't specify the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
Example:
us-east-1a
- BackupTarget
-
- Type: string
The location for storing automated backups and manual snapshots for the restored DB instance.
Valid Values:
-
outposts
(Amazon Web Services Outposts) -
region
(Amazon Web Services Region)
Default:
region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- CACertificateIdentifier
-
- Type: string
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- CopyTagsToSnapshot
-
- Type: boolean
Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
- CustomIamInstanceProfile
-
- Type: string
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
- DBInstanceClass
-
- Type: string
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. 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.
Default: The same DB instance class as the original DB instance.
- DBName
-
- Type: string
The database name for the restored DB instance.
This parameter doesn't apply to the following DB instances:
-
RDS Custom
-
RDS for Db2
-
RDS for MariaDB
-
RDS for MySQL
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for
DBParameterGroupName
, then the defaultDBParameterGroup
for the specified DB engine is used.This setting doesn't apply to RDS Custom.
Constraints:
-
If supplied, must match the name of an existing DB 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.
- DBSubnetGroupName
-
- Type: string
The DB subnet group name to use for the new instance.
Constraints:
-
If supplied, must match the name of an existing DB subnet group.
Example:
mydbsubnetgroup
- DedicatedLogVolume
-
- Type: boolean
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
- DeletionProtection
-
- Type: boolean
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
- Domain
-
- Type: string
The Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- DomainAuthSecretArn
-
- Type: string
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
-
Can't be longer than 64 characters.
Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- DomainDnsIps
-
- Type: Array of strings
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
-
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example:
123.124.125.126,234.235.236.237
- DomainFqdn
-
- Type: string
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
-
Can't be longer than 64 characters.
Example:
mymanagedADtest.mymanagedAD.mydomain
- DomainIAMRoleName
-
- Type: string
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
- DomainOu
-
- Type: string
The Active Directory organizational unit for your DB instance to join.
Constraints:
-
Must be in the distinguished name format.
-
Can't be longer than 64 characters.
Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of logs that the restored DB instance 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 RDS User Guide.
This setting doesn't apply to RDS Custom.
- EnableCustomerOwnedIp
-
- Type: boolean
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- EnableIAMDatabaseAuthentication
-
- Type: boolean
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
- Engine
-
- Type: string
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Valid Values:
-
db2-ae
-
db2-se
-
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
Default: The same as source
Constraints:
-
Must be compatible with the engine of the source.
- EngineLifecycleSupport
-
- Type: string
The life cycle type for this DB instance.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- Iops
-
- Type: int
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
This setting doesn't apply to SQL Server.
Constraints:
-
Must be an integer greater than 1000.
- LicenseModel
-
- Type: string
The license model information for the restored DB instance.
License models for RDS for Db2 require additional configuration. The Bring Your Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
-
RDS for Db2 -
bring-your-own-license | marketplace-license
-
RDS for MariaDB -
general-public-license
-
RDS for Microsoft SQL Server -
license-included
-
RDS for MySQL -
general-public-license
-
RDS for Oracle -
bring-your-own-license | license-included
-
RDS for PostgreSQL -
postgresql-license
Default: Same as the source.
- MaxAllocatedStorage
-
- Type: int
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
- MultiAZ
-
- Type: boolean
Secifies whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraints:
-
You can't specify the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
- NetworkType
-
- Type: string
The network type of the DB instance.
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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 RDS User Guide.
Valid Values:
-
IPV4
-
DUAL
- OptionGroupName
-
- Type: string
The name of the option group to use for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
- Port
-
- Type: int
The port number on which the database accepts connections.
Default: The same port as the original DB instance.
Constraints:
-
The value must be
1150-65535
.
- ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
- PubliclyAccessible
-
- Type: boolean
Specifies whether the DB instance 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 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.
- RestoreTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time to restore from.
Constraints:
-
Must be a time in Universal Coordinated Time (UTC) format.
-
Must be before the latest restorable time for the DB instance.
-
Can't be specified if the
UseLatestRestorableTime
parameter is enabled.
Example:
2009-09-07T23:45:00Z
- SourceDBInstanceAutomatedBackupsArn
-
- Type: string
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.This setting doesn't apply to RDS Custom.
- SourceDBInstanceIdentifier
-
- Type: string
The identifier of the source DB instance from which to restore.
Constraints:
-
Must match the identifier of an existing DB instance.
- SourceDbiResourceId
-
- Type: string
The resource ID of the source DB instance from which to restore.
- StorageThroughput
-
- Type: int
The storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
- StorageType
-
- Type: string
The storage type to associate with the DB instance.
Valid Values:
gp2 | gp3 | io1 | io2 | standard
Default:
io1
, if theIops
parameter is specified. Otherwise,gp2
.Constraints:
-
If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetDBInstanceIdentifier
-
- Required: Yes
- Type: string
The name of the new DB instance to create.
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.
- TdeCredentialArn
-
- Type: string
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
- TdeCredentialPassword
-
- Type: string
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
- UseDefaultProcessorFeatures
-
- Type: boolean
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
- UseLatestRestorableTime
-
- Type: boolean
Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints:
-
Can't be specified if the
RestoreTime
parameter is provided.
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceAlreadyExistsFault:
The user already has a DB instance with the given identifier.
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InstanceQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB instances.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- PointInTimeRestoreNotEnabledFault:
SourceDBInstanceIdentifier
refers to a DB instance withBackupRetentionPeriod
equal to 0.- StorageQuotaExceededFault:
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidRestoreFault:
Cannot restore from VPC backup to non-VPC DB instance.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- ProvisionedIopsNotAvailableInAZFault:
Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundFault:
The specified option group could not be found.
- StorageTypeNotSupportedFault:
The specified
StorageType
can't be associated with the DB instance.- AuthorizationNotFoundFault:
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.- DomainNotFoundFault:
Domain
doesn't refer to an existing Active Directory domain.- BackupPolicyNotFoundFault:
- This error does not currently have a description.
- DBParameterGroupNotFoundFault:
DBParameterGroupName
doesn't refer to an existing DB parameter group.- DBInstanceAutomatedBackupNotFoundFault:
No automated backup for this DB instance was found.
- NetworkTypeNotSupported:
The network type is invalid for the DB instance. Valid nework type values are
IPV4
andDUAL
.- TenantDatabaseQuotaExceededFault:
You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- CertificateNotFoundFault:
CertificateIdentifier
doesn't refer to an existing certificate.
Examples
Example 1: To restore a DB instance to a point in time
The following example restores test-instance to a new DB instance named restored-test-instance, as of the specified time.
$result = $client->restoreDBInstanceToPointInTime([ 'RestoreTime' =>, 'SourceDBInstanceIdentifier' => 'test-instance', 'TargetDBInstanceIdentifier' => 'restored-test-instance', ]);
Result syntax:
[ 'DBInstance' => [ 'AllocatedStorage' => 200, 'AutoMinorVersionUpgrade' => 1, 'AvailabilityZone' => 'us-west-2b', 'BackupRetentionPeriod' => 7, 'CACertificateIdentifier' => 'rds-ca-2015', 'CopyTagsToSnapshot' => , 'DBInstanceArn' => 'arn:aws:rds:us-west-2:123456789012:db:restored-test-instance', 'DBInstanceClass' => 'db.t2.small', 'DBInstanceIdentifier' => 'restored-test-instance', 'DBInstanceStatus' => 'available', 'DBName' => 'sample', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => 'default.mysql5.6', 'ParameterApplyStatus' => 'in-sync', ], ], 'DBSecurityGroups' => [ ], 'DBSubnetGroup' => [ 'DBSubnetGroupDescription' => 'default', 'DBSubnetGroupName' => 'default', 'SubnetGroupStatus' => 'Complete', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2a', ], 'SubnetIdentifier' => 'subnet-77e8db03', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2b', ], 'SubnetIdentifier' => 'subnet-c39989a1', 'SubnetStatus' => 'Active', ], [ 'SubnetAvailabilityZone' => [ 'Name' => 'us-west-2c', ], 'SubnetIdentifier' => 'subnet-4b267b0d', 'SubnetStatus' => 'Active', ], ], 'VpcId' => 'vpc-c1c5b3a3', ], 'DbInstancePort' => 0, 'DbiResourceId' => 'db-VNZUCCBTEDC4WR7THXNJO72HVQ', 'DomainMemberships' => [ ], 'Engine' => 'mysql', 'EngineVersion' => '5.6.27', 'LicenseModel' => 'general-public-license', 'MasterUsername' => 'mymasteruser', 'MonitoringInterval' => 0, 'MultiAZ' => , 'OptionGroupMemberships' => [ [ 'OptionGroupName' => 'default:mysql-5-6', 'Status' => 'in-sync', ], ], 'PendingModifiedValues' => [ ], 'PreferredBackupWindow' => '12:58-13:28', 'PreferredMaintenanceWindow' => 'tue:10:16-tue:10:46', 'PubliclyAccessible' => 1, 'ReadReplicaDBInstanceIdentifiers' => [ ], 'StorageEncrypted' => , 'StorageType' => 'gp2', 'VpcSecurityGroups' => [ [ 'Status' => 'active', 'VpcSecurityGroupId' => 'sg-e5e5b0d2', ], ], ], ]
RevokeDBSecurityGroupIngress
$result = $client->revokeDBSecurityGroupIngress
([/* ... */]); $promise = $client->revokeDBSecurityGroupIngressAsync
([/* ... */]);
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->revokeDBSecurityGroupIngress([ 'CIDRIP' => '<string>', 'DBSecurityGroupName' => '<string>', // REQUIRED 'EC2SecurityGroupId' => '<string>', 'EC2SecurityGroupName' => '<string>', 'EC2SecurityGroupOwnerId' => '<string>', ]);
Parameter Details
Members
- CIDRIP
-
- Type: string
The IP range to revoke access from. Must be a valid CIDR range. If
CIDRIP
is specified,EC2SecurityGroupName
,EC2SecurityGroupId
andEC2SecurityGroupOwnerId
can't be provided. - DBSecurityGroupName
-
- Required: Yes
- Type: string
The name of the DB security group to revoke ingress from.
- EC2SecurityGroupId
-
- Type: string
The id of the EC2 security group to revoke access from. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided. - EC2SecurityGroupName
-
- Type: string
The name of the EC2 security group to revoke access from. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided. - EC2SecurityGroupOwnerId
-
- Type: string
The Amazon Web Services account number of the owner of the EC2 security group specified in the
EC2SecurityGroupName
parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups,EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.
Result Syntax
[ 'DBSecurityGroup' => [ 'DBSecurityGroupArn' => '<string>', 'DBSecurityGroupDescription' => '<string>', 'DBSecurityGroupName' => '<string>', 'EC2SecurityGroups' => [ [ 'EC2SecurityGroupId' => '<string>', 'EC2SecurityGroupName' => '<string>', 'EC2SecurityGroupOwnerId' => '<string>', 'Status' => '<string>', ], // ... ], 'IPRanges' => [ [ 'CIDRIP' => '<string>', 'Status' => '<string>', ], // ... ], 'OwnerId' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBSecurityGroup
-
- Type: DBSecurityGroup structure
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
Errors
- DBSecurityGroupNotFoundFault:
DBSecurityGroupName
doesn't refer to an existing DB security group.- AuthorizationNotFoundFault:
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- InvalidDBSecurityGroupStateFault:
The state of the DB security group doesn't allow deletion.
Examples
Example 1: To revoke ingress for a DB security group
This example revokes ingress for the specified CIDR block associated with the specified DB security group.
$result = $client->revokeDBSecurityGroupIngress([ 'CIDRIP' => '203.0.113.5/32', 'DBSecurityGroupName' => 'mydbsecuritygroup', ]);
Result syntax:
[ 'DBSecurityGroup' => [ ], ]
StartActivityStream
$result = $client->startActivityStream
([/* ... */]); $promise = $client->startActivityStreamAsync
([/* ... */]);
Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->startActivityStream([ 'ApplyImmediately' => true || false, 'EngineNativeAuditFieldsIncluded' => true || false, 'KmsKeyId' => '<string>', // REQUIRED 'Mode' => 'sync|async', // REQUIRED 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ApplyImmediately
-
- Type: boolean
Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
- EngineNativeAuditFieldsIncluded
-
- Type: boolean
Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
- KmsKeyId
-
- Required: Yes
- Type: string
The Amazon Web Services KMS key identifier 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.
- Mode
-
- Required: Yes
- Type: string
Specifies 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.
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB cluster, for example,
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster
.
Result Syntax
[ 'ApplyImmediately' => true || false, 'EngineNativeAuditFieldsIncluded' => true || false, 'KinesisStreamName' => '<string>', 'KmsKeyId' => '<string>', 'Mode' => 'sync|async', 'Status' => 'stopped|starting|started|stopping', ]
Result Details
Members
- ApplyImmediately
-
- Type: boolean
Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
- EngineNativeAuditFieldsIncluded
-
- Type: boolean
Indicates whether engine-native audit fields are included in the database activity stream.
- KinesisStreamName
-
- Type: string
The name of the Amazon Kinesis data stream to be used for the database activity stream.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
- Mode
-
- Type: string
The mode of the database activity stream.
- Status
-
- Type: string
The status of the database activity stream.
Errors
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- ResourceNotFoundFault:
The specified resource ID was not found.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
Examples
Example 1: To start a database activity stream
The following example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.
$result = $client->startActivityStream([ 'ApplyImmediately' => 1, 'KmsKeyId' => 'arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1', 'Mode' => 'async', 'ResourceArn' => 'arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster', ]);
Result syntax:
[ 'ApplyImmediately' => 1, 'KinesisStreamName' => 'aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S', 'KmsKeyId' => 'arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1', 'Mode' => 'async', 'Status' => 'starting', ]
StartDBCluster
$result = $client->startDBCluster
([/* ... */]); $promise = $client->startDBClusterAsync
([/* ... */]);
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster
operation.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
Parameter Syntax
$result = $client->startDBCluster([ 'DBClusterIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To start a DB cluster
The following example starts a DB cluster and its DB instances.
$result = $client->startDBCluster([ 'DBClusterIdentifier' => 'mydbcluster', ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 1, 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1e', 'us-east-1b', ], 'BackupRetentionPeriod' => 1, 'DBClusterIdentifier' => 'mydbcluster', 'DatabaseName' => 'mydb', ], // Some output ommitted. ]
StartDBInstance
$result = $client->startDBInstance
([/* ... */]); $promise = $client->startDBInstanceAsync
([/* ... */]);
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance
operation.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster
instead.
Parameter Syntax
$result = $client->startDBInstance([ 'DBInstanceIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The user-supplied instance identifier.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- InsufficientDBInstanceCapacityFault:
The specified DB instance class isn't available in the specified Availability Zone.
- DBSubnetGroupNotFoundFault:
DBSubnetGroupName
doesn't refer to an existing DB subnet group.- DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidSubnet:
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVPCNetworkStateFault:
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- AuthorizationNotFoundFault:
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
Examples
Example 1: To start a DB instance
The following example starts the specified DB instance.
$result = $client->startDBInstance([ 'DBInstanceIdentifier' => 'test-instance', ]);
Result syntax:
[ 'DBInstance' => [ 'DBInstanceStatus' => 'starting', ], // Some output ommitted. ]
StartDBInstanceAutomatedBackupsReplication
$result = $client->startDBInstanceAutomatedBackupsReplication
([/* ... */]); $promise = $client->startDBInstanceAutomatedBackupsReplicationAsync
([/* ... */]);
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->startDBInstanceAutomatedBackupsReplication([ 'BackupRetentionPeriod' => <integer>, 'KmsKeyId' => '<string>', 'PreSignedUrl' => '<string>', 'SourceDBInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- BackupRetentionPeriod
-
- Type: int
The retention period for the replicated automated backups.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example,
arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE
. - PreSignedUrl
-
- Type: string
In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the
StartDBInstanceAutomatedBackupsReplication
operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for theStartDBInstanceAutomatedBackupsReplication
API operation that can run in the Amazon Web Services Region that contains the source DB instance.This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify
SourceRegion
(or--source-region
for the CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region. - SourceDBInstanceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase
.
Result Syntax
[ 'DBInstanceAutomatedBackup' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'Port' => <integer>, 'Region' => '<string>', 'RestoreWindow' => [ 'EarliestTime' => <DateTime>, 'LatestTime' => <DateTime>, ], 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBInstanceAutomatedBackup
-
- Type: DBInstanceAutomatedBackup structure
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- DBInstanceAutomatedBackupQuotaExceededFault:
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
- StorageTypeNotSupportedFault:
The specified
StorageType
can't be associated with the DB instance.
Examples
Example 1: To enable cross-Region automated backups
The following example replicates automated backups from a DB instance in the US East (N. Virginia) Region. The backup retention period is 14 days.
$result = $client->startDBInstanceAutomatedBackupsReplication([ 'BackupRetentionPeriod' => 14, 'SourceDBInstanceArn' => 'arn:aws:rds:us-east-1:123456789012:db:new-orcl-db', ]);
Result syntax:
[ 'DBInstanceAutomatedBackup' => [ 'AllocatedStorage' => 20, 'BackupRetentionPeriod' => 14, 'DBInstanceArn' => 'arn:aws:rds:us-east-1:123456789012:db:new-orcl-db', 'DBInstanceAutomatedBackupsArn' => 'arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example', 'DBInstanceIdentifier' => 'new-orcl-db', 'DbiResourceId' => 'db-JKIB2GFQ5RV7REPLZA4EXAMPLE', 'Encrypted' => , 'Engine' => 'oracle-se2', 'EngineVersion' => '12.1.0.2.v21', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'LicenseModel' => 'bring-your-own-license', 'MasterUsername' => 'admin', 'OptionGroupName' => 'default:oracle-se2-12-1', 'Port' => 1521, 'Region' => 'us-east-1', 'RestoreWindow' => [ ], 'Status' => 'pending', 'StorageType' => 'gp2', ], ]
StartExportTask
$result = $client->startExportTask
([/* ... */]); $promise = $client->startExportTaskAsync
([/* ... */]);
Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can't export snapshot data from Db2 or RDS Custom DB instances.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->startExportTask([ 'ExportOnly' => ['<string>', ...], 'ExportTaskIdentifier' => '<string>', // REQUIRED 'IamRoleArn' => '<string>', // REQUIRED 'KmsKeyId' => '<string>', // REQUIRED 'S3BucketName' => '<string>', // REQUIRED 'S3Prefix' => '<string>', 'SourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ExportOnly
-
- Type: Array of strings
The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.
Valid Values:
-
database
- Export all the data from a specified database. -
database.table
table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schema
schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
- ExportTaskIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.
- IamRoleArn
-
- Required: Yes
- Type: string
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
-
s3:PutObject*
-
s3:GetObject*
-
s3:ListBucket
-
s3:DeleteObject*
-
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
-
arn:aws:s3:::your-s3-bucket
-
arn:aws:s3:::your-s3-bucket/*
- KmsKeyId
-
- Required: Yes
- Type: string
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
-
kms:Encrypt
-
kms:Decrypt
-
kms:GenerateDataKey
-
kms:GenerateDataKeyWithoutPlaintext
-
kms:ReEncryptFrom
-
kms:ReEncryptTo
-
kms:CreateGrant
-
kms:DescribeKey
-
kms:RetireGrant
- S3BucketName
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket to export the snapshot or cluster data to.
- S3Prefix
-
- Type: string
The Amazon S3 bucket prefix to use as the file name and path of the exported data.
- SourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
Result Syntax
[ 'ExportOnly' => ['<string>', ...], 'ExportTaskIdentifier' => '<string>', 'FailureCause' => '<string>', 'IamRoleArn' => '<string>', 'KmsKeyId' => '<string>', 'PercentProgress' => <integer>, 'S3Bucket' => '<string>', 'S3Prefix' => '<string>', 'SnapshotTime' => <DateTime>, 'SourceArn' => '<string>', 'SourceType' => 'SNAPSHOT|CLUSTER', 'Status' => '<string>', 'TaskEndTime' => <DateTime>, 'TaskStartTime' => <DateTime>, 'TotalExtractedDataInGB' => <integer>, 'WarningMessage' => '<string>', ]
Result Details
Members
- ExportOnly
-
- Type: Array of strings
The data exported from the snapshot or cluster.
Valid Values:
-
database
- Export all the data from a specified database. -
database.table
table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schema
schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
- ExportTaskIdentifier
-
- Type: string
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
- FailureCause
-
- Type: string
The reason the export failed, if it failed.
- IamRoleArn
-
- Type: string
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
- KmsKeyId
-
- Type: string
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
- PercentProgress
-
- Type: int
The progress of the snapshot or cluster export task as a percentage.
- S3Bucket
-
- Type: string
The Amazon S3 bucket where the snapshot or cluster is exported to.
- S3Prefix
-
- Type: string
The Amazon S3 bucket prefix that is the file name and path of the exported data.
- SnapshotTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot was created.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
- SourceType
-
- Type: string
The type of source for the export.
- Status
-
- Type: string
The progress status of the export task. The status can be one of the following:
-
CANCELED
-
CANCELING
-
COMPLETE
-
FAILED
-
IN_PROGRESS
-
STARTING
- TaskEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot or cluster export task ended.
- TaskStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot or cluster export task started.
- TotalExtractedDataInGB
-
- Type: int
The total amount of data exported, in gigabytes.
- WarningMessage
-
- Type: string
A warning about the snapshot or cluster export task.
Errors
- DBSnapshotNotFoundFault:
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.- DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- ExportTaskAlreadyExistsFault:
You can't start an export task that's already running.
- InvalidS3BucketFault:
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- IamRoleNotFoundFault:
The IAM role is missing for exporting to an Amazon S3 bucket.
- IamRoleMissingPermissionsFault:
The IAM role requires additional permissions to export to an Amazon S3 bucket.
- InvalidExportOnlyFault:
The export is invalid for exporting to an Amazon S3 bucket.
- KMSKeyNotAccessibleFault:
An error occurred accessing an Amazon Web Services KMS key.
- InvalidExportSourceStateFault:
The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
Examples
Example 1: To export a snapshot to Amazon S3
The following example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.
$result = $client->startExportTask([ 'ExportTaskIdentifier' => 'my-s3-export', 'IamRoleArn' => 'arn:aws:iam::123456789012:role/service-role/ExportRole', 'KmsKeyId' => 'arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff', 'S3BucketName' => 'mybucket', 'SourceArn' => 'arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test', ]);
Result syntax:
[ 'ExportTaskIdentifier' => 'my-s3-export', 'IamRoleArn' => 'arn:aws:iam::123456789012:role/service-role/ExportRole', 'KmsKeyId' => 'arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff', 'PercentProgress' => 0, 'S3Bucket' => 'mybucket', 'SnapshotTime' =>, 'SourceArn' => 'arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test', 'Status' => 'STARTING', 'TotalExtractedDataInGB' => 0, ]
StopActivityStream
$result = $client->stopActivityStream
([/* ... */]); $promise = $client->stopActivityStreamAsync
([/* ... */]);
Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream
CLI command, or the StartActivityStream
operation.
For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->stopActivityStream([ 'ApplyImmediately' => true || false, 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ApplyImmediately
-
- Type: boolean
Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example,
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster
.
Result Syntax
[ 'KinesisStreamName' => '<string>', 'KmsKeyId' => '<string>', 'Status' => 'stopped|starting|started|stopping', ]
Result Details
Members
- KinesisStreamName
-
- Type: string
The name of the Amazon Kinesis data stream used for the database activity stream.
- KmsKeyId
-
- Type: 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.
- Status
-
- Type: string
The status of the database activity stream.
Errors
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- ResourceNotFoundFault:
The specified resource ID was not found.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.
Examples
Example 1: To stop a database activity stream
The following example stops an activity stream in an Aurora cluster named my-pg-cluster.
$result = $client->stopActivityStream([ 'ApplyImmediately' => 1, 'ResourceArn' => 'arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster', ]);
Result syntax:
[ 'KinesisStreamName' => 'aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S', 'KmsKeyId' => 'arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1', 'Status' => 'stopping', ]
StopDBCluster
$result = $client->stopDBCluster
([/* ... */]); $promise = $client->stopDBClusterAsync
([/* ... */]);
Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
Parameter Syntax
$result = $client->stopDBCluster([ 'DBClusterIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBClusterIdentifier
-
- Required: Yes
- Type: string
The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
Result Syntax
[ 'DBCluster' => [ 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AvailabilityZones' => ['<string>', ...], 'AwsBackupRecoveryPointArn' => '<string>', 'BacktrackConsumedChangeRecords' => <integer>, 'BacktrackWindow' => <integer>, 'BackupRetentionPeriod' => <integer>, 'Capacity' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CloneGroupId' => '<string>', 'ClusterCreateTime' => <DateTime>, 'ClusterScalabilityType' => 'standard|limitless', 'CopyTagsToSnapshot' => true || false, 'CrossAccountClone' => true || false, 'CustomEndpoints' => ['<string>', ...], 'DBClusterArn' => '<string>', 'DBClusterIdentifier' => '<string>', 'DBClusterInstanceClass' => '<string>', 'DBClusterMembers' => [ [ 'DBClusterParameterGroupStatus' => '<string>', 'DBInstanceIdentifier' => '<string>', 'IsClusterWriter' => true || false, 'PromotionTier' => <integer>, ], // ... ], 'DBClusterOptionGroupMemberships' => [ [ 'DBClusterOptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBClusterParameterGroup' => '<string>', 'DBSubnetGroup' => '<string>', 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DatabaseName' => '<string>', 'DbClusterResourceId' => '<string>', 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EarliestBacktrackTime' => <DateTime>, 'EarliestRestorableTime' => <DateTime>, 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineMode' => '<string>', 'EngineVersion' => '<string>', 'GlobalWriteForwardingRequested' => true || false, 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'HostedZoneId' => '<string>', 'HttpEndpointEnabled' => true || false, 'IAMDatabaseAuthenticationEnabled' => true || false, 'IOOptimizedNextAllowedModificationTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LimitlessDatabase' => [ 'MinRequiredACU' => <float>, 'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error', ], 'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested', 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'NetworkType' => '<string>', 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'BackupRetentionPeriod' => <integer>, 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'DBClusterIdentifier' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'MasterUserPassword' => '<string>', 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'Port' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'PubliclyAccessible' => true || false, 'RdsCustomClusterConfiguration' => [ 'InterconnectSubnetId' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'TransitGatewayMulticastDomainId' => '<string>', ], 'ReadReplicaIdentifiers' => ['<string>', ...], 'ReaderEndpoint' => '<string>', 'ReplicationSourceIdentifier' => '<string>', 'ScalingConfigurationInfo' => [ 'AutoPause' => true || false, 'MaxCapacity' => <integer>, 'MinCapacity' => <integer>, 'SecondsBeforeTimeout' => <integer>, 'SecondsUntilAutoPause' => <integer>, 'TimeoutAction' => '<string>', ], 'ServerlessV2ScalingConfiguration' => [ 'MaxCapacity' => <float>, 'MinCapacity' => <float>, 'SecondsUntilAutoPause' => <integer>, ], 'Status' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBCluster
-
- Type: 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.
Errors
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To stop a DB cluster
The following example stops a DB cluster and its DB instances.
$result = $client->stopDBCluster([ 'DBClusterIdentifier' => 'mydbcluster', ]);
Result syntax:
[ 'DBCluster' => [ 'AllocatedStorage' => 1, 'AvailabilityZones' => [ 'us-east-1a', 'us-east-1e', 'us-east-1b', ], 'BackupRetentionPeriod' => 1, 'DBClusterIdentifier' => 'mydbcluster', 'DatabaseName' => 'mydb', ], // Some output ommitted. ]
StopDBInstance
$result = $client->stopDBInstance
([/* ... */]); $promise = $client->stopDBInstanceAsync
([/* ... */]);
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster
instead.
Parameter Syntax
$result = $client->stopDBInstance([ 'DBInstanceIdentifier' => '<string>', // REQUIRED 'DBSnapshotIdentifier' => '<string>', ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The user-supplied instance identifier.
- DBSnapshotIdentifier
-
- Type: string
The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
- DBSnapshotAlreadyExistsFault:
DBSnapshotIdentifier
is already used by an existing snapshot.- SnapshotQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
Examples
Example 1: To stop a DB instance
The following example stops the specified DB instance.
$result = $client->stopDBInstance([ 'DBInstanceIdentifier' => 'test-instance', ]);
Result syntax:
[ 'DBInstance' => [ 'DBInstanceStatus' => 'stopping', ], // Some output ommitted. ]
StopDBInstanceAutomatedBackupsReplication
$result = $client->stopDBInstanceAutomatedBackupsReplication
([/* ... */]); $promise = $client->stopDBInstanceAutomatedBackupsReplicationAsync
([/* ... */]);
Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
Parameter Syntax
$result = $client->stopDBInstanceAutomatedBackupsReplication([ 'SourceDBInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SourceDBInstanceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automate backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase
.
Result Syntax
[ 'DBInstanceAutomatedBackup' => [ 'AllocatedStorage' => <integer>, 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceIdentifier' => '<string>', 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'Encrypted' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'KmsKeyId' => '<string>', 'LicenseModel' => '<string>', 'MasterUsername' => '<string>', 'MultiTenant' => true || false, 'OptionGroupName' => '<string>', 'Port' => <integer>, 'Region' => '<string>', 'RestoreWindow' => [ 'EarliestTime' => <DateTime>, 'LatestTime' => <DateTime>, ], 'Status' => '<string>', 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcId' => '<string>', ], ]
Result Details
Members
- DBInstanceAutomatedBackup
-
- Type: DBInstanceAutomatedBackup structure
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Examples
Example 1: To stop replicating automated backups
The following example ends replication of automated backups. Replicated backups are retained according to the set backup retention period.
$result = $client->stopDBInstanceAutomatedBackupsReplication([ 'SourceDBInstanceArn' => 'arn:aws:rds:us-east-1:123456789012:db:new-orcl-db', ]);
Result syntax:
[ 'DBInstanceAutomatedBackup' => [ 'AllocatedStorage' => 20, 'BackupRetentionPeriod' => 7, 'DBInstanceArn' => 'arn:aws:rds:us-east-1:123456789012:db:new-orcl-db', 'DBInstanceAutomatedBackupsArn' => 'arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example', 'DBInstanceIdentifier' => 'new-orcl-db', 'DbiResourceId' => 'db-JKIB2GFQ5RV7REPLZA4EXAMPLE', 'Encrypted' => , 'Engine' => 'oracle-se2', 'EngineVersion' => '12.1.0.2.v21', 'IAMDatabaseAuthenticationEnabled' => , 'InstanceCreateTime' =>, 'LicenseModel' => 'bring-your-own-license', 'MasterUsername' => 'admin', 'OptionGroupName' => 'default:oracle-se2-12-1', 'Port' => 1521, 'Region' => 'us-east-1', 'RestoreWindow' => [ 'EarliestTime' => , 'LatestTime' => , ], 'Status' => 'replicating', 'StorageType' => 'gp2', ], ]
SwitchoverBlueGreenDeployment
$result = $client->switchoverBlueGreenDeployment
([/* ... */]); $promise = $client->switchoverBlueGreenDeploymentAsync
([/* ... */]);
Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Parameter Syntax
$result = $client->switchoverBlueGreenDeployment([ 'BlueGreenDeploymentIdentifier' => '<string>', // REQUIRED 'SwitchoverTimeout' => <integer>, ]);
Parameter Details
Members
- BlueGreenDeploymentIdentifier
-
- Required: Yes
- Type: string
The resource ID of the blue/green deployment.
Constraints:
-
Must match an existing blue/green deployment resource ID.
- SwitchoverTimeout
-
- Type: int
The amount of time, in seconds, for the switchover to complete.
Default: 300
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.
Result Syntax
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => '<string>', 'BlueGreenDeploymentName' => '<string>', 'CreateTime' => <DateTime>, 'DeleteTime' => <DateTime>, 'Source' => '<string>', 'Status' => '<string>', 'StatusDetails' => '<string>', 'SwitchoverDetails' => [ [ 'SourceMember' => '<string>', 'Status' => '<string>', 'TargetMember' => '<string>', ], // ... ], 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Target' => '<string>', 'Tasks' => [ [ 'Name' => '<string>', 'Status' => '<string>', ], // ... ], ], ]
Result Details
Members
- BlueGreenDeployment
-
- Type: BlueGreenDeployment structure
Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Errors
- BlueGreenDeploymentNotFoundFault:
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.- InvalidBlueGreenDeploymentStateFault:
The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.
Examples
Example 1: To switch a blue/green deployment for an RDS DB instance
The following example promotes the specified green environment as the new production environment.
$result = $client->switchoverBlueGreenDeployment([ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', 'SwitchoverTimeout' => 300, ]);
Result syntax:
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => 'bgd-v53303651eexfake', 'BlueGreenDeploymentName' => 'bgd-cli-test-instance', 'CreateTime' =>, 'Source' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', 'Status' => 'SWITCHOVER_IN_PROGRESS', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-k5fv7u', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ggsh8m', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-o2vwm0', ], ], 'Target' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e', 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'COMPLETED', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'COMPLETED', ], [ 'Name' => 'CONFIGURE_BACKUPS', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATING_TOPOLOGY_OF_SOURCE', 'Status' => 'COMPLETED', ], ], ], ]
Example 2: To promote a blue/green deployment for an Aurora MySQL DB cluster
The following example promotes the specified green environment as the new production environment.
$result = $client->switchoverBlueGreenDeployment([ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', 'SwitchoverTimeout' => 300, ]);
Result syntax:
[ 'BlueGreenDeployment' => [ 'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake', 'BlueGreenDeploymentName' => 'my-blue-green-deployment', 'CreateTime' =>, 'Source' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Status' => 'SWITCHOVER_IN_PROGRESS', 'SwitchoverDetails' => [ [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-bvxc73', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-7wc4ie', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-p4xxkz', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-np1ikl', ], [ 'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint', 'Status' => 'AVAILABLE', 'TargetMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-miszlf', ], ], 'Target' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6', 'Tasks' => [ [ 'Name' => 'CREATING_READ_REPLICA_OF_SOURCE', 'Status' => 'COMPLETED', ], [ 'Name' => 'DB_ENGINE_VERSION_UPGRADE', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATE_DB_INSTANCES_FOR_CLUSTER', 'Status' => 'COMPLETED', ], [ 'Name' => 'CREATE_CUSTOM_ENDPOINTS', 'Status' => 'COMPLETED', ], ], ], ]
SwitchoverGlobalCluster
$result = $client->switchoverGlobalCluster
([/* ... */]); $promise = $client->switchoverGlobalClusterAsync
([/* ... */]);
Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.
Parameter Syntax
$result = $client->switchoverGlobalCluster([ 'GlobalClusterIdentifier' => '<string>', // REQUIRED 'TargetDbClusterIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- GlobalClusterIdentifier
-
- Required: Yes
- Type: string
The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing global database cluster (Aurora global database).
- TargetDbClusterIdentifier
-
- Required: Yes
- Type: string
The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
Result Syntax
[ 'GlobalCluster' => [ 'DatabaseName' => '<string>', 'DeletionProtection' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'FailoverState' => [ 'FromDbClusterArn' => '<string>', 'IsDataLossAllowed' => true || false, 'Status' => 'pending|failing-over|cancelling', 'ToDbClusterArn' => '<string>', ], 'GlobalClusterArn' => '<string>', 'GlobalClusterIdentifier' => '<string>', 'GlobalClusterMembers' => [ [ 'DBClusterArn' => '<string>', 'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown', 'IsWriter' => true || false, 'Readers' => ['<string>', ...], 'SynchronizationStatus' => 'connected|pending-resync', ], // ... ], 'GlobalClusterResourceId' => '<string>', 'Status' => '<string>', 'StorageEncrypted' => true || false, 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
Errors
- GlobalClusterNotFoundFault:
The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster.- InvalidGlobalClusterStateFault:
The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDBClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
- DBClusterNotFoundFault:
DBClusterIdentifier
doesn't refer to an existing DB cluster.
SwitchoverReadReplica
$result = $client->switchoverReadReplica
([/* ... */]); $promise = $client->switchoverReadReplicaAsync
([/* ... */]);
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.
Parameter Syntax
$result = $client->switchoverReadReplica([ 'DBInstanceIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DBInstanceIdentifier
-
- Required: Yes
- Type: string
The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing Oracle read replica DB instance.
Result Syntax
[ 'DBInstance' => [ 'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false, 'ActivityStreamKinesisStreamName' => '<string>', 'ActivityStreamKmsKeyId' => '<string>', 'ActivityStreamMode' => 'sync|async', 'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy', 'ActivityStreamStatus' => 'stopped|starting|started|stopping', 'AllocatedStorage' => <integer>, 'AssociatedRoles' => [ [ 'FeatureName' => '<string>', 'RoleArn' => '<string>', 'Status' => '<string>', ], // ... ], 'AutoMinorVersionUpgrade' => true || false, 'AutomaticRestartTime' => <DateTime>, 'AutomationMode' => 'full|all-paused', 'AvailabilityZone' => '<string>', 'AwsBackupRecoveryPointArn' => '<string>', 'BackupRetentionPeriod' => <integer>, 'BackupTarget' => '<string>', 'CACertificateIdentifier' => '<string>', 'CertificateDetails' => [ 'CAIdentifier' => '<string>', 'ValidTill' => <DateTime>, ], 'CharacterSetName' => '<string>', 'CopyTagsToSnapshot' => true || false, 'CustomIamInstanceProfile' => '<string>', 'CustomerOwnedIpEnabled' => true || false, 'DBClusterIdentifier' => '<string>', 'DBInstanceArn' => '<string>', 'DBInstanceAutomatedBackupsReplications' => [ [ 'DBInstanceAutomatedBackupsArn' => '<string>', ], // ... ], 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBInstanceStatus' => '<string>', 'DBName' => '<string>', 'DBParameterGroups' => [ [ 'DBParameterGroupName' => '<string>', 'ParameterApplyStatus' => '<string>', ], // ... ], 'DBSecurityGroups' => [ [ 'DBSecurityGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'DBSubnetGroup' => [ 'DBSubnetGroupArn' => '<string>', 'DBSubnetGroupDescription' => '<string>', 'DBSubnetGroupName' => '<string>', 'SubnetGroupStatus' => '<string>', 'Subnets' => [ [ 'SubnetAvailabilityZone' => [ 'Name' => '<string>', ], 'SubnetIdentifier' => '<string>', 'SubnetOutpost' => [ 'Arn' => '<string>', ], 'SubnetStatus' => '<string>', ], // ... ], 'SupportedNetworkTypes' => ['<string>', ...], 'VpcId' => '<string>', ], 'DBSystemId' => '<string>', 'DatabaseInsightsMode' => 'standard|advanced', 'DbInstancePort' => <integer>, 'DbiResourceId' => '<string>', 'DedicatedLogVolume' => true || false, 'DeletionProtection' => true || false, 'DomainMemberships' => [ [ 'AuthSecretArn' => '<string>', 'DnsIps' => ['<string>', ...], 'Domain' => '<string>', 'FQDN' => '<string>', 'IAMRoleName' => '<string>', 'OU' => '<string>', 'Status' => '<string>', ], // ... ], 'EnabledCloudwatchLogsExports' => ['<string>', ...], 'Endpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'Engine' => '<string>', 'EngineLifecycleSupport' => '<string>', 'EngineVersion' => '<string>', 'EnhancedMonitoringResourceArn' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'InstanceCreateTime' => <DateTime>, 'Iops' => <integer>, 'IsStorageConfigUpgradeAvailable' => true || false, 'KmsKeyId' => '<string>', 'LatestRestorableTime' => <DateTime>, 'LicenseModel' => '<string>', 'ListenerEndpoint' => [ 'Address' => '<string>', 'HostedZoneId' => '<string>', 'Port' => <integer>, ], 'MasterUserSecret' => [ 'KmsKeyId' => '<string>', 'SecretArn' => '<string>', 'SecretStatus' => '<string>', ], 'MasterUsername' => '<string>', 'MaxAllocatedStorage' => <integer>, 'MonitoringInterval' => <integer>, 'MonitoringRoleArn' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'NcharCharacterSetName' => '<string>', 'NetworkType' => '<string>', 'OptionGroupMemberships' => [ [ 'OptionGroupName' => '<string>', 'Status' => '<string>', ], // ... ], 'PendingModifiedValues' => [ 'AllocatedStorage' => <integer>, 'AutomationMode' => 'full|all-paused', 'BackupRetentionPeriod' => <integer>, 'CACertificateIdentifier' => '<string>', 'DBInstanceClass' => '<string>', 'DBInstanceIdentifier' => '<string>', 'DBSubnetGroupName' => '<string>', 'DedicatedLogVolume' => true || false, 'Engine' => '<string>', 'EngineVersion' => '<string>', 'IAMDatabaseAuthenticationEnabled' => true || false, 'Iops' => <integer>, 'LicenseModel' => '<string>', 'MasterUserPassword' => '<string>', 'MultiAZ' => true || false, 'MultiTenant' => true || false, 'PendingCloudwatchLogsExports' => [ 'LogTypesToDisable' => ['<string>', ...], 'LogTypesToEnable' => ['<string>', ...], ], 'Port' => <integer>, 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResumeFullAutomationModeTime' => <DateTime>, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', ], 'PercentProgress' => '<string>', 'PerformanceInsightsEnabled' => true || false, 'PerformanceInsightsKMSKeyId' => '<string>', 'PerformanceInsightsRetentionPeriod' => <integer>, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ProcessorFeatures' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'PromotionTier' => <integer>, 'PubliclyAccessible' => true || false, 'ReadReplicaDBClusterIdentifiers' => ['<string>', ...], 'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...], 'ReadReplicaSourceDBClusterIdentifier' => '<string>', 'ReadReplicaSourceDBInstanceIdentifier' => '<string>', 'ReplicaMode' => 'open-read-only|mounted', 'ResumeFullAutomationModeTime' => <DateTime>, 'SecondaryAvailabilityZone' => '<string>', 'StatusInfos' => [ [ 'Message' => '<string>', 'Normal' => true || false, 'Status' => '<string>', 'StatusType' => '<string>', ], // ... ], 'StorageEncrypted' => true || false, 'StorageThroughput' => <integer>, 'StorageType' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'TdeCredentialArn' => '<string>', 'Timezone' => '<string>', 'VpcSecurityGroups' => [ [ 'Status' => '<string>', 'VpcSecurityGroupId' => '<string>', ], // ... ], ], ]
Result Details
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Errors
- DBInstanceNotFoundFault:
DBInstanceIdentifier
doesn't refer to an existing DB instance.- InvalidDBInstanceStateFault:
The DB instance isn't in a valid state.
Shapes
AccountAttributesMessage
Description
Data returned by the DescribeAccountAttributes action.
Members
- AccountQuotas
-
- Type: Array of AccountQuota structures
A list of
AccountQuota
objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
AccountQuota
Description
Describes a quota for an Amazon Web Services account.
The following are account quotas:
-
AllocatedStorage
- The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB. -
AuthorizationsPerDBSecurityGroup
- The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules. -
CustomEndpointsPerDBCluster
- The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints. -
DBClusterParameterGroups
- The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account. -
DBClusterRoles
- The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles. -
DBClusters
- The number of DB clusters per account. The used value is the count of DB clusters in the account. -
DBInstanceRoles
- The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles. -
DBInstances
- The number of DB instances per account. The used value is the count of the DB instances in the account.Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.
-
DBParameterGroups
- The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account. -
DBSecurityGroups
- The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account. -
DBSubnetGroups
- The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account. -
EventSubscriptions
- The number of event subscriptions per account. The used value is the count of the event subscriptions in the account. -
ManualClusterSnapshots
- The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account. -
ManualSnapshots
- The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account. -
OptionGroups
- The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account. -
ReadReplicasPerMaster
- The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas. -
ReservedDBInstances
- The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account. -
SubnetsPerDBSubnetGroup
- The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.
Members
- AccountQuotaName
-
- Type: string
The name of the Amazon RDS quota for this Amazon Web Services account.
- Max
-
- Type: long (int|float)
The maximum allowed value for the quota.
- Used
-
- Type: long (int|float)
The amount currently used toward the quota maximum.
AddSourceIdentifierToSubscriptionResult
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
ApplyPendingMaintenanceActionResult
Members
- ResourcePendingMaintenanceActions
-
- Type: ResourcePendingMaintenanceActions structure
Describes the pending maintenance actions for a resource.
AuthorizationAlreadyExistsFault
Description
The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
Members
AuthorizationNotFoundFault
Description
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
Members
AuthorizationQuotaExceededFault
Description
The DB security group authorization quota has been reached.
Members
AuthorizeDBSecurityGroupIngressResult
Members
- DBSecurityGroup
-
- Type: DBSecurityGroup structure
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
AvailabilityZone
Description
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption
data type.
Members
- Name
-
- Type: string
The name of the Availability Zone.
AvailableProcessorFeature
Description
Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Members
- AllowedValues
-
- Type: string
The allowed values for the processor feature of the DB instance class.
- DefaultValue
-
- Type: string
The default value for the processor feature of the DB instance class.
- Name
-
- Type: string
The name of the processor feature. Valid names are
coreCount
andthreadsPerCore
.
BackupPolicyNotFoundFault
Members
BlueGreenDeployment
Description
Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Members
- BlueGreenDeploymentIdentifier
-
- Type: string
The unique identifier of the blue/green deployment.
- BlueGreenDeploymentName
-
- Type: string
The user-supplied name of the blue/green deployment.
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
- DeleteTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
- Source
-
- Type: string
The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
- Status
-
- Type: string
The status of the blue/green deployment.
Valid Values:
-
PROVISIONING
- Resources are being created in the green environment. -
AVAILABLE
- Resources are available in the green environment. -
SWITCHOVER_IN_PROGRESS
- The deployment is being switched from the blue environment to the green environment. -
SWITCHOVER_COMPLETED
- Switchover from the blue environment to the green environment is complete. -
INVALID_CONFIGURATION
- Resources in the green environment are invalid, so switchover isn't possible. -
SWITCHOVER_FAILED
- Switchover was attempted but failed. -
DELETING
- The blue/green deployment is being deleted.
- StatusDetails
-
- Type: string
Additional information about the status of the blue/green deployment.
- SwitchoverDetails
-
- Type: Array of SwitchoverDetail structures
The details about each source and target resource in the blue/green deployment.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- Target
-
- Type: string
The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
- Tasks
-
- Type: Array of BlueGreenDeploymentTask structures
Either tasks to be performed or tasks that have been completed on the target database before switchover.
BlueGreenDeploymentAlreadyExistsFault
Description
A blue/green deployment with the specified name already exists.
Members
BlueGreenDeploymentNotFoundFault
Description
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
Members
BlueGreenDeploymentTask
Description
Details about a task for a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Members
- Name
-
- Type: string
The name of the blue/green deployment task.
- Status
-
- Type: string
The status of the blue/green deployment task.
Valid Values:
-
PENDING
- The resource is being prepared for deployment. -
IN_PROGRESS
- The resource is being deployed. -
COMPLETED
- The resource has been deployed. -
FAILED
- Deployment of the resource failed.
Certificate
Description
A CA certificate for an Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Members
- CertificateArn
-
- Type: string
The Amazon Resource Name (ARN) for the certificate.
- CertificateIdentifier
-
- Type: string
The unique key that identifies a certificate.
- CertificateType
-
- Type: string
The type of the certificate.
- CustomerOverride
-
- Type: boolean
Indicates whether there is an override for the default certificate identifier.
- CustomerOverrideValidTill
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
If there is an override for the default certificate identifier, when the override expires.
- Thumbprint
-
- Type: string
The thumbprint of the certificate.
- ValidFrom
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The starting date from which the certificate is valid.
- ValidTill
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The final date that the certificate continues to be valid.
CertificateDetails
Description
The details of the DB instance’s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Members
- CAIdentifier
-
- Type: string
The CA identifier of the CA certificate used for the DB instance's server certificate.
- ValidTill
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The expiration date of the DB instance’s server certificate.
CertificateMessage
Description
Data returned by the DescribeCertificates action.
Members
- Certificates
-
- Type: Array of Certificate structures
The list of
Certificate
objects for the Amazon Web Services account. - DefaultCertificateForNewLaunches
-
- Type: string
The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the
ModifyCertificates
operation. - Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeCertificates
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
CertificateNotFoundFault
Description
CertificateIdentifier
doesn't refer to an existing certificate.
Members
CharacterSet
Description
This data type is used as a response element in the action DescribeDBEngineVersions
.
Members
- CharacterSetDescription
-
- Type: string
The description of the character set.
- CharacterSetName
-
- Type: string
The name of the character set.
CloudwatchLogsExportConfiguration
Description
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes
and DisableLogTypes
arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Members
- DisableLogTypes
-
- Type: Array of strings
The list of log types to disable.
- EnableLogTypes
-
- Type: Array of strings
The list of log types to enable.
ClusterPendingModifiedValues
Description
This data type is used as a response element in the ModifyDBCluster
operation and contains changes that will be applied during the next maintenance window.
Members
- AllocatedStorage
-
- Type: int
The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora,
AllocatedStorage
always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. - BackupRetentionPeriod
-
- Type: int
The number of days for which automatic DB snapshots are retained.
- CertificateDetails
-
- Type: CertificateDetails structure
The details of the DB instance’s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- DBClusterIdentifier
-
- Type: string
The DBClusterIdentifier value for the DB cluster.
- EngineVersion
-
- Type: string
The database engine version.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- Iops
-
- Type: int
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
- MasterUserPassword
-
- Type: string
The master credentials for the DB cluster.
- PendingCloudwatchLogsExports
-
- Type: 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.
- RdsCustomClusterConfiguration
-
- Type: RdsCustomClusterConfiguration structure
Reserved for future use.
- StorageType
-
- Type: string
The storage type for the DB cluster.
ConnectionPoolConfiguration
Description
Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup
.
Members
- ConnectionBorrowTimeout
-
- Type: int
The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
Default:
120
Constraints:
-
Must be between 0 and 3600.
- InitQuery
-
- Type: string
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with
SET
statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a singleSET
statement, such asSET x=1, y=2
.Default: no initialization query
- MaxConnectionsPercent
-
- Type: int
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the
max_connections
setting for the RDS DB instance or Aurora DB cluster used by the target group.If you specify
MaxIdleConnectionsPercent
, then you must also include a value for this parameter.Default:
10
for RDS for Microsoft SQL Server, and100
for all other enginesConstraints:
-
Must be between 1 and 100.
- MaxIdleConnectionsPercent
-
- Type: int
A value that controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the
max_connections
setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.If you specify this parameter, then you must also include a value for
MaxConnectionsPercent
.Default: The default value is half of the value of
MaxConnectionsPercent
. For example, ifMaxConnectionsPercent
is 80, then the default value ofMaxIdleConnectionsPercent
is 40. If the value ofMaxConnectionsPercent
isn't specified, then for SQL Server,MaxIdleConnectionsPercent
is5
, and for all other engines, the default is50
.Constraints:
-
Must be between 0 and the value of
MaxConnectionsPercent
.
- SessionPinningFilters
-
- Type: Array of strings
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters
ConnectionPoolConfigurationInfo
Description
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget
.
Members
- ConnectionBorrowTimeout
-
- Type: int
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
- InitQuery
-
- Type: string
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with
SET
statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a singleSET
statement, such asSET x=1, y=2
. - MaxConnectionsPercent
-
- Type: int
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the
max_connections
setting for the RDS DB instance or Aurora DB cluster used by the target group. - MaxIdleConnectionsPercent
-
- Type: int
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the
max_connections
setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database. - SessionPinningFilters
-
- Type: Array of strings
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is
EXCLUDE_VARIABLE_SETS
.
ContextAttribute
Description
The additional attributes of RecommendedAction
data type.
Members
- Key
-
- Type: string
The key of
ContextAttribute
. - Value
-
- Type: string
The value of
ContextAttribute
.
CopyDBClusterParameterGroupResult
Members
- DBClusterParameterGroup
-
- Type: DBClusterParameterGroup structure
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the
DescribeDBClusterParameterGroups
action.
CopyDBClusterSnapshotResult
Members
- DBClusterSnapshot
-
- Type: DBClusterSnapshot structure
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
CopyDBParameterGroupResult
Members
- DBParameterGroup
-
- Type: DBParameterGroup structure
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the
DescribeDBParameterGroups
action.
CopyDBSnapshotResult
Members
- DBSnapshot
-
- Type: DBSnapshot structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
CopyOptionGroupResult
Members
- OptionGroup
-
- Type: OptionGroup structure
CreateBlueGreenDeploymentResponse
Members
- BlueGreenDeployment
-
- Type: BlueGreenDeployment structure
Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
CreateCustomDBEngineVersionFault
Description
An error occurred while trying to create the CEV.
Members
CreateDBClusterParameterGroupResult
Members
- DBClusterParameterGroup
-
- Type: DBClusterParameterGroup structure
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the
DescribeDBClusterParameterGroups
action.
CreateDBClusterResult
Members
- DBCluster
-
- Type: 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.
CreateDBClusterSnapshotResult
Members
- DBClusterSnapshot
-
- Type: DBClusterSnapshot structure
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
CreateDBInstanceReadReplicaResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
CreateDBInstanceResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
CreateDBParameterGroupResult
Members
- DBParameterGroup
-
- Type: DBParameterGroup structure
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the
DescribeDBParameterGroups
action.
CreateDBProxyEndpointResponse
Members
- DBProxyEndpoint
-
- Type: DBProxyEndpoint structure
The
DBProxyEndpoint
object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.
CreateDBProxyResponse
Members
- DBProxy
-
- Type: DBProxy structure
The
DBProxy
structure corresponding to the new proxy.
CreateDBSecurityGroupResult
Members
- DBSecurityGroup
-
- Type: DBSecurityGroup structure
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
CreateDBSnapshotResult
Members
- DBSnapshot
-
- Type: DBSnapshot structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
CreateDBSubnetGroupResult
Members
- DBSubnetGroup
-
- Type: DBSubnetGroup structure
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the
DescribeDBSubnetGroups
action.
CreateEventSubscriptionResult
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
CreateGlobalClusterResult
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
CreateOptionGroupResult
Members
- OptionGroup
-
- Type: OptionGroup structure
CreateTenantDatabaseResult
Members
- TenantDatabase
-
- Type: TenantDatabase structure
A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.
CustomAvailabilityZoneNotFoundFault
Description
CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone identifier.
Members
CustomDBEngineVersionAMI
Description
A value that indicates the AMI information.
Members
- ImageId
-
- Type: string
A value that indicates the ID of the AMI.
- Status
-
- Type: string
A value that indicates the status of a custom engine version (CEV).
CustomDBEngineVersionAlreadyExistsFault
Description
A CEV with the specified name already exists.
Members
CustomDBEngineVersionNotFoundFault
Description
The specified CEV was not found.
Members
CustomDBEngineVersionQuotaExceededFault
Description
You have exceeded your CEV quota.
Members
DBCluster
Description
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
, and StopDBCluster
.
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
, and RestoreDBClusterToPointInTime
.
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.
Members
- ActivityStreamKinesisStreamName
-
- Type: string
The name of the Amazon Kinesis data stream used for the database activity stream.
- ActivityStreamKmsKeyId
-
- Type: 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.
- ActivityStreamMode
-
- Type: 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
-
- Type: string
The status of the database activity stream.
- AllocatedStorage
-
- Type: int
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. - AssociatedRoles
-
- Type: Array of DBClusterRole structures
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.
- AutoMinorVersionUpgrade
-
- Type: boolean
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
- AutomaticRestartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a stopped DB cluster is restarted automatically.
- AvailabilityZones
-
- Type: Array of strings
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
- AwsBackupRecoveryPointArn
-
- Type: string
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- BacktrackConsumedChangeRecords
-
- Type: long (int|float)
The number of change records stored for Backtrack.
- BacktrackWindow
-
- Type: long (int|float)
The target backtrack window, in seconds. If this value is set to
0
, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled. - BackupRetentionPeriod
-
- Type: int
The number of days for which automatic DB snapshots are retained.
- Capacity
-
- Type: int
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.
- CertificateDetails
-
- Type: CertificateDetails structure
The details of the DB instance’s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- CharacterSetName
-
- Type: string
If present, specifies the name of the character set that this cluster is associated with.
- CloneGroupId
-
- Type: string
The ID of the clone group with which the DB cluster is associated.
- ClusterCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
- ClusterScalabilityType
-
- Type: string
The scalability mode of the Aurora DB cluster. When set to
limitless
, the cluster operates as an Aurora Limitless Database. When set tostandard
(the default), the cluster uses normal DB instance creation. - CopyTagsToSnapshot
-
- Type: boolean
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
- CrossAccountClone
-
- Type: boolean
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
- CustomEndpoints
-
- Type: Array of strings
The custom endpoints associated with the DB cluster.
- DBClusterArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB cluster.
- DBClusterIdentifier
-
- Type: string
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
- DBClusterInstanceClass
-
- Type: 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.
- DBClusterMembers
-
- Type: Array of DBClusterMember structures
The list of DB instances that make up the DB cluster.
- DBClusterOptionGroupMemberships
-
- Type: Array of DBClusterOptionGroupStatus structures
The list of option group memberships for this DB cluster.
- DBClusterParameterGroup
-
- Type: string
The name of the DB cluster parameter group for the DB cluster.
- DBSubnetGroup
-
- Type: string
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
- DBSystemId
-
- Type: string
Reserved for future use.
- DatabaseInsightsMode
-
- Type: string
The mode of Database Insights that is enabled for the cluster.
- DatabaseName
-
- Type: string
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.
- DbClusterResourceId
-
- Type: 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.
- DeletionProtection
-
- Type: boolean
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
- DomainMemberships
-
- Type: Array of DomainMembership structures
The Active Directory Domain membership records associated with the DB cluster.
- EarliestBacktrackTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The earliest time to which a DB cluster can be backtracked.
- EarliestRestorableTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The earliest time to which a database can be restored with point-in-time restore.
- EnabledCloudwatchLogsExports
-
- Type: Array of strings
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.
- Endpoint
-
- Type: string
The connection endpoint for the primary instance of the DB cluster.
- Engine
-
- Type: string
The database engine used for this DB cluster.
- EngineLifecycleSupport
-
- Type: string
The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
- EngineMode
-
- Type: string
The DB engine mode of the DB cluster, either
provisioned
orserverless
.For more information, see CreateDBCluster.
- EngineVersion
-
- Type: string
The version of the database engine.
- GlobalWriteForwardingRequested
-
- Type: boolean
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. - GlobalWriteForwardingStatus
-
- Type: string
The status of write forwarding for a secondary cluster in an Aurora global database.
- HostedZoneId
-
- Type: string
The ID that Amazon Route 53 assigns when you create a hosted zone.
- HttpEndpointEnabled
-
- Type: boolean
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.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- IOOptimizedNextAllowedModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The next time you can modify the DB cluster to use the
aurora-iopt1
storage type.This setting is only for Aurora DB clusters.
- Iops
-
- Type: int
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
- KmsKeyId
-
- Type: 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.
- LatestRestorableTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The latest time to which a database can be restored with point-in-time restore.
- LimitlessDatabase
-
- Type: LimitlessDatabase structure
The details for Aurora Limitless Database.
- LocalWriteForwardingStatus
-
- Type: string
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
- MasterUserSecret
-
- Type: MasterUserSecret structure
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.
- MasterUsername
-
- Type: string
The master username for the DB cluster.
- MonitoringInterval
-
- Type: int
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
-
- Type: 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.
- MultiAZ
-
- Type: boolean
Indicates whether the DB cluster has instances in multiple Availability Zones.
- NetworkType
-
- Type: string
The network type of the DB instance.
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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
- PendingModifiedValues
-
- Type: ClusterPendingModifiedValues structure
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
- PercentProgress
-
- Type: string
The progress of the operation as a percentage.
- PerformanceInsightsEnabled
-
- Type: boolean
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
- PerformanceInsightsKMSKeyId
-
- Type: 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
-
- Type: int
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 - Port
-
- Type: int
The port that the database engine is listening on.
- PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
. - PreferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- PubliclyAccessible
-
- Type: boolean
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. 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.
- RdsCustomClusterConfiguration
-
- Type: RdsCustomClusterConfiguration structure
Reserved for future use.
- ReadReplicaIdentifiers
-
- Type: Array of strings
Contains one or more identifiers of the read replicas associated with this DB cluster.
- ReaderEndpoint
-
- Type: 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.
- ReplicationSourceIdentifier
-
- Type: string
The identifier of the source DB cluster if this DB cluster is a read replica.
- ScalingConfigurationInfo
-
- Type: ScalingConfigurationInfo structure
The scaling configuration for an Aurora DB cluster in
serverless
DB engine mode.For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
- ServerlessV2ScalingConfiguration
-
- Type: ServerlessV2ScalingConfigurationInfo structure
The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- Status
-
- Type: string
The current state of this DB cluster.
- StatusInfos
-
- Type: Array of DBClusterStatusInfo structures
Reserved for future use.
- StorageEncrypted
-
- Type: boolean
Indicates whether the DB cluster is encrypted.
- StorageThroughput
-
- Type: int
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.
- StorageType
-
- Type: string
The storage type associated with the DB cluster.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- VpcSecurityGroups
-
- Type: Array of VpcSecurityGroupMembership structures
The list of VPC security groups that the DB cluster belongs to.
DBClusterAlreadyExistsFault
Description
The user already has a DB cluster with the given identifier.
Members
DBClusterAutomatedBackup
Description
An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
Members
- AllocatedStorage
-
- Type: int
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
-
- Type: Array of strings
The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
- AwsBackupRecoveryPointArn
-
- Type: string
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- BackupRetentionPeriod
-
- Type: int
The retention period for the automated backups.
- ClusterCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
- DBClusterArn
-
- Type: string
The Amazon Resource Name (ARN) for the source DB cluster.
- DBClusterAutomatedBackupsArn
-
- Type: string
The Amazon Resource Name (ARN) for the automated backups.
- DBClusterIdentifier
-
- Type: string
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
- DbClusterResourceId
-
- Type: string
The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
- Engine
-
- Type: string
The name of the database engine for this automated backup.
- EngineMode
-
- Type: string
The engine mode of the database engine for the automated backup.
- EngineVersion
-
- Type: string
The version of the database engine for the automated backup.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- Iops
-
- Type: int
The IOPS (I/O operations per second) value for the automated backup.
This setting is only for non-Aurora Multi-AZ DB clusters.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- LicenseModel
-
- Type: string
The license model information for this DB cluster automated backup.
- MasterUsername
-
- Type: string
The master user name of the automated backup.
- Port
-
- Type: int
The port number that the automated backup used for connections.
Default: Inherits from the source DB cluster
Valid Values:
1150-65535
- Region
-
- Type: string
The Amazon Web Services Region associated with the automated backup.
- RestoreWindow
-
- Type: RestoreWindow structure
Earliest and latest time an instance can be restored to:
- Status
-
- Type: string
A list of status information for an automated backup:
-
retained
- Automated backups for deleted clusters.
- StorageEncrypted
-
- Type: boolean
Indicates whether the source DB cluster is encrypted.
- StorageThroughput
-
- Type: int
The storage throughput for the automated backup. 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.
- StorageType
-
- Type: string
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
- VpcId
-
- Type: string
The VPC ID associated with the DB cluster.
DBClusterAutomatedBackupMessage
Members
- DBClusterAutomatedBackups
-
- Type: Array of DBClusterAutomatedBackup structures
A list of
DBClusterAutomatedBackup
backups. - Marker
-
- Type: string
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to
MaxRecords
.
DBClusterAutomatedBackupNotFoundFault
Description
No automated backup for this DB cluster was found.
Members
DBClusterAutomatedBackupQuotaExceededFault
Description
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.
Members
DBClusterBacktrack
Description
This data type is used as a response element in the DescribeDBClusterBacktracks
action.
Members
- BacktrackIdentifier
-
- Type: string
Contains the backtrack identifier.
- BacktrackRequestCreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the time at which the backtrack was requested.
- BacktrackTo
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the time to which the DB cluster was backtracked.
- BacktrackedFrom
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the time from which the DB cluster was backtracked.
- DBClusterIdentifier
-
- Type: string
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
- Status
-
- Type: string
The status of the backtrack. This property returns one of the following values:
-
applying
- The backtrack is currently being applied to or rolled back from the DB cluster. -
completed
- The backtrack has successfully been applied to or rolled back from the DB cluster. -
failed
- An error occurred while the backtrack was applied to or rolled back from the DB cluster. -
pending
- The backtrack is currently pending application to or rollback from the DB cluster.
DBClusterBacktrackMessage
Description
Contains the result of a successful invocation of the DescribeDBClusterBacktracks
action.
Members
- DBClusterBacktracks
-
- Type: Array of DBClusterBacktrack structures
Contains a list of backtracks for the user.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeDBClusterBacktracks
request.
DBClusterBacktrackNotFoundFault
Description
BacktrackIdentifier
doesn't refer to an existing backtrack.
Members
DBClusterCapacityInfo
Members
- CurrentCapacity
-
- Type: int
The current capacity of the DB cluster.
- DBClusterIdentifier
-
- Type: string
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
- PendingCapacity
-
- Type: int
A value that specifies the capacity that the DB cluster scales to next.
- SecondsBeforeTimeout
-
- Type: int
The number of seconds before a call to
ModifyCurrentDBClusterCapacity
times out. - TimeoutAction
-
- Type: string
The timeout action of a call to
ModifyCurrentDBClusterCapacity
, eitherForceApplyCapacityChange
orRollbackCapacityChange
.
DBClusterEndpoint
Description
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
-
CreateDBClusterEndpoint
-
DescribeDBClusterEndpoints
-
ModifyDBClusterEndpoint
-
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint
.
Members
- CustomEndpointType
-
- Type: string
The type associated with a custom endpoint. One of:
READER
,WRITER
,ANY
. - DBClusterEndpointArn
-
- Type: string
The Amazon Resource Name (ARN) for the endpoint.
- DBClusterEndpointIdentifier
-
- Type: string
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
- DBClusterEndpointResourceIdentifier
-
- Type: string
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
- DBClusterIdentifier
-
- Type: string
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
- Endpoint
-
- Type: string
The DNS address of the endpoint.
- EndpointType
-
- Type: string
The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
. - ExcludedMembers
-
- Type: Array of strings
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
- StaticMembers
-
- Type: Array of strings
List of DB instance identifiers that are part of the custom endpoint group.
- Status
-
- Type: string
The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that can't be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.
DBClusterEndpointAlreadyExistsFault
Description
The specified custom endpoint can't be created because it already exists.
Members
DBClusterEndpointMessage
Members
- DBClusterEndpoints
-
- Type: Array of DBClusterEndpoint structures
Contains the details of the endpoints associated with the cluster and matching any filter conditions.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterEndpoints
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
DBClusterEndpointNotFoundFault
Description
The specified custom endpoint doesn't exist.
Members
DBClusterEndpointQuotaExceededFault
Description
The cluster already has the maximum number of custom endpoints.
Members
DBClusterMember
Description
Contains information about an instance that is part of a DB cluster.
Members
- DBClusterParameterGroupStatus
-
- Type: string
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
- DBInstanceIdentifier
-
- Type: string
Specifies the instance identifier for this member of the DB cluster.
- IsClusterWriter
-
- Type: boolean
Indicates whether the cluster member is the primary DB instance for the DB cluster.
- PromotionTier
-
- Type: int
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.
DBClusterMessage
Description
Contains the result of a successful invocation of the DescribeDBClusters
action.
Members
- DBClusters
-
- Type: Array of DBCluster structures
Contains a list of DB clusters for the user.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeDBClusters
request.
DBClusterNotFoundFault
Description
DBClusterIdentifier
doesn't refer to an existing DB cluster.
Members
DBClusterOptionGroupStatus
Description
Contains status information for a DB cluster option group.
Members
- DBClusterOptionGroupName
-
- Type: string
Specifies the name of the DB cluster option group.
- Status
-
- Type: string
Specifies the status of the DB cluster option group.
DBClusterParameterGroup
Description
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups
action.
Members
- DBClusterParameterGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB cluster parameter group.
- DBClusterParameterGroupName
-
- Type: string
The name of the DB cluster parameter group.
- DBParameterGroupFamily
-
- Type: string
The name of the DB parameter group family that this DB cluster parameter group is compatible with.
- Description
-
- Type: string
Provides the customer-specified description for this DB cluster parameter group.
DBClusterParameterGroupDetails
Description
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterParameters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - Parameters
-
- Type: Array of Parameter structures
Provides a list of parameters for the DB cluster parameter group.
DBClusterParameterGroupNameMessage
Description
Members
- DBClusterParameterGroupName
-
- Type: string
The name of the DB cluster parameter group.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
DBClusterParameterGroupNotFoundFault
Description
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.
Members
DBClusterParameterGroupsMessage
Description
Members
- DBClusterParameterGroups
-
- Type: Array of DBClusterParameterGroup structures
A list of DB cluster parameter groups.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterParameterGroups
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
DBClusterQuotaExceededFault
Description
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
Members
DBClusterRole
Description
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
Members
- FeatureName
-
- Type: 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.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- Status
-
- Type: 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.
DBClusterRoleAlreadyExistsFault
Description
The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
Members
DBClusterRoleNotFoundFault
Description
The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
Members
DBClusterRoleQuotaExceededFault
Description
You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
Members
DBClusterSnapshot
Description
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots
action.
Members
- AllocatedStorage
-
- Type: int
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
- AvailabilityZones
-
- Type: Array of strings
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
- ClusterCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
- DBClusterIdentifier
-
- Type: string
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
- DBClusterSnapshotArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB cluster snapshot.
- DBClusterSnapshotIdentifier
-
- Type: string
The identifier for the DB cluster snapshot.
- DBSystemId
-
- Type: string
Reserved for future use.
- DbClusterResourceId
-
- Type: string
The resource ID of the DB cluster that this DB cluster snapshot was created from.
- Engine
-
- Type: string
The name of the database engine for this DB cluster snapshot.
- EngineMode
-
- Type: string
The engine mode of the database engine for this DB cluster snapshot.
- EngineVersion
-
- Type: string
The version of the database engine for this DB cluster snapshot.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- KmsKeyId
-
- Type: string
If
StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- LicenseModel
-
- Type: string
The license model information for this DB cluster snapshot.
- MasterUsername
-
- Type: string
The master username for this DB cluster snapshot.
- PercentProgress
-
- Type: int
The percentage of the estimated data that has been transferred.
- Port
-
- Type: int
The port that the DB cluster was listening on at the time of the snapshot.
- SnapshotCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
- SnapshotType
-
- Type: string
The type of the DB cluster snapshot.
- SourceDBClusterSnapshotArn
-
- Type: string
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
- Status
-
- Type: string
The status of this DB cluster snapshot. Valid statuses are the following:
-
available
-
copying
-
creating
- StorageEncrypted
-
- Type: boolean
Indicates whether the DB cluster snapshot is encrypted.
- StorageThroughput
-
- Type: int
The storage throughput for the DB cluster snapshot. 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.
- StorageType
-
- Type: string
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- VpcId
-
- Type: string
The VPC ID associated with the DB cluster snapshot.
DBClusterSnapshotAlreadyExistsFault
Description
The user already has a DB cluster snapshot with the given identifier.
Members
DBClusterSnapshotAttribute
Description
Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute
API action.
Members
- AttributeName
-
- Type: string
The name of the manual DB cluster snapshot attribute.
The attribute named
restore
refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see theModifyDBClusterSnapshotAttribute
API action. - AttributeValues
-
- Type: Array of strings
The value(s) for the manual DB cluster snapshot attribute.
If the
AttributeName
field is set torestore
, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value ofall
is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
DBClusterSnapshotAttributesResult
Description
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes
API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute
API action.
Members
- DBClusterSnapshotAttributes
-
- Type: Array of DBClusterSnapshotAttribute structures
The list of attributes and values for the manual DB cluster snapshot.
- DBClusterSnapshotIdentifier
-
- Type: string
The identifier of the manual DB cluster snapshot that the attributes apply to.
DBClusterSnapshotMessage
Description
Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots
action.
Members
- DBClusterSnapshots
-
- Type: Array of DBClusterSnapshot structures
Provides a list of DB cluster snapshots for the user.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
DBClusterSnapshotNotFoundFault
Description
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.
Members
DBClusterStatusInfo
Description
Reserved for future use.
Members
- Message
-
- Type: string
Reserved for future use.
- Normal
-
- Type: boolean
Reserved for future use.
- Status
-
- Type: string
Reserved for future use.
- StatusType
-
- Type: string
Reserved for future use.
DBEngineVersion
Description
This data type is used as a response element in the action DescribeDBEngineVersions
.
Members
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the DB engine version.
- CustomDBEngineVersionManifest
-
- Type: string
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
- DBEngineDescription
-
- Type: string
The description of the database engine.
- DBEngineMediaType
-
- Type: string
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
- DBEngineVersionArn
-
- Type: string
The ARN of the custom engine version.
- DBEngineVersionDescription
-
- Type: string
The description of the database engine version.
- DBParameterGroupFamily
-
- Type: string
The name of the DB parameter group family for the database engine.
- DatabaseInstallationFilesS3BucketName
-
- Type: string
The name of the Amazon S3 bucket that contains your database installation files.
- DatabaseInstallationFilesS3Prefix
-
- Type: string
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
- DefaultCharacterSet
-
- Type: CharacterSet structure
The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn't specified. - Engine
-
- Type: string
The name of the database engine.
- EngineVersion
-
- Type: string
The version number of the database engine.
- ExportableLogTypes
-
- Type: Array of strings
The types of logs that the database engine has available for export to CloudWatch Logs.
- Image
-
- Type: CustomDBEngineVersionAMI structure
The EC2 image
- KMSKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
- MajorEngineVersion
-
- Type: string
The major engine version of the CEV.
- ServerlessV2FeaturesSupport
-
- Type: ServerlessV2FeaturesSupport structure
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
- Status
-
- Type: string
The status of the DB engine version, either
available
ordeprecated
. - SupportedCACertificateIdentifiers
-
- Type: Array of strings
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- SupportedCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation. - SupportedEngineModes
-
- Type: Array of strings
A list of the supported DB engine modes.
- SupportedFeatureNames
-
- Type: Array of strings
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output. - SupportedNcharCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation. - SupportedTimezones
-
- Type: Array of Timezone structures
A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action. - SupportsBabelfish
-
- Type: boolean
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- SupportsCertificateRotationWithoutRestart
-
- Type: boolean
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
- SupportsGlobalDatabases
-
- Type: boolean
Indicates whether you can use Aurora global databases with a specific DB engine version.
- SupportsIntegrations
-
- Type: boolean
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
- SupportsLimitlessDatabase
-
- Type: boolean
Indicates whether the DB engine version supports Aurora Limitless Database.
- SupportsLocalWriteForwarding
-
- Type: boolean
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
- SupportsLogExportsToCloudwatchLogs
-
- Type: boolean
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
- SupportsParallelQuery
-
- Type: boolean
Indicates whether you can use Aurora parallel query with a specific DB engine version.
- SupportsReadReplica
-
- Type: boolean
Indicates whether the database engine version supports read replicas.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- ValidUpgradeTarget
-
- Type: Array of UpgradeTarget structures
A list of engine versions that this database engine version can be upgraded to.
DBEngineVersionMessage
Description
Contains the result of a successful invocation of the DescribeDBEngineVersions
action.
Members
- DBEngineVersions
-
- Type: Array of DBEngineVersion structures
A list of
DBEngineVersion
elements. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBInstance
Description
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance
, CreateDBInstanceReadReplica
, DeleteDBInstance
, DescribeDBInstances
, ModifyDBInstance
, PromoteReadReplica
, RebootDBInstance
, RestoreDBInstanceFromDBSnapshot
, RestoreDBInstanceFromS3
, RestoreDBInstanceToPointInTime
, StartDBInstance
, and StopDBInstance
.
Members
- ActivityStreamEngineNativeAuditFieldsIncluded
-
- Type: boolean
Indicates whether engine-native audit fields are included in the database activity stream.
- ActivityStreamKinesisStreamName
-
- Type: string
The name of the Amazon Kinesis data stream used for the database activity stream.
- ActivityStreamKmsKeyId
-
- Type: 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.
- ActivityStreamMode
-
- Type: string
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
- ActivityStreamPolicyStatus
-
- Type: string
The status of the policy state of the activity stream.
- ActivityStreamStatus
-
- Type: string
The status of the database activity stream.
- AllocatedStorage
-
- Type: int
The amount of storage in gibibytes (GiB) allocated for the DB instance.
- AssociatedRoles
-
- Type: Array of DBInstanceRole structures
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
- AutoMinorVersionUpgrade
-
- Type: boolean
Indicates whether minor version patches are applied automatically.
- AutomaticRestartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a stopped DB instance is restarted automatically.
- AutomationMode
-
- Type: string
The automation mode of the RDS Custom DB instance:
full
orall paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set by--resume-full-automation-mode-minutes
. - AvailabilityZone
-
- Type: string
The name of the Availability Zone where the DB instance is located.
- AwsBackupRecoveryPointArn
-
- Type: string
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- BackupRetentionPeriod
-
- Type: int
The number of days for which automatic DB snapshots are retained.
- BackupTarget
-
- Type: string
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
- CACertificateIdentifier
-
- Type: string
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- CertificateDetails
-
- Type: CertificateDetails structure
The details of the DB instance's server certificate.
- CharacterSetName
-
- Type: string
If present, specifies the name of the character set that this instance is associated with.
- CopyTagsToSnapshot
-
- Type: boolean
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
DBCluster
. - CustomIamInstanceProfile
-
- Type: string
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
- CustomerOwnedIpEnabled
-
- Type: boolean
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- DBClusterIdentifier
-
- Type: string
If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
- DBInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB instance.
- DBInstanceAutomatedBackupsReplications
-
- Type: Array of DBInstanceAutomatedBackupsReplication structures
The list of replicated automated backups associated with the DB instance.
- DBInstanceClass
-
- Type: string
The name of the compute and memory capacity class of the DB instance.
- DBInstanceIdentifier
-
- Type: string
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
- DBInstanceStatus
-
- Type: string
The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
- DBName
-
- Type: string
The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
- DBParameterGroups
-
- Type: Array of DBParameterGroupStatus structures
The list of DB parameter groups applied to this DB instance.
- DBSecurityGroups
-
- Type: Array of DBSecurityGroupMembership structures
A list of DB security group elements containing
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements. - DBSubnetGroup
-
- Type: DBSubnetGroup structure
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
- DBSystemId
-
- Type: string
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
- DatabaseInsightsMode
-
- Type: string
The mode of Database Insights that is enabled for the instance.
- DbInstancePort
-
- Type: int
The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
- DbiResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
- DedicatedLogVolume
-
- Type: boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- DeletionProtection
-
- Type: boolean
Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
- DomainMemberships
-
- Type: Array of DomainMembership structures
The Active Directory Domain membership records associated with the DB instance.
- EnabledCloudwatchLogsExports
-
- Type: Array of strings
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
- Endpoint
-
- Type: Endpoint structure
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of
creating
. - Engine
-
- Type: string
The database engine used for this DB instance.
- EngineLifecycleSupport
-
- Type: string
The life cycle type for the DB instance.
For more information, see CreateDBInstance.
- EngineVersion
-
- Type: string
The version of the database engine.
- EnhancedMonitoringResourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
- InstanceCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the DB instance was created.
- Iops
-
- Type: int
The Provisioned IOPS (I/O operations per second) value for the DB instance.
- IsStorageConfigUpgradeAvailable
-
- Type: boolean
Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
- KmsKeyId
-
- Type: string
If
StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- LatestRestorableTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The latest time to which a database in this DB instance can be restored with point-in-time restore.
- LicenseModel
-
- Type: string
The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- ListenerEndpoint
-
- Type: Endpoint structure
The listener connection endpoint for SQL Server Always On.
- MasterUserSecret
-
- Type: MasterUserSecret structure
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.
- MasterUsername
-
- Type: string
The master username for the DB instance.
- MaxAllocatedStorage
-
- Type: int
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
- MonitoringInterval
-
- Type: int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
- MonitoringRoleArn
-
- Type: string
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
- MultiAZ
-
- Type: boolean
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
- MultiTenant
-
- Type: boolean
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
- NcharCharacterSetName
-
- Type: string
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
- NetworkType
-
- Type: string
The network type of the DB instance.
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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 RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values:
IPV4 | DUAL
- OptionGroupMemberships
-
- Type: Array of OptionGroupMembership structures
The list of option group memberships for this DB instance.
- PendingModifiedValues
-
- Type: PendingModifiedValues structure
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
- PercentProgress
-
- Type: string
The progress of the storage optimization operation as a percentage.
- PerformanceInsightsEnabled
-
- Type: boolean
Indicates whether Performance Insights is enabled for the DB instance.
- PerformanceInsightsKMSKeyId
-
- Type: 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.
- PerformanceInsightsRetentionPeriod
-
- Type: int
The number of days to retain Performance Insights data.
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 - PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
. - PreferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- PromotionTier
-
- Type: int
The order of priority 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.
- PubliclyAccessible
-
- Type: boolean
Indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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 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.
- ReadReplicaDBClusterIdentifiers
-
- Type: Array of strings
The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
- ReadReplicaDBInstanceIdentifiers
-
- Type: Array of strings
The identifiers of the read replicas associated with this DB instance.
- ReadReplicaSourceDBClusterIdentifier
-
- Type: string
The identifier of the source DB cluster if this DB instance is a read replica.
- ReadReplicaSourceDBInstanceIdentifier
-
- Type: string
The identifier of the source DB instance if this DB instance is a read replica.
- ReplicaMode
-
- Type: string
The open mode of an Oracle read replica. The default is
open-read-only
. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.This attribute is only supported in RDS for Oracle.
- ResumeFullAutomationModeTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
- SecondaryAvailabilityZone
-
- Type: string
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
- StatusInfos
-
- Type: Array of DBInstanceStatusInfo structures
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
- StorageEncrypted
-
- Type: boolean
Indicates whether the DB instance is encrypted.
- StorageThroughput
-
- Type: int
The storage throughput for the DB instance.
This setting applies only to the
gp3
storage type. - StorageType
-
- Type: string
The storage type associated with the DB instance.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TdeCredentialArn
-
- Type: string
The ARN from the key store with which the instance is associated for TDE encryption.
- Timezone
-
- Type: string
The time zone of the DB instance. In most cases, the
Timezone
element is empty.Timezone
content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. - VpcSecurityGroups
-
- Type: Array of VpcSecurityGroupMembership structures
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
DBInstanceAlreadyExistsFault
Description
The user already has a DB instance with the given identifier.
Members
DBInstanceAutomatedBackup
Description
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
Members
- AllocatedStorage
-
- Type: int
The allocated storage size for the the automated backup in gibibytes (GiB).
- AvailabilityZone
-
- Type: string
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
- AwsBackupRecoveryPointArn
-
- Type: string
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- BackupRetentionPeriod
-
- Type: int
The retention period for the automated backups.
- BackupTarget
-
- Type: string
The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
- DBInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) for the automated backups.
- DBInstanceAutomatedBackupsArn
-
- Type: string
The Amazon Resource Name (ARN) for the replicated automated backups.
- DBInstanceAutomatedBackupsReplications
-
- Type: Array of DBInstanceAutomatedBackupsReplication structures
The list of replications to different Amazon Web Services Regions associated with the automated backup.
- DBInstanceIdentifier
-
- Type: string
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
- DbiResourceId
-
- Type: string
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
- DedicatedLogVolume
-
- Type: boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- Encrypted
-
- Type: boolean
Indicates whether the automated backup is encrypted.
- Engine
-
- Type: string
The name of the database engine for this automated backup.
- EngineVersion
-
- Type: string
The version of the database engine for the automated backup.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
- InstanceCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the DB instance was created.
- Iops
-
- Type: int
The IOPS (I/O operations per second) value for the automated backup.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- LicenseModel
-
- Type: string
The license model information for the automated backup.
- MasterUsername
-
- Type: string
The master user name of an automated backup.
- MultiTenant
-
- Type: boolean
Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
- OptionGroupName
-
- Type: string
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
- Port
-
- Type: int
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values:
1150-65535
- Region
-
- Type: string
The Amazon Web Services Region associated with the automated backup.
- RestoreWindow
-
- Type: RestoreWindow structure
The earliest and latest time a DB instance can be restored to.
- Status
-
- Type: string
A list of status information for an automated backup:
-
active
- Automated backups for current instances. -
retained
- Automated backups for deleted instances. -
creating
- Automated backups that are waiting for the first automated snapshot to be available.
- StorageThroughput
-
- Type: int
The storage throughput for the automated backup.
- StorageType
-
- Type: string
The storage type associated with the automated backup.
- TdeCredentialArn
-
- Type: string
The ARN from the key store with which the automated backup is associated for TDE encryption.
- Timezone
-
- Type: string
The time zone of the automated backup. In most cases, the
Timezone
element is empty.Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time zone specified. - VpcId
-
- Type: string
The VPC ID associated with the DB instance.
DBInstanceAutomatedBackupMessage
Description
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups
action.
Members
- DBInstanceAutomatedBackups
-
- Type: Array of DBInstanceAutomatedBackup structures
A list of
DBInstanceAutomatedBackup
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBInstanceAutomatedBackupNotFoundFault
Description
No automated backup for this DB instance was found.
Members
DBInstanceAutomatedBackupQuotaExceededFault
Description
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
Members
DBInstanceAutomatedBackupsReplication
Description
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
Members
- DBInstanceAutomatedBackupsArn
-
- Type: string
The Amazon Resource Name (ARN) of the replicated automated backups.
DBInstanceMessage
Description
Contains the result of a successful invocation of the DescribeDBInstances
action.
Members
- DBInstances
-
- Type: Array of DBInstance structures
A list of
DBInstance
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBInstanceNotFoundFault
Description
DBInstanceIdentifier
doesn't refer to an existing DB instance.
Members
DBInstanceNotReadyFault
Description
An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.
Members
DBInstanceRole
Description
Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
Members
- FeatureName
-
- Type: 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
. - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- Status
-
- Type: string
Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
-
ACTIVE
- the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. -
PENDING
- the IAM role ARN is being associated with the DB instance. -
INVALID
- the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
DBInstanceRoleAlreadyExistsFault
Description
The specified RoleArn
or FeatureName
value is already associated with the DB instance.
Members
DBInstanceRoleNotFoundFault
Description
The specified RoleArn
value doesn't match the specified feature for the DB instance.
Members
DBInstanceRoleQuotaExceededFault
Description
You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
Members
DBInstanceStatusInfo
Description
Provides a list of status information for a DB instance.
Members
- Message
-
- Type: string
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
- Normal
-
- Type: boolean
Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).
- Status
-
- Type: string
The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
- StatusType
-
- Type: string
This value is currently "read replication."
DBLogFileNotFoundFault
Description
LogFileName
doesn't refer to an existing DB log file.
Members
DBParameterGroup
Description
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups
action.
Members
- DBParameterGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB parameter group.
- DBParameterGroupFamily
-
- Type: string
The name of the DB parameter group family that this DB parameter group is compatible with.
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group.
- Description
-
- Type: string
Provides the customer-specified description for this DB parameter group.
DBParameterGroupAlreadyExistsFault
Description
A DB parameter group with the same name exists.
Members
DBParameterGroupDetails
Description
Contains the result of a successful invocation of the DescribeDBParameters
action.
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - Parameters
-
- Type: Array of Parameter structures
A list of
Parameter
values.
DBParameterGroupNameMessage
Description
Contains the result of a successful invocation of the ModifyDBParameterGroup
or ResetDBParameterGroup
operation.
Members
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group.
DBParameterGroupNotFoundFault
Description
DBParameterGroupName
doesn't refer to an existing DB parameter group.
Members
DBParameterGroupQuotaExceededFault
Description
The request would result in the user exceeding the allowed number of DB parameter groups.
Members
DBParameterGroupStatus
Description
The status of the DB parameter group.
This data type is used as a response element in the following actions:
-
CreateDBInstance
-
CreateDBInstanceReadReplica
-
DeleteDBInstance
-
ModifyDBInstance
-
RebootDBInstance
-
RestoreDBInstanceFromDBSnapshot
Members
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group.
- ParameterApplyStatus
-
- Type: string
The status of parameter updates. Valid values are:
-
applying
: The parameter group change is being applied to the database. -
failed-to-apply
: The parameter group is in an invalid state. -
in-sync
: The parameter group change is synchronized with the database. -
pending-database-upgrade
: The parameter group change will be applied after the DB instance is upgraded. -
pending-reboot
: The parameter group change will be applied after the DB instance reboots.
DBParameterGroupsMessage
Description
Contains the result of a successful invocation of the DescribeDBParameterGroups
action.
Members
- DBParameterGroups
-
- Type: Array of DBParameterGroup structures
A list of
DBParameterGroup
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBProxy
Description
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies
action.
Members
- Auth
-
- Type: Array of UserAuthConfigInfo structures
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the proxy was first created.
- DBProxyArn
-
- Type: string
The Amazon Resource Name (ARN) for the proxy.
- DBProxyName
-
- Type: string
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DebugLogging
-
- Type: boolean
Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
- Endpoint
-
- Type: string
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
- EngineFamily
-
- Type: string
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database.
MYSQL
supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases.POSTGRESQL
supports Aurora PostgreSQL and RDS for PostgreSQL databases.SQLSERVER
supports RDS for Microsoft SQL Server databases. - IdleClientTimeout
-
- Type: int
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
- RequireTLS
-
- Type: boolean
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
- Status
-
- Type: string
The current status of this proxy. A status of
available
means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue. - UpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the proxy was last updated.
- VpcId
-
- Type: string
Provides the VPC ID of the DB proxy.
- VpcSecurityGroupIds
-
- Type: Array of strings
Provides a list of VPC security groups that the proxy belongs to.
- VpcSubnetIds
-
- Type: Array of strings
The EC2 subnet IDs for the proxy.
DBProxyAlreadyExistsFault
Description
The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
Members
DBProxyEndpoint
Description
The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
This data type is used as a response element in the DescribeDBProxyEndpoints
operation.
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the DB proxy endpoint was first created.
- DBProxyEndpointArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB proxy endpoint.
- DBProxyEndpointName
-
- Type: string
The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
- DBProxyName
-
- Type: string
The identifier for the DB proxy that is associated with this DB proxy endpoint.
- Endpoint
-
- Type: string
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
- IsDefault
-
- Type: boolean
Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
- Status
-
- Type: string
The current status of this DB proxy endpoint. A status of
available
means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue. - TargetRole
-
- Type: string
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- VpcId
-
- Type: string
Provides the VPC ID of the DB proxy endpoint.
- VpcSecurityGroupIds
-
- Type: Array of strings
Provides a list of VPC security groups that the DB proxy endpoint belongs to.
- VpcSubnetIds
-
- Type: Array of strings
The EC2 subnet IDs for the DB proxy endpoint.
DBProxyEndpointAlreadyExistsFault
Description
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
Members
DBProxyEndpointNotFoundFault
Description
The DB proxy endpoint doesn't exist.
Members
DBProxyEndpointQuotaExceededFault
Description
The DB proxy already has the maximum number of endpoints.
Members
DBProxyNotFoundFault
Description
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
Members
DBProxyQuotaExceededFault
Description
Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.
Members
DBProxyTarget
Description
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets
action.
Members
- Endpoint
-
- Type: string
The writer endpoint for the RDS DB instance or Aurora DB cluster.
- Port
-
- Type: int
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
- RdsResourceId
-
- Type: string
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
- Role
-
- Type: string
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
- TargetArn
-
- Type: string
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
- TargetHealth
-
- Type: TargetHealth structure
Information about the connection health of the RDS Proxy target.
- TrackedClusterId
-
- Type: string
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
- Type
-
- Type: string
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
DBProxyTargetAlreadyRegisteredFault
Description
The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
Members
DBProxyTargetGroup
Description
Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
This data type is used as a response element in the DescribeDBProxyTargetGroups
action.
Members
- ConnectionPoolConfig
-
- Type: ConnectionPoolConfigurationInfo structure
The settings that determine the size and behavior of the connection pool for the target group.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the target group was first created.
- DBProxyName
-
- Type: string
The identifier for the RDS proxy associated with this target group.
- IsDefault
-
- Type: boolean
Indicates whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always
true
. - Status
-
- Type: string
The current status of this target group. A status of
available
means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue. - TargetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) representing the target group.
- TargetGroupName
-
- Type: string
The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- UpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the target group was last updated.
DBProxyTargetGroupNotFoundFault
Description
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
Members
DBProxyTargetNotFoundFault
Description
The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
Members
DBRecommendation
Description
The recommendation for your DB instances, DB clusters, and DB parameter groups.
Members
- AdditionalInfo
-
- Type: string
Additional information about the recommendation. The information might contain markdown.
- Category
-
- Type: string
The category of the recommendation.
Valid values:
-
performance efficiency
-
security
-
reliability
-
cost optimization
-
operational excellence
-
sustainability
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the recommendation was created. For example,
2023-09-28T01:13:53.931000+00:00
. - Description
-
- Type: string
A detailed description of the recommendation. The description might contain markdown.
- Detection
-
- Type: string
A short description of the issue identified for this recommendation. The description might contain markdown.
- Impact
-
- Type: string
A short description that explains the possible impact of an issue.
- IssueDetails
-
- Type: IssueDetails structure
Details of the issue that caused the recommendation.
- Links
-
- Type: Array of DocLink structures
A link to documentation that provides additional information about the recommendation.
- Reason
-
- Type: string
The reason why this recommendation was created. The information might contain markdown.
- Recommendation
-
- Type: string
A short description of the recommendation to resolve an issue. The description might contain markdown.
- RecommendationId
-
- Type: string
The unique identifier of the recommendation.
- RecommendedActions
-
- Type: Array of RecommendedAction structures
A list of recommended actions.
- ResourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.
- Severity
-
- Type: string
The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.
Valid values:
-
high
-
medium
-
low
-
informational
- Source
-
- Type: string
The Amazon Web Services service that generated the recommendations.
- Status
-
- Type: string
The current status of the recommendation.
Valid values:
-
active
- The recommendations which are ready for you to apply. -
pending
- The applied or scheduled recommendations which are in progress. -
resolved
- The recommendations which are completed. -
dismissed
- The recommendations that you dismissed.
- TypeDetection
-
- Type: string
A short description of the recommendation type. The description might contain markdown.
- TypeId
-
- Type: string
A value that indicates the type of recommendation. This value determines how the description is rendered.
- TypeRecommendation
-
- Type: string
A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.
- UpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the recommendation was last updated.
DBRecommendationMessage
Members
- DBRecommendation
-
- Type: DBRecommendation structure
The recommendation for your DB instances, DB clusters, and DB parameter groups.
DBRecommendationsMessage
Members
- DBRecommendations
-
- Type: Array of DBRecommendation structures
A list of recommendations which is returned from
DescribeDBRecommendations
API request. - Marker
-
- Type: string
An optional pagination token provided by a previous
DBRecommendationsMessage
request. This token can be used later in aDescribeDBRecomendations
request.
DBSecurityGroup
Description
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups
action.
Members
- DBSecurityGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB security group.
- DBSecurityGroupDescription
-
- Type: string
Provides the description of the DB security group.
- DBSecurityGroupName
-
- Type: string
Specifies the name of the DB security group.
- EC2SecurityGroups
-
- Type: Array of EC2SecurityGroup structures
Contains a list of
EC2SecurityGroup
elements. - IPRanges
-
- Type: Array of IPRange structures
Contains a list of
IPRange
elements. - OwnerId
-
- Type: string
Provides the Amazon Web Services ID of the owner of a specific DB security group.
- VpcId
-
- Type: string
Provides the VpcId of the DB security group.
DBSecurityGroupAlreadyExistsFault
Description
A DB security group with the name specified in DBSecurityGroupName
already exists.
Members
DBSecurityGroupMembership
Description
This data type is used as a response element in the following actions:
-
ModifyDBInstance
-
RebootDBInstance
-
RestoreDBInstanceFromDBSnapshot
-
RestoreDBInstanceToPointInTime
Members
- DBSecurityGroupName
-
- Type: string
The name of the DB security group.
- Status
-
- Type: string
The status of the DB security group.
DBSecurityGroupMessage
Description
Contains the result of a successful invocation of the DescribeDBSecurityGroups
action.
Members
- DBSecurityGroups
-
- Type: Array of DBSecurityGroup structures
A list of
DBSecurityGroup
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBSecurityGroupNotFoundFault
Description
DBSecurityGroupName
doesn't refer to an existing DB security group.
Members
DBSecurityGroupNotSupportedFault
Description
A DB security group isn't allowed for this action.
Members
DBSecurityGroupQuotaExceededFault
Description
The request would result in the user exceeding the allowed number of DB security groups.
Members
DBShardGroup
Description
Contains the details for an Amazon RDS DB shard group.
Members
- ComputeRedundancy
-
- Type: int
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:
-
0 - Creates a DB shard group without a standby DB shard group. This is the default value.
-
1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
-
2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
- DBClusterIdentifier
-
- Type: string
The name of the primary DB cluster for the DB shard group.
- DBShardGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB shard group.
- DBShardGroupIdentifier
-
- Type: string
The name of the DB shard group.
- DBShardGroupResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
- Endpoint
-
- Type: string
The connection endpoint for the DB shard group.
- MaxACU
-
- Type: double
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
- MinACU
-
- Type: double
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
- PubliclyAccessible
-
- Type: boolean
Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
- Status
-
- Type: string
The status of the DB shard group.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
DBShardGroupAlreadyExistsFault
Description
The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
Members
DBShardGroupNotFoundFault
Description
The specified DB shard group name wasn't found.
Members
DBSnapshot
Description
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots
action.
Members
- AllocatedStorage
-
- Type: int
Specifies the allocated storage size in gibibytes (GiB).
- AvailabilityZone
-
- Type: string
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
- DBInstanceIdentifier
-
- Type: string
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
- DBSnapshotArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB snapshot.
- DBSnapshotIdentifier
-
- Type: string
Specifies the identifier for the DB snapshot.
- DBSystemId
-
- Type: string
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
- DbiResourceId
-
- Type: string
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
- DedicatedLogVolume
-
- Type: boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- Encrypted
-
- Type: boolean
Indicates whether the DB snapshot is encrypted.
- Engine
-
- Type: string
Specifies the name of the database engine.
- EngineVersion
-
- Type: string
Specifies the version of the database engine.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- InstanceCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
- Iops
-
- Type: int
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
- KmsKeyId
-
- Type: string
If
Encrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- LicenseModel
-
- Type: string
License model information for the restored DB instance.
- MasterUsername
-
- Type: string
Provides the master username for the DB snapshot.
- MultiTenant
-
- Type: boolean
Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
- OptionGroupName
-
- Type: string
Provides the option group name for the DB snapshot.
- OriginalSnapshotCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
- PercentProgress
-
- Type: int
The percentage of the estimated data that has been transferred.
- Port
-
- Type: int
Specifies the port that the database engine was listening on at the time of the snapshot.
- ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
- SnapshotCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
- SnapshotDatabaseTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
- SnapshotTarget
-
- Type: string
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
- SnapshotType
-
- Type: string
Provides the type of the DB snapshot.
- SourceDBSnapshotIdentifier
-
- Type: string
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
- SourceRegion
-
- Type: string
The Amazon Web Services Region that the DB snapshot was created in or copied from.
- Status
-
- Type: string
Specifies the status of this DB snapshot.
- StorageThroughput
-
- Type: int
Specifies the storage throughput for the DB snapshot.
- StorageType
-
- Type: string
Specifies the storage type associated with DB snapshot.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TdeCredentialArn
-
- Type: string
The ARN from the key store with which to associate the instance for TDE encryption.
- Timezone
-
- Type: string
The time zone of the DB snapshot. In most cases, the
Timezone
element is empty.Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. - VpcId
-
- Type: string
Provides the VPC ID associated with the DB snapshot.
DBSnapshotAlreadyExistsFault
Description
DBSnapshotIdentifier
is already used by an existing snapshot.
Members
DBSnapshotAttribute
Description
Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute
API.
Members
- AttributeName
-
- Type: string
The name of the manual DB snapshot attribute.
The attribute named
restore
refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see theModifyDBSnapshotAttribute
API action. - AttributeValues
-
- Type: Array of strings
The value or values for the manual DB snapshot attribute.
If the
AttributeName
field is set torestore
, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value ofall
is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.
DBSnapshotAttributesResult
Description
Contains the results of a successful call to the DescribeDBSnapshotAttributes
API action.
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute
API action.
Members
- DBSnapshotAttributes
-
- Type: Array of DBSnapshotAttribute structures
The list of attributes and values for the manual DB snapshot.
- DBSnapshotIdentifier
-
- Type: string
The identifier of the manual DB snapshot that the attributes apply to.
DBSnapshotMessage
Description
Contains the result of a successful invocation of the DescribeDBSnapshots
action.
Members
- DBSnapshots
-
- Type: Array of DBSnapshot structures
A list of
DBSnapshot
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBSnapshotNotFoundFault
Description
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.
Members
DBSnapshotTenantDatabase
Description
Contains the details of a tenant database in a snapshot of a DB instance.
Members
- CharacterSetName
-
- Type: string
The name of the character set of a tenant database.
- DBInstanceIdentifier
-
- Type: string
The ID for the DB instance that contains the tenant databases.
- DBSnapshotIdentifier
-
- Type: string
The identifier for the snapshot of the DB instance.
- DBSnapshotTenantDatabaseARN
-
- Type: string
The Amazon Resource Name (ARN) for the snapshot tenant database.
- DbiResourceId
-
- Type: string
The resource identifier of the source CDB instance. This identifier can't be changed and is unique to an Amazon Web Services Region.
- EngineName
-
- Type: string
The name of the database engine.
- MasterUsername
-
- Type: string
The master username of the tenant database.
- NcharCharacterSetName
-
- Type: string
The
NCHAR
character set name of the tenant database. - SnapshotType
-
- Type: string
The type of DB snapshot.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TenantDBName
-
- Type: string
The name of the tenant database.
- TenantDatabaseCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If you copy the snapshot, the creation time changes.
- TenantDatabaseResourceId
-
- Type: string
The resource ID of the tenant database.
DBSnapshotTenantDatabaseNotFoundFault
Description
The specified snapshot tenant database wasn't found.
Members
DBSnapshotTenantDatabasesMessage
Members
- DBSnapshotTenantDatabases
-
- Type: Array of DBSnapshotTenantDatabase structures
A list of DB snapshot tenant databases.
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBSubnetGroup
Description
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups
action.
Members
- DBSubnetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) for the DB subnet group.
- DBSubnetGroupDescription
-
- Type: string
Provides the description of the DB subnet group.
- DBSubnetGroupName
-
- Type: string
The name of the DB subnet group.
- SubnetGroupStatus
-
- Type: string
Provides the status of the DB subnet group.
- Subnets
-
- Type: Array of Subnet structures
Contains a list of
Subnet
elements. - SupportedNetworkTypes
-
- Type: Array of strings
The network type of the DB subnet group.
Valid values:
-
IPV4
-
DUAL
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 RDS User Guide.
- VpcId
-
- Type: string
Provides the VpcId of the DB subnet group.
DBSubnetGroupAlreadyExistsFault
Description
DBSubnetGroupName
is already used by an existing DB subnet group.
Members
DBSubnetGroupDoesNotCoverEnoughAZs
Description
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
Members
DBSubnetGroupMessage
Description
Contains the result of a successful invocation of the DescribeDBSubnetGroups
action.
Members
- DBSubnetGroups
-
- Type: Array of DBSubnetGroup structures
A list of
DBSubnetGroup
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBSubnetGroupNotAllowedFault
Description
The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.
Members
DBSubnetGroupNotFoundFault
Description
DBSubnetGroupName
doesn't refer to an existing DB subnet group.
Members
DBSubnetGroupQuotaExceededFault
Description
The request would result in the user exceeding the allowed number of DB subnet groups.
Members
DBSubnetQuotaExceededFault
Description
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
Members
DBUpgradeDependencyFailureFault
Description
The DB upgrade failed because a resource the DB depends on can't be modified.
Members
DeleteBlueGreenDeploymentResponse
Members
- BlueGreenDeployment
-
- Type: BlueGreenDeployment structure
Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
DeleteDBClusterAutomatedBackupResult
Members
- DBClusterAutomatedBackup
-
- Type: DBClusterAutomatedBackup structure
An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
DeleteDBClusterResult
Members
- DBCluster
-
- Type: 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.
DeleteDBClusterSnapshotResult
Members
- DBClusterSnapshot
-
- Type: DBClusterSnapshot structure
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
DeleteDBInstanceAutomatedBackupResult
Members
- DBInstanceAutomatedBackup
-
- Type: DBInstanceAutomatedBackup structure
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DeleteDBInstanceResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
DeleteDBProxyEndpointResponse
Members
- DBProxyEndpoint
-
- Type: DBProxyEndpoint structure
The data structure representing the details of the DB proxy endpoint that you delete.
DeleteDBProxyResponse
Members
- DBProxy
-
- Type: DBProxy structure
The data structure representing the details of the DB proxy that you delete.
DeleteDBSnapshotResult
Members
- DBSnapshot
-
- Type: DBSnapshot structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
DeleteEventSubscriptionResult
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
DeleteGlobalClusterResult
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
DeleteTenantDatabaseResult
Members
- TenantDatabase
-
- Type: TenantDatabase structure
A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.
DeregisterDBProxyTargetsResponse
Members
DescribeBlueGreenDeploymentsResponse
Members
- BlueGreenDeployments
-
- Type: Array of BlueGreenDeployment structures
A list of blue/green deployments in the current account and Amazon Web Services Region.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeBlueGreenDeployments
request.
DescribeDBClusterSnapshotAttributesResult
Members
- DBClusterSnapshotAttributesResult
-
- Type: DBClusterSnapshotAttributesResult structure
Contains the results of a successful call to the
DescribeDBClusterSnapshotAttributes
API action.Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.
DescribeDBLogFilesDetails
Description
This data type is used as a response element to DescribeDBLogFiles
.
Members
- LastWritten
-
- Type: long (int|float)
A POSIX timestamp when the last log entry was written.
- LogFileName
-
- Type: string
The name of the log file for the specified DB instance.
- Size
-
- Type: long (int|float)
The size, in bytes, of the log file for the specified DB instance.
DescribeDBLogFilesResponse
Description
The response from a call to DescribeDBLogFiles
.
Members
- DescribeDBLogFiles
-
- Type: Array of DescribeDBLogFilesDetails structures
The DB log files returned.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeDBLogFiles
request.
DescribeDBProxiesResponse
Members
- DBProxies
-
- Type: Array of DBProxy structures
A return value representing an arbitrary number of
DBProxy
data structures. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DescribeDBProxyEndpointsResponse
Members
- DBProxyEndpoints
-
- Type: Array of DBProxyEndpoint structures
The list of
ProxyEndpoint
objects returned by the API operation. - Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DescribeDBProxyTargetGroupsResponse
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - TargetGroups
-
- Type: Array of DBProxyTargetGroup structures
An arbitrary number of
DBProxyTargetGroup
objects, containing details of the corresponding target groups.
DescribeDBProxyTargetsResponse
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - Targets
-
- Type: Array of DBProxyTarget structures
An arbitrary number of
DBProxyTarget
objects, containing details of the corresponding targets.
DescribeDBShardGroupsResponse
Members
- DBShardGroups
-
- Type: Array of DBShardGroup structures
Contains a list of DB shard groups for the user.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeDBClusters
request.
DescribeDBSnapshotAttributesResult
Members
- DBSnapshotAttributesResult
-
- Type: DBSnapshotAttributesResult structure
Contains the results of a successful call to the
DescribeDBSnapshotAttributes
API action.Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the
ModifyDBSnapshotAttribute
API action.
DescribeEngineDefaultClusterParametersResult
Members
- EngineDefaults
-
- Type: EngineDefaults structure
Contains the result of a successful invocation of the
DescribeEngineDefaultParameters
action.
DescribeEngineDefaultParametersResult
Members
- EngineDefaults
-
- Type: EngineDefaults structure
Contains the result of a successful invocation of the
DescribeEngineDefaultParameters
action.
DescribeIntegrationsResponse
Members
- Integrations
-
- Type: Array of Integration structures
A list of integrations.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeIntegrations
request.
DescribeValidDBInstanceModificationsResult
Members
- ValidDBInstanceModificationsMessage
-
- Type: ValidDBInstanceModificationsMessage structure
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the
DescribeValidDBInstanceModifications
action. You can use this information when you callModifyDBInstance
.
DisableHttpEndpointResponse
Members
- HttpEndpointEnabled
-
- Type: boolean
Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
- ResourceArn
-
- Type: string
The ARN of the DB cluster.
DocLink
Description
A link to documentation that provides additional information for a recommendation.
Members
- Text
-
- Type: string
The text with the link to documentation for the recommendation.
- Url
-
- Type: string
The URL for the documentation for the recommendation.
DomainMembership
Description
An Active Directory Domain membership record associated with the DB instance or cluster.
Members
- AuthSecretArn
-
- Type: string
The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.
- DnsIps
-
- Type: Array of strings
The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
- Domain
-
- Type: string
The identifier of the Active Directory Domain.
- FQDN
-
- Type: string
The fully qualified domain name (FQDN) of the Active Directory Domain.
- IAMRoleName
-
- Type: string
The name of the IAM role used when making API calls to the Directory Service.
- OU
-
- Type: string
The Active Directory organizational unit for the DB instance or cluster.
- Status
-
- Type: string
The status of the Active Directory Domain membership for the DB instance or cluster. Values include
joined
,pending-join
,failed
, and so on.
DomainNotFoundFault
Description
Domain
doesn't refer to an existing Active Directory domain.
Members
DoubleRange
Description
A range of double values.
Members
- From
-
- Type: double
The minimum value in the range.
- To
-
- Type: double
The maximum value in the range.
DownloadDBLogFilePortionDetails
Description
This data type is used as a response element to DownloadDBLogFilePortion
.
Members
- AdditionalDataPending
-
- Type: boolean
A Boolean value that, if true, indicates there is more data to be downloaded.
- LogFileData
-
- Type: string
Entries from the specified log file.
- Marker
-
- Type: string
A pagination token that can be used in a later
DownloadDBLogFilePortion
request.
EC2SecurityGroup
Description
This data type is used as a response element in the following actions:
-
AuthorizeDBSecurityGroupIngress
-
DescribeDBSecurityGroups
-
RevokeDBSecurityGroupIngress
Members
- EC2SecurityGroupId
-
- Type: string
Specifies the id of the EC2 security group.
- EC2SecurityGroupName
-
- Type: string
Specifies the name of the EC2 security group.
- EC2SecurityGroupOwnerId
-
- Type: string
Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the
EC2SecurityGroupName
field. - Status
-
- Type: string
Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
Ec2ImagePropertiesNotSupportedFault
Description
The AMI configuration prerequisite has not been met.
Members
EnableHttpEndpointResponse
Members
- HttpEndpointEnabled
-
- Type: boolean
Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
- ResourceArn
-
- Type: string
The ARN of the DB cluster.
Endpoint
Description
This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
-
CreateDBInstance
-
DescribeDBInstances
-
DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint
.
Members
- Address
-
- Type: string
Specifies the DNS address of the DB instance.
- HostedZoneId
-
- Type: string
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- Port
-
- Type: int
Specifies the port that the database engine is listening on.
EngineDefaults
Description
Contains the result of a successful invocation of the DescribeEngineDefaultParameters
action.
Members
- DBParameterGroupFamily
-
- Type: string
Specifies the name of the DB parameter group family that the engine default parameters apply to.
- Marker
-
- Type: string
An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - Parameters
-
- Type: Array of Parameter structures
Contains a list of engine default parameters.
Event
Description
This data type is used as a response element in the DescribeEvents action.
Members
- Date
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the date and time of the event.
- EventCategories
-
- Type: Array of strings
Specifies the category for the event.
- Message
-
- Type: string
Provides the text of this event.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) for the event.
- SourceIdentifier
-
- Type: string
Provides the identifier for the source of the event.
- SourceType
-
- Type: string
Specifies the source type for this event.
EventCategoriesMap
Description
Contains the results of a successful invocation of the DescribeEventCategories operation.
Members
- EventCategories
-
- Type: Array of strings
The event categories for the specified source type
- SourceType
-
- Type: string
The source type that the returned categories belong to
EventCategoriesMessage
Description
Data returned from the DescribeEventCategories
operation.
Members
- EventCategoriesMapList
-
- Type: Array of EventCategoriesMap structures
A list of
EventCategoriesMap
data types.
EventSubscription
Description
Contains the results of a successful invocation of the DescribeEventSubscriptions
action.
Members
- CustSubscriptionId
-
- Type: string
The RDS event notification subscription Id.
- CustomerAwsId
-
- Type: string
The Amazon Web Services customer account associated with the RDS event notification subscription.
- Enabled
-
- Type: boolean
Specifies whether the subscription is enabled. True indicates the subscription is enabled.
- EventCategoriesList
-
- Type: Array of strings
A list of event categories for the RDS event notification subscription.
- EventSubscriptionArn
-
- Type: string
The Amazon Resource Name (ARN) for the event subscription.
- SnsTopicArn
-
- Type: string
The topic ARN of the RDS event notification subscription.
- SourceIdsList
-
- Type: Array of strings
A list of source IDs for the RDS event notification subscription.
- SourceType
-
- Type: string
The source type for the RDS event notification subscription.
- Status
-
- Type: string
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
- SubscriptionCreationTime
-
- Type: string
The time the RDS event notification subscription was created.
EventSubscriptionQuotaExceededFault
Description
You have reached the maximum number of event subscriptions.
Members
EventSubscriptionsMessage
Description
Data returned by the DescribeEventSubscriptions action.
Members
- EventSubscriptionsList
-
- Type: Array of EventSubscription structures
A list of EventSubscriptions data types.
- Marker
-
- Type: string
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
EventsMessage
Description
Contains the result of a successful invocation of the DescribeEvents
action.
Members
- Events
-
- Type: Array of Event structures
A list of
Event
instances. - Marker
-
- Type: string
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
ExportTask
Description
Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks
operation.
Members
- ExportOnly
-
- Type: Array of strings
The data exported from the snapshot or cluster.
Valid Values:
-
database
- Export all the data from a specified database. -
database.table
table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schema
schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
- ExportTaskIdentifier
-
- Type: string
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
- FailureCause
-
- Type: string
The reason the export failed, if it failed.
- IamRoleArn
-
- Type: string
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
- KmsKeyId
-
- Type: string
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
- PercentProgress
-
- Type: int
The progress of the snapshot or cluster export task as a percentage.
- S3Bucket
-
- Type: string
The Amazon S3 bucket where the snapshot or cluster is exported to.
- S3Prefix
-
- Type: string
The Amazon S3 bucket prefix that is the file name and path of the exported data.
- SnapshotTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot was created.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
- SourceType
-
- Type: string
The type of source for the export.
- Status
-
- Type: string
The progress status of the export task. The status can be one of the following:
-
CANCELED
-
CANCELING
-
COMPLETE
-
FAILED
-
IN_PROGRESS
-
STARTING
- TaskEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot or cluster export task ended.
- TaskStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the snapshot or cluster export task started.
- TotalExtractedDataInGB
-
- Type: int
The total amount of data exported, in gigabytes.
- WarningMessage
-
- Type: string
A warning about the snapshot or cluster export task.
ExportTaskAlreadyExistsFault
Description
You can't start an export task that's already running.
Members
ExportTaskNotFoundFault
Description
The export task doesn't exist.
Members
ExportTasksMessage
Members
- ExportTasks
-
- Type: Array of ExportTask structures
Information about an export of a snapshot or cluster to Amazon S3.
- Marker
-
- Type: string
A pagination token that can be used in a later
DescribeExportTasks
request. A marker is used for pagination to identify the location to begin output for the next response ofDescribeExportTasks
.
FailoverDBClusterResult
Members
- DBCluster
-
- Type: 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.
FailoverGlobalClusterResult
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
FailoverState
Description
Contains the state of scheduled or in-process operations on a global cluster (Aurora global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Aurora global database.
Members
- FromDbClusterArn
-
- Type: string
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
- IsDataLossAllowed
-
- Type: boolean
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
- Status
-
- Type: string
The current status of the global cluster. Possible values are as follows:
-
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
-
failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.
-
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
-
switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.
- ToDbClusterArn
-
- Type: string
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
Filter
Description
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Currently, wildcards are not supported in filters.
The following actions can be filtered:
-
DescribeDBClusterBacktracks
-
DescribeDBClusterEndpoints
-
DescribeDBClusters
-
DescribeDBInstances
-
DescribeDBRecommendations
-
DescribeDBShardGroups
-
DescribePendingMaintenanceActions
Members
- Name
-
- Required: Yes
- Type: string
The name of the filter. Filter names are case-sensitive.
- Values
-
- Required: Yes
- Type: Array of strings
One or more filter values. Filter values are case-sensitive.
GlobalCluster
Description
A data type representing an Aurora global database.
Members
- DatabaseName
-
- Type: string
The default database name within the new global database cluster.
- DeletionProtection
-
- Type: boolean
The deletion protection setting for the new global database cluster.
- Endpoint
-
- Type: string
The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
- Engine
-
- Type: string
The Aurora database engine used by the global database cluster.
- EngineLifecycleSupport
-
- Type: string
The life cycle type for the global cluster.
For more information, see CreateGlobalCluster.
- EngineVersion
-
- Type: string
Indicates the database engine version.
- FailoverState
-
- Type: FailoverState structure
A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the
SwitchoverGlobalCluster
orFailoverGlobalCluster
operation was called on this global cluster. - GlobalClusterArn
-
- Type: string
The Amazon Resource Name (ARN) for the global database cluster.
- GlobalClusterIdentifier
-
- Type: string
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
- GlobalClusterMembers
-
- Type: Array of GlobalClusterMember structures
The list of primary and secondary clusters within the global database cluster.
- GlobalClusterResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
- Status
-
- Type: string
Specifies the current state of this global database cluster.
- StorageEncrypted
-
- Type: boolean
The storage encryption setting for the global database cluster.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
GlobalClusterAlreadyExistsFault
Description
The GlobalClusterIdentifier
already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.
Members
GlobalClusterMember
Description
A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).
Members
- DBClusterArn
-
- Type: string
The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
- GlobalWriteForwardingStatus
-
- Type: string
The status of write forwarding for a secondary cluster in the global cluster.
- IsWriter
-
- Type: boolean
Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
- Readers
-
- Type: Array of strings
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.
- SynchronizationStatus
-
- Type: string
The status of synchronization of each Aurora DB cluster in the global cluster.
GlobalClusterNotFoundFault
Description
The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
Members
GlobalClusterQuotaExceededFault
Description
The number of global database clusters for this account is already at the maximum allowed.
Members
GlobalClustersMessage
Members
- GlobalClusters
-
- Type: Array of GlobalCluster structures
The list of global clusters returned by this request.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeGlobalClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
IPRange
Description
This data type is used as a response element in the DescribeDBSecurityGroups
action.
Members
- CIDRIP
-
- Type: string
The IP range.
- Status
-
- Type: string
The status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
IamRoleMissingPermissionsFault
Description
The IAM role requires additional permissions to export to an Amazon S3 bucket.
Members
IamRoleNotFoundFault
Description
The IAM role is missing for exporting to an Amazon S3 bucket.
Members
InstanceQuotaExceededFault
Description
The request would result in the user exceeding the allowed number of DB instances.
Members
InsufficientAvailableIPsInSubnetFault
Description
The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.
Members
InsufficientDBClusterCapacityFault
Description
The DB cluster doesn't have enough capacity for the current operation.
Members
InsufficientDBInstanceCapacityFault
Description
The specified DB instance class isn't available in the specified Availability Zone.
Members
InsufficientStorageClusterCapacityFault
Description
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
Members
Integration
Description
A zero-ETL integration with Amazon Redshift.
Members
- AdditionalEncryptionContext
-
- Type: Associative array of custom strings keys (String) to strings
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the integration was created, in Universal Coordinated Time (UTC).
- DataFilter
-
- Type: string
Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
- Description
-
- Type: string
A description of the integration.
- Errors
-
- Type: Array of IntegrationError structures
Any errors associated with the integration.
- IntegrationArn
-
- Type: string
The ARN of the integration.
- IntegrationName
-
- Type: string
The name of the integration.
- KMSKeyId
-
- Type: string
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
- SourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the database used as the source for replication.
- Status
-
- Type: string
The current status of the integration.
- Tags
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TargetArn
-
- Type: string
The ARN of the Redshift data warehouse used as the target for replication.
IntegrationAlreadyExistsFault
Description
The integration you are trying to create already exists.
Members
IntegrationConflictOperationFault
Description
A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
Members
IntegrationError
Description
An error associated with a zero-ETL integration with Amazon Redshift.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code associated with the integration.
- ErrorMessage
-
- Type: string
A message explaining the error.
IntegrationNotFoundFault
Description
The specified integration could not be found.
Members
IntegrationQuotaExceededFault
Description
You can't crate any more zero-ETL integrations because the quota has been reached.
Members
InvalidBlueGreenDeploymentStateFault
Description
The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.
Members
InvalidCustomDBEngineVersionStateFault
Description
You can't delete the CEV.
Members
InvalidDBClusterAutomatedBackupStateFault
Description
The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.
Members
InvalidDBClusterCapacityFault
Description
Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2
, 4
, 8
, 16
, 32
, 64
, 128
, and 256
.
Members
InvalidDBClusterEndpointStateFault
Description
The requested operation can't be performed on the endpoint while the endpoint is in this state.
Members
InvalidDBClusterSnapshotStateFault
Description
The supplied value isn't a valid DB cluster snapshot state.
Members
InvalidDBClusterStateFault
Description
The requested operation can't be performed while the cluster is in this state.
Members
InvalidDBInstanceAutomatedBackupStateFault
Description
The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.
Members
InvalidDBInstanceStateFault
Description
The DB instance isn't in a valid state.
Members
InvalidDBParameterGroupStateFault
Description
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
Members
InvalidDBProxyEndpointStateFault
Description
You can't perform this operation while the DB proxy endpoint is in a particular state.
Members
InvalidDBProxyStateFault
Description
The requested operation can't be performed while the proxy is in this state.
Members
InvalidDBSecurityGroupStateFault
Description
The state of the DB security group doesn't allow deletion.
Members
InvalidDBShardGroupStateFault
Description
The DB shard group must be in the available state.
Members
InvalidDBSnapshotStateFault
Description
The state of the DB snapshot doesn't allow deletion.
Members
InvalidDBSubnetGroupFault
Description
The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
Members
InvalidDBSubnetGroupStateFault
Description
The DB subnet group cannot be deleted because it's in use.
Members
InvalidDBSubnetStateFault
Description
The DB subnet isn't in the available state.
Members
InvalidEventSubscriptionStateFault
Description
This error can occur if someone else is modifying a subscription. You should retry the action.
Members
InvalidExportOnlyFault
Description
The export is invalid for exporting to an Amazon S3 bucket.
Members
InvalidExportSourceStateFault
Description
The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
Members
InvalidExportTaskStateFault
Description
You can't cancel an export task that has completed.
Members
InvalidGlobalClusterStateFault
Description
The global cluster is in an invalid state and can't perform the requested operation.
Members
InvalidIntegrationStateFault
Description
The integration is in an invalid state and can't perform the requested operation.
Members
InvalidOptionGroupStateFault
Description
The option group isn't in the available state.
Members
InvalidResourceStateFault
Description
The operation can't be performed because another operation is in progress.
Members
InvalidRestoreFault
Description
Cannot restore from VPC backup to non-VPC DB instance.
Members
InvalidS3BucketFault
Description
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
Members
InvalidSubnet
Description
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
Members
InvalidVPCNetworkStateFault
Description
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
Members
IssueDetails
Description
The details of an issue with your DB instances, DB clusters, and DB parameter groups.
Members
- PerformanceIssueDetails
-
- Type: PerformanceIssueDetails structure
A detailed description of the issue when the recommendation category is
performance
.
KMSKeyNotAccessibleFault
Description
An error occurred accessing an Amazon Web Services KMS key.
Members
LimitlessDatabase
Description
Contains details for Aurora Limitless Database.
Members
- MinRequiredACU
-
- Type: double
The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).
- Status
-
- Type: string
The status of Aurora Limitless Database.
MasterUserSecret
Description
Contains 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.
Members
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
- SecretArn
-
- Type: string
The Amazon Resource Name (ARN) of the secret.
- SecretStatus
-
- Type: string
The status of the secret.
The possible status values include the following:
-
creating
- The secret is being created. -
active
- The secret is available for normal use and rotation. -
rotating
- The secret is being rotated. -
impaired
- The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
MaxDBShardGroupLimitReached
Description
The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.
Members
Metric
Description
The representation of a metric.
Members
- MetricQuery
-
- Type: MetricQuery structure
The query to retrieve metric data points.
- Name
-
- Type: string
The name of a metric.
- References
-
- Type: Array of MetricReference structures
A list of metric references (thresholds).
- StatisticsDetails
-
- Type: string
The details of different statistics for a metric. The description might contain markdown.
MetricQuery
Description
The query to retrieve metric data points.
Members
- PerformanceInsightsMetricQuery
-
- Type: PerformanceInsightsMetricQuery structure
The Performance Insights query that you can use to retrieve Performance Insights metric data points.
MetricReference
Description
The reference (threshold) for a metric.
Members
- Name
-
- Type: string
The name of the metric reference.
- ReferenceDetails
-
- Type: ReferenceDetails structure
The details of a performance issue.
MinimumEngineVersionPerAllowedValue
Description
The minimum DB engine version required for each corresponding allowed value for an option setting.
Members
- AllowedValue
-
- Type: string
The allowed value for an option setting.
- MinimumEngineVersion
-
- Type: string
The minimum DB engine version required for the allowed value.
ModifyActivityStreamResponse
Members
- EngineNativeAuditFieldsIncluded
-
- Type: boolean
Indicates whether engine-native audit fields are included in the database activity stream.
- KinesisStreamName
-
- Type: string
The name of the Amazon Kinesis data stream to be used for the database activity stream.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
- Mode
-
- Type: string
The mode of the database activity stream.
- PolicyStatus
-
- Type: string
The status of the modification to the policy state of the database activity stream.
- Status
-
- Type: string
The status of the modification to the database activity stream.
ModifyCertificatesResult
Members
- Certificate
-
- Type: Certificate structure
A CA certificate for an Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
ModifyDBClusterResult
Members
- DBCluster
-
- Type: 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.
ModifyDBClusterSnapshotAttributeResult
Members
- DBClusterSnapshotAttributesResult
-
- Type: DBClusterSnapshotAttributesResult structure
Contains the results of a successful call to the
DescribeDBClusterSnapshotAttributes
API action.Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.
ModifyDBInstanceResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
ModifyDBProxyEndpointResponse
Members
- DBProxyEndpoint
-
- Type: DBProxyEndpoint structure
The
DBProxyEndpoint
object representing the new settings for the DB proxy endpoint.
ModifyDBProxyResponse
Members
- DBProxy
-
- Type: DBProxy structure
The
DBProxy
object representing the new settings for the proxy.
ModifyDBProxyTargetGroupResponse
Members
- DBProxyTargetGroup
-
- Type: DBProxyTargetGroup structure
The settings of the modified
DBProxyTarget
.
ModifyDBSnapshotAttributeResult
Members
- DBSnapshotAttributesResult
-
- Type: DBSnapshotAttributesResult structure
Contains the results of a successful call to the
DescribeDBSnapshotAttributes
API action.Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the
ModifyDBSnapshotAttribute
API action.
ModifyDBSnapshotResult
Members
- DBSnapshot
-
- Type: DBSnapshot structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
ModifyDBSubnetGroupResult
Members
- DBSubnetGroup
-
- Type: DBSubnetGroup structure
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the
DescribeDBSubnetGroups
action.
ModifyEventSubscriptionResult
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
ModifyGlobalClusterResult
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
ModifyOptionGroupResult
Members
- OptionGroup
-
- Type: OptionGroup structure
ModifyTenantDatabaseResult
Members
- TenantDatabase
-
- Type: TenantDatabase structure
A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.
NetworkTypeNotSupported
Description
The network type is invalid for the DB instance. Valid nework type values are IPV4
and DUAL
.
Members
Option
Description
The details of an option.
Members
- DBSecurityGroupMemberships
-
- Type: Array of DBSecurityGroupMembership structures
If the option requires access to a port, then this DB security group allows access to the port.
- OptionDescription
-
- Type: string
The description of the option.
- OptionName
-
- Type: string
The name of the option.
- OptionSettings
-
- Type: Array of OptionSetting structures
The option settings for this option.
- OptionVersion
-
- Type: string
The version of the option.
- Permanent
-
- Type: boolean
Indicates whether this option is permanent.
- Persistent
-
- Type: boolean
Indicates whether this option is persistent.
- Port
-
- Type: int
If required, the port configured for this option to use.
- VpcSecurityGroupMemberships
-
- Type: Array of VpcSecurityGroupMembership structures
If the option requires access to a port, then this VPC security group allows access to the port.
OptionConfiguration
Description
A list of all available options for an option group.
Members
- DBSecurityGroupMemberships
-
- Type: Array of strings
A list of DB security groups used for this option.
- OptionName
-
- Required: Yes
- Type: string
The configuration of options to include in a group.
- OptionSettings
-
- Type: Array of OptionSetting structures
The option settings to include in an option group.
- OptionVersion
-
- Type: string
The version for the option.
- Port
-
- Type: int
The optional port for the option.
- VpcSecurityGroupMemberships
-
- Type: Array of strings
A list of VPC security group names used for this option.
OptionGroup
Description
Members
- AllowsVpcAndNonVpcInstanceMemberships
-
- Type: boolean
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value
true
indicates the option group can be applied to both VPC and non-VPC instances. - CopyTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Indicates when the option group was copied.
- EngineName
-
- Type: string
Indicates the name of the engine that this option group can be applied to.
- MajorEngineVersion
-
- Type: string
Indicates the major engine version associated with this option group.
- OptionGroupArn
-
- Type: string
Specifies the Amazon Resource Name (ARN) for the option group.
- OptionGroupDescription
-
- Type: string
Provides a description of the option group.
- OptionGroupName
-
- Type: string
Specifies the name of the option group.
- Options
-
- Type: Array of Option structures
Indicates what options are available in the option group.
- SourceAccountId
-
- Type: string
Specifies the Amazon Web Services account ID for the option group from which this option group is copied.
- SourceOptionGroup
-
- Type: string
Specifies the name of the option group from which this option group is copied.
- VpcId
-
- Type: string
If AllowsVpcAndNonVpcInstanceMemberships is
false
, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships istrue
and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
OptionGroupAlreadyExistsFault
Description
The option group you are trying to create already exists.
Members
OptionGroupMembership
Description
Provides information on the option groups the DB instance is a member of.
Members
- OptionGroupName
-
- Type: string
The name of the option group that the instance belongs to.
- Status
-
- Type: string
The status of the DB instance's option group membership. Valid values are:
in-sync
,pending-apply
,pending-removal
,pending-maintenance-apply
,pending-maintenance-removal
,applying
,removing
, andfailed
.
OptionGroupNotFoundFault
Description
The specified option group could not be found.
Members
OptionGroupOption
Description
Available option.
Members
- CopyableCrossAccount
-
- Type: boolean
Indicates whether the option can be copied across Amazon Web Services accounts.
- DefaultPort
-
- Type: int
If the option requires a port, specifies the default port for the option.
- Description
-
- Type: string
The description of the option.
- EngineName
-
- Type: string
The name of the engine that this option can be applied to.
- MajorEngineVersion
-
- Type: string
Indicates the major engine version that the option is available for.
- MinimumRequiredMinorEngineVersion
-
- Type: string
The minimum required engine version for the option to be applied.
- Name
-
- Type: string
The name of the option.
- OptionGroupOptionSettings
-
- Type: Array of OptionGroupOptionSetting structures
The option settings that are available (and the default value) for each option in an option group.
- OptionGroupOptionVersions
-
- Type: Array of OptionVersion structures
The versions that are available for the option.
- OptionsConflictsWith
-
- Type: Array of strings
The options that conflict with this option.
- OptionsDependedOn
-
- Type: Array of strings
The options that are prerequisites for this option.
- Permanent
-
- Type: boolean
Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
- Persistent
-
- Type: boolean
Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
- PortRequired
-
- Type: boolean
Indicates whether the option requires a port.
- RequiresAutoMinorEngineVersionUpgrade
-
- Type: boolean
If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
- SupportsOptionVersionDowngrade
-
- Type: boolean
If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
- VpcOnly
-
- Type: boolean
If true, you can only use this option with a DB instance that is in a VPC.
OptionGroupOptionSetting
Description
Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
Members
- AllowedValues
-
- Type: string
Indicates the acceptable values for the option group option.
- ApplyType
-
- Type: string
The DB engine specific parameter type for the option group option.
- DefaultValue
-
- Type: string
The default value for the option group option.
- IsModifiable
-
- Type: boolean
Indicates whether this option group option can be changed from the default value.
- IsRequired
-
- Type: boolean
Indicates whether a value must be specified for this option setting of the option group option.
- MinimumEngineVersionPerAllowedValue
-
- Type: Array of MinimumEngineVersionPerAllowedValue structures
The minimum DB engine version required for the corresponding allowed value for this option setting.
- SettingDescription
-
- Type: string
The description of the option group option.
- SettingName
-
- Type: string
The name of the option group option.
OptionGroupOptionsMessage
Description
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - OptionGroupOptions
-
- Type: Array of OptionGroupOption structures
List of available option group options.
OptionGroupQuotaExceededFault
Description
The quota of 20 option groups was exceeded for this Amazon Web Services account.
Members
OptionGroups
Description
List of option groups.
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - OptionGroupsList
-
- Type: Array of OptionGroup structures
List of option groups.
OptionSetting
Description
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
Members
- AllowedValues
-
- Type: string
The allowed values of the option setting.
- ApplyType
-
- Type: string
The DB engine specific parameter type.
- DataType
-
- Type: string
The data type of the option setting.
- DefaultValue
-
- Type: string
The default value of the option setting.
- Description
-
- Type: string
The description of the option setting.
- IsCollection
-
- Type: boolean
Indicates whether the option setting is part of a collection.
- IsModifiable
-
- Type: boolean
Indicates whether the option setting can be modified from the default.
- Name
-
- Type: string
The name of the option that has settings that you can set.
- Value
-
- Type: string
The current value of the option setting.
OptionVersion
Description
The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions
action.
Members
- IsDefault
-
- Type: boolean
Indicates whether the version is the default version of the option.
- Version
-
- Type: string
The version of the option.
OrderableDBInstanceOption
Description
Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions
action.
Members
- AvailabilityZoneGroup
-
- Type: string
The Availability Zone group for a DB instance.
- AvailabilityZones
-
- Type: Array of AvailabilityZone structures
A list of Availability Zones for a DB instance.
- AvailableProcessorFeatures
-
- Type: Array of AvailableProcessorFeature structures
A list of the available processor features for the DB instance class of a DB instance.
- DBInstanceClass
-
- Type: string
The DB instance class for a DB instance.
- Engine
-
- Type: string
The engine type of a DB instance.
- EngineVersion
-
- Type: string
The engine version of a DB instance.
- LicenseModel
-
- Type: string
The license model for a DB instance.
- MaxIopsPerDbInstance
-
- Type: int
Maximum total provisioned IOPS for a DB instance.
- MaxIopsPerGib
-
- Type: double
Maximum provisioned IOPS per GiB for a DB instance.
- MaxStorageSize
-
- Type: int
Maximum storage size for a DB instance.
- MaxStorageThroughputPerDbInstance
-
- Type: int
Maximum storage throughput for a DB instance.
- MaxStorageThroughputPerIops
-
- Type: double
Maximum storage throughput to provisioned IOPS ratio for a DB instance.
- MinIopsPerDbInstance
-
- Type: int
Minimum total provisioned IOPS for a DB instance.
- MinIopsPerGib
-
- Type: double
Minimum provisioned IOPS per GiB for a DB instance.
- MinStorageSize
-
- Type: int
Minimum storage size for a DB instance.
- MinStorageThroughputPerDbInstance
-
- Type: int
Minimum storage throughput for a DB instance.
- MinStorageThroughputPerIops
-
- Type: double
Minimum storage throughput to provisioned IOPS ratio for a DB instance.
- MultiAZCapable
-
- Type: boolean
Indicates whether a DB instance is Multi-AZ capable.
- OutpostCapable
-
- Type: boolean
Indicates whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- ReadReplicaCapable
-
- Type: boolean
Indicates whether a DB instance can have a read replica.
- StorageType
-
- Type: string
The storage type for a DB instance.
- SupportedActivityStreamModes
-
- Type: Array of strings
The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value
[sync, async]
. Aurora MySQL and RDS for Oracle return[async]
only. If Database Activity Streams isn't supported, the return value is an empty list. - SupportedEngineModes
-
- Type: Array of strings
A list of the supported DB engine modes.
- SupportedNetworkTypes
-
- Type: Array of strings
The network types supported by the DB instance (
IPV4
orDUAL
).A DB instance 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 RDS User Guide.
- SupportsClusters
-
- Type: boolean
Indicates whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- SupportsDedicatedLogVolume
-
- Type: boolean
Indicates whether a DB instance supports using a dedicated log volume (DLV).
- SupportsEnhancedMonitoring
-
- Type: boolean
Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
- SupportsGlobalDatabases
-
- Type: boolean
Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
- SupportsIAMDatabaseAuthentication
-
- Type: boolean
Indicates whether a DB instance supports IAM database authentication.
- SupportsIops
-
- Type: boolean
Indicates whether a DB instance supports provisioned IOPS.
- SupportsKerberosAuthentication
-
- Type: boolean
Indicates whether a DB instance supports Kerberos Authentication.
- SupportsPerformanceInsights
-
- Type: boolean
Indicates whether a DB instance supports Performance Insights.
- SupportsStorageAutoscaling
-
- Type: boolean
Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
- SupportsStorageEncryption
-
- Type: boolean
Indicates whether a DB instance supports encrypted storage.
- SupportsStorageThroughput
-
- Type: boolean
Indicates whether a DB instance supports storage throughput.
- Vpc
-
- Type: boolean
Indicates whether a DB instance is in a VPC.
OrderableDBInstanceOptionsMessage
Description
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions
action.
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - OrderableDBInstanceOptions
-
- Type: Array of OrderableDBInstanceOption structures
An
OrderableDBInstanceOption
structure containing information about orderable options for the DB instance.
Outpost
Description
A data type that represents an Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the Outpost.
Parameter
Description
This data type is used as a request parameter in the ModifyDBParameterGroup
and ResetDBParameterGroup
actions.
This data type is used as a response element in the DescribeEngineDefaultParameters
and DescribeDBParameters
actions.
Members
- AllowedValues
-
- Type: string
Specifies the valid range of values for the parameter.
- ApplyMethod
-
- Type: string
Indicates when to apply parameter updates.
- ApplyType
-
- Type: string
Specifies the engine specific parameters type.
- DataType
-
- Type: string
Specifies the valid data type for the parameter.
- Description
-
- Type: string
Provides a description of the parameter.
- IsModifiable
-
- Type: boolean
Indicates whether (
true
) or not (false
) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. - MinimumEngineVersion
-
- Type: string
The earliest engine version to which the parameter can apply.
- ParameterName
-
- Type: string
The name of the parameter.
- ParameterValue
-
- Type: string
The value of the parameter.
- Source
-
- Type: string
The source of the parameter value.
- SupportedEngineModes
-
- Type: Array of strings
The valid DB engine modes.
PendingCloudwatchLogsExports
Description
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.
Members
- LogTypesToDisable
-
- Type: Array of strings
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
- LogTypesToEnable
-
- Type: Array of strings
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
PendingMaintenanceAction
Description
Provides information about a pending maintenance action for a resource.
Members
- Action
-
- Type: string
The type of pending maintenance action that is available for the resource.
For more information about maintenance actions, see Maintaining a DB instance.
Valid Values:
-
ca-certificate-rotation
-
db-upgrade
-
hardware-maintenance
-
os-upgrade
-
system-update
For more information about these actions, see Maintenance actions for Amazon Aurora or Maintenance actions for Amazon RDS.
- AutoAppliedAfterDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
- CurrentApplyDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the
ApplyPendingMaintenanceAction
API, theAutoAppliedAfterDate
, and theForcedApplyDate
. This value is blank if an opt-in request has not been received and nothing has been specified asAutoAppliedAfterDate
orForcedApplyDate
. - Description
-
- Type: string
A description providing more detail about the maintenance action.
- ForcedApplyDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
- OptInStatus
-
- Type: string
Indicates the type of opt-in request that has been received for the resource.
PendingMaintenanceActionsMessage
Description
Data returned from the DescribePendingMaintenanceActions action.
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribePendingMaintenanceActions
request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified byMaxRecords
. - PendingMaintenanceActions
-
- Type: Array of ResourcePendingMaintenanceActions structures
A list of the pending maintenance actions for the resource.
PendingModifiedValues
Description
This data type is used as a response element in the ModifyDBInstance
operation and contains changes that will be applied during the next maintenance window.
Members
- AllocatedStorage
-
- Type: int
The allocated storage size for the DB instance specified in gibibytes (GiB).
- AutomationMode
-
- Type: string
The automation mode of the RDS Custom DB instance:
full
orall-paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall-paused
, the instance pauses automation for the duration set by--resume-full-automation-mode-minutes
. - BackupRetentionPeriod
-
- Type: int
The number of days for which automated backups are retained.
- CACertificateIdentifier
-
- Type: string
The identifier of the CA certificate for the DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- DBInstanceClass
-
- Type: string
The name of the compute and memory capacity class for the DB instance.
- DBInstanceIdentifier
-
- Type: string
The database identifier for the DB instance.
- DBSubnetGroupName
-
- Type: string
The DB subnet group for the DB instance.
- DedicatedLogVolume
-
- Type: boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>
- Engine
-
- Type: string
The database engine of the DB instance.
- EngineVersion
-
- Type: string
The database engine version.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- Iops
-
- Type: int
The Provisioned IOPS value for the DB instance.
- LicenseModel
-
- Type: string
The license model for the DB instance.
Valid values:
license-included
|bring-your-own-license
|general-public-license
- MasterUserPassword
-
- Type: string
The master credentials for the DB instance.
- MultiAZ
-
- Type: boolean
Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
- MultiTenant
-
- Type: boolean
Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
- PendingCloudwatchLogsExports
-
- Type: 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.
- Port
-
- Type: int
The port for the DB instance.
- ProcessorFeatures
-
- Type: Array of ProcessorFeature structures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- ResumeFullAutomationModeTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
- StorageThroughput
-
- Type: int
The storage throughput of the DB instance.
- StorageType
-
- Type: string
The storage type of the DB instance.
PerformanceInsightsMetricDimensionGroup
Description
A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql
dimension group consists of the following dimensions:
-
db.sql.id
- The hash of a running SQL statement, generated by Performance Insights. -
db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins withpi-
. -
db.sql.statement
- The full text of the SQL statement that is running, for example,SELECT * FROM employees
. -
db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Members
- Dimensions
-
- Type: Array of strings
A list of specific dimensions from a dimension group. If this list isn't included, then all of the dimensions in the group were requested, or are present in the response.
- Group
-
- Type: string
The available dimension groups for Performance Insights metric type.
- Limit
-
- Type: int
The maximum number of items to fetch for this dimension group.
PerformanceInsightsMetricQuery
Description
A single Performance Insights metric query to process. You must provide the metric to the query. If other parameters aren't specified, Performance Insights returns all data points for the specified metric. Optionally, you can request the data points to be aggregated by dimension group (GroupBy
) and return only those data points that match your criteria (Filter
).
Constraints:
-
Must be a valid Performance Insights query.
Members
- GroupBy
-
- Type: PerformanceInsightsMetricDimensionGroup structure
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
- Metric
-
- Type: string
The name of a Performance Insights metric to be measured.
Valid Values:
-
db.load.avg
- A scaled representation of the number of active sessions for the database engine. -
db.sampledload.avg
- The raw number of active sessions for the database engine. -
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
anddb.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avg
showing the scaled values,db.sampledload.avg
showing the raw values, anddb.sampledload.avg
less thandb.load.avg
. For most use cases, you can querydb.load.avg
only.
PerformanceIssueDetails
Description
Details of the performance issue.
Members
- Analysis
-
- Type: string
The analysis of the performance issue. The information might contain markdown.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the performance issue stopped.
- Metrics
-
- Type: Array of Metric structures
The metrics that are relevant to the performance issue.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the performance issue started.
PointInTimeRestoreNotEnabledFault
Description
SourceDBInstanceIdentifier
refers to a DB instance with BackupRetentionPeriod
equal to 0.
Members
ProcessorFeature
Description
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount
feature name for the Name
parameter. To specify the number of threads per core, use the threadsPerCore
feature name for the Name
parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
-
CreateDBInstance
-
ModifyDBInstance
-
RestoreDBInstanceFromDBSnapshot
-
RestoreDBInstanceFromS3
-
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions
action and specifying the instance class for the DBInstanceClass
parameter.
In addition, you can use the following actions for DB instance class processor information:
-
DescribeDBInstances
-
DescribeDBSnapshots
-
DescribeValidDBInstanceModifications
If you call DescribeDBInstances
, ProcessorFeature
returns non-null values only if the following conditions are met:
-
You are accessing an Oracle DB instance.
-
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
-
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle in the Amazon RDS User Guide.
Members
- Name
-
- Type: string
The name of the processor feature. Valid names are
coreCount
andthreadsPerCore
. - Value
-
- Type: string
The value of a processor feature.
PromoteReadReplicaDBClusterResult
Members
- DBCluster
-
- Type: 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.
PromoteReadReplicaResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
ProvisionedIopsNotAvailableInAZFault
Description
Provisioned IOPS not available in the specified Availability Zone.
Members
PurchaseReservedDBInstancesOfferingResult
Members
- ReservedDBInstance
-
- Type: ReservedDBInstance structure
This data type is used as a response element in the
DescribeReservedDBInstances
andPurchaseReservedDBInstancesOffering
actions.
Range
Description
A range of integer values.
Members
- From
-
- Type: int
The minimum value in the range.
- Step
-
- Type: int
The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
- To
-
- Type: int
The maximum value in the range.
RdsCustomClusterConfiguration
Description
Reserved for future use.
Members
- InterconnectSubnetId
-
- Type: string
Reserved for future use.
- ReplicaMode
-
- Type: string
Reserved for future use.
- TransitGatewayMulticastDomainId
-
- Type: string
Reserved for future use.
RebootDBClusterResult
Members
- DBCluster
-
- Type: 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.
RebootDBInstanceResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
RecommendedAction
Description
The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.
Members
- ActionId
-
- Type: string
The unique identifier of the recommended action.
- ApplyModes
-
- Type: Array of strings
The methods to apply the recommended action.
Valid values:
-
manual
- The action requires you to resolve the recommendation manually. -
immediately
- The action is applied immediately. -
next-maintainance-window
- The action is applied during the next scheduled maintainance.
- ContextAttributes
-
- Type: Array of ContextAttribute structures
The supporting attributes to explain the recommended action.
- Description
-
- Type: string
A detailed description of the action. The description might contain markdown.
- IssueDetails
-
- Type: IssueDetails structure
The details of the issue.
- Operation
-
- Type: string
An API operation for the action.
- Parameters
-
- Type: Array of RecommendedActionParameter structures
The parameters for the API operation.
- Status
-
- Type: string
The status of the action.
-
ready
-
applied
-
scheduled
-
resolved
- Title
-
- Type: string
A short description to summarize the action. The description might contain markdown.
RecommendedActionParameter
Description
A single parameter to use with the RecommendedAction
API operation to apply the action.
Members
- Key
-
- Type: string
The key of the parameter to use with the
RecommendedAction
API operation. - Value
-
- Type: string
The value of the parameter to use with the
RecommendedAction
API operation.
RecommendedActionUpdate
Description
The recommended status to update for the specified recommendation action ID.
Members
- ActionId
-
- Required: Yes
- Type: string
A unique identifier of the updated recommendation action.
- Status
-
- Required: Yes
- Type: string
The status of the updated recommendation action.
-
applied
-
scheduled
RecurringCharge
Description
This data type is used as a response element in the DescribeReservedDBInstances
and DescribeReservedDBInstancesOfferings
actions.
Members
- RecurringChargeAmount
-
- Type: double
The amount of the recurring charge.
- RecurringChargeFrequency
-
- Type: string
The frequency of the recurring charge.
ReferenceDetails
Description
The reference details of a metric.
Members
- ScalarReferenceDetails
-
- Type: ScalarReferenceDetails structure
The metric reference details when the reference is a scalar.
RegisterDBProxyTargetsResponse
Members
- DBProxyTargets
-
- Type: Array of DBProxyTarget structures
One or more
DBProxyTarget
objects that are created when you register targets with a target group.
RemoveFromGlobalClusterResult
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
RemoveSourceIdentifierFromSubscriptionResult
Members
- EventSubscription
-
- Type: EventSubscription structure
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
ReservedDBInstance
Description
This data type is used as a response element in the DescribeReservedDBInstances
and PurchaseReservedDBInstancesOffering
actions.
Members
- CurrencyCode
-
- Type: string
The currency code for the reserved DB instance.
- DBInstanceClass
-
- Type: string
The DB instance class for the reserved DB instance.
- DBInstanceCount
-
- Type: int
The number of reserved DB instances.
- Duration
-
- Type: int
The duration of the reservation in seconds.
- FixedPrice
-
- Type: double
The fixed price charged for this reserved DB instance.
- LeaseId
-
- Type: string
The unique identifier for the lease associated with the reserved DB instance.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
- MultiAZ
-
- Type: boolean
Indicates whether the reservation applies to Multi-AZ deployments.
- OfferingType
-
- Type: string
The offering type of this reserved DB instance.
- ProductDescription
-
- Type: string
The description of the reserved DB instance.
- RecurringCharges
-
- Type: Array of RecurringCharge structures
The recurring price charged to run this reserved DB instance.
- ReservedDBInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) for the reserved DB instance.
- ReservedDBInstanceId
-
- Type: string
The unique identifier for the reservation.
- ReservedDBInstancesOfferingId
-
- Type: string
The offering identifier.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the reservation started.
- State
-
- Type: string
The state of the reserved DB instance.
- UsagePrice
-
- Type: double
The hourly price charged for this reserved DB instance.
ReservedDBInstanceAlreadyExistsFault
Description
User already has a reservation with the given identifier.
Members
ReservedDBInstanceMessage
Description
Contains the result of a successful invocation of the DescribeReservedDBInstances
action.
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - ReservedDBInstances
-
- Type: Array of ReservedDBInstance structures
A list of reserved DB instances.
ReservedDBInstanceNotFoundFault
Description
The specified reserved DB Instance not found.
Members
ReservedDBInstanceQuotaExceededFault
Description
Request would exceed the user's DB Instance quota.
Members
ReservedDBInstancesOffering
Description
This data type is used as a response element in the DescribeReservedDBInstancesOfferings
action.
Members
- CurrencyCode
-
- Type: string
The currency code for the reserved DB instance offering.
- DBInstanceClass
-
- Type: string
The DB instance class for the reserved DB instance.
- Duration
-
- Type: int
The duration of the offering in seconds.
- FixedPrice
-
- Type: double
The fixed price charged for this offering.
- MultiAZ
-
- Type: boolean
Indicates whether the offering applies to Multi-AZ deployments.
- OfferingType
-
- Type: string
The offering type.
- ProductDescription
-
- Type: string
The database engine used by the offering.
- RecurringCharges
-
- Type: Array of RecurringCharge structures
The recurring price charged to run this reserved DB instance.
- ReservedDBInstancesOfferingId
-
- Type: string
The offering identifier.
- UsagePrice
-
- Type: double
The hourly price charged for this offering.
ReservedDBInstancesOfferingMessage
Description
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings
action.
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - ReservedDBInstancesOfferings
-
- Type: Array of ReservedDBInstancesOffering structures
A list of reserved DB instance offerings.
ReservedDBInstancesOfferingNotFoundFault
Description
Specified offering does not exist.
Members
ResourceNotFoundFault
Description
The specified resource ID was not found.
Members
ResourcePendingMaintenanceActions
Description
Describes the pending maintenance actions for a resource.
Members
- PendingMaintenanceActionDetails
-
- Type: Array of PendingMaintenanceAction structures
A list that provides details about the pending maintenance actions for the resource.
- ResourceIdentifier
-
- Type: string
The ARN of the resource that has pending maintenance actions.
RestoreDBClusterFromS3Result
Members
- DBCluster
-
- Type: 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.
RestoreDBClusterFromSnapshotResult
Members
- DBCluster
-
- Type: 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.
RestoreDBClusterToPointInTimeResult
Members
- DBCluster
-
- Type: 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.
RestoreDBInstanceFromDBSnapshotResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
RestoreDBInstanceFromS3Result
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
RestoreDBInstanceToPointInTimeResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
RestoreWindow
Description
Earliest and latest time an instance can be restored to:
Members
- EarliestTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The earliest time you can restore an instance to.
- LatestTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The latest time you can restore an instance to.
RevokeDBSecurityGroupIngressResult
Members
- DBSecurityGroup
-
- Type: DBSecurityGroup structure
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
SNSInvalidTopicFault
Description
SNS has responded that there is a problem with the SNS topic specified.
Members
SNSNoAuthorizationFault
Description
You do not have permission to publish to the SNS topic ARN.
Members
SNSTopicArnNotFoundFault
Description
The SNS topic ARN does not exist.
Members
ScalarReferenceDetails
Description
The metric reference details when the reference is a scalar.
Members
- Value
-
- Type: double
The value of a scalar reference.
ScalingConfiguration
Description
Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
Members
- AutoPause
-
- Type: boolean
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).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.
- MaxCapacity
-
- Type: int
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.
- MinCapacity
-
- Type: int
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.
- SecondsBeforeTimeout
-
- Type: int
The amount of time, in seconds, that Aurora Serverless v1 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.
- SecondsUntilAutoPause
-
- Type: int
The time, in seconds, before an Aurora DB cluster in
serverless
mode is paused.Specify a value between 300 and 86,400 seconds.
- TimeoutAction
-
- Type: 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.If you specify
ForceApplyCapacityChange
, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
ScalingConfigurationInfo
Description
The scaling configuration for an Aurora DB cluster in serverless
DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
Members
- AutoPause
-
- Type: boolean
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 v1 DB cluster, the DB cluster automatically resumes.
- MaxCapacity
-
- Type: int
The maximum capacity for an Aurora DB cluster in
serverless
DB engine mode. - MinCapacity
-
- Type: int
The minimum capacity for an Aurora DB cluster in
serverless
DB engine mode. - SecondsBeforeTimeout
-
- Type: int
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the
TimeoutAction
setting. - SecondsUntilAutoPause
-
- Type: int
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
-
- Type: string
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 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.
ServerlessV2FeaturesSupport
Description
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
Members
- MaxCapacity
-
- Type: double
Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be
256
or128
. - MinCapacity
-
- Type: double
If the minimum capacity is 0 ACUs, the engine version supports the automatic pause/resume feature of Aurora Serverless v2.
ServerlessV2ScalingConfiguration
Description
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
Members
- MaxCapacity
-
- Type: double
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions.
- MinCapacity
-
- Type: double
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
- SecondsUntilAutoPause
-
- Type: int
Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it.
Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
ServerlessV2ScalingConfigurationInfo
Description
The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
Members
- MaxCapacity
-
- Type: double
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions.
- MinCapacity
-
- Type: double
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
- SecondsUntilAutoPause
-
- Type: int
The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again.
This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
SharedSnapshotQuotaExceededFault
Description
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
Members
SnapshotQuotaExceededFault
Description
The request would result in the user exceeding the allowed number of DB snapshots.
Members
SourceClusterNotSupportedFault
Description
The source DB cluster isn't supported for a blue/green deployment.
Members
SourceDatabaseNotSupportedFault
Description
The source DB instance isn't supported for a blue/green deployment.
Members
SourceNotFoundFault
Description
The requested source could not be found.
Members
SourceRegionMessage
Description
Contains the result of a successful invocation of the DescribeSourceRegions
action.
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
. - SourceRegions
-
- Type: Array of strings
A list of
SourceRegion
instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
StartActivityStreamResponse
Members
- ApplyImmediately
-
- Type: boolean
Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
- EngineNativeAuditFieldsIncluded
-
- Type: boolean
Indicates whether engine-native audit fields are included in the database activity stream.
- KinesisStreamName
-
- Type: string
The name of the Amazon Kinesis data stream to be used for the database activity stream.
- KmsKeyId
-
- Type: string
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
- Mode
-
- Type: string
The mode of the database activity stream.
- Status
-
- Type: string
The status of the database activity stream.
StartDBClusterResult
Members
- DBCluster
-
- Type: 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.
StartDBInstanceAutomatedBackupsReplicationResult
Members
- DBInstanceAutomatedBackup
-
- Type: DBInstanceAutomatedBackup structure
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
StartDBInstanceResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
StopActivityStreamResponse
Members
- KinesisStreamName
-
- Type: string
The name of the Amazon Kinesis data stream used for the database activity stream.
- KmsKeyId
-
- Type: 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.
- Status
-
- Type: string
The status of the database activity stream.
StopDBClusterResult
Members
- DBCluster
-
- Type: 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.
StopDBInstanceAutomatedBackupsReplicationResult
Members
- DBInstanceAutomatedBackup
-
- Type: DBInstanceAutomatedBackup structure
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
StopDBInstanceResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
StorageQuotaExceededFault
Description
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
Members
StorageTypeNotAvailableFault
Description
The aurora-iopt1
storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago.
Members
StorageTypeNotSupportedFault
Description
The specified StorageType
can't be associated with the DB instance.
Members
Subnet
Description
This data type is used as a response element for the DescribeDBSubnetGroups
operation.
Members
- SubnetAvailabilityZone
-
- Type: AvailabilityZone structure
Contains Availability Zone information.
This data type is used as an element in the
OrderableDBInstanceOption
data type. - SubnetIdentifier
-
- Type: string
The identifier of the subnet.
- SubnetOutpost
-
- Type: Outpost structure
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- SubnetStatus
-
- Type: string
The status of the subnet.
SubnetAlreadyInUse
Description
The DB subnet is already in use in the Availability Zone.
Members
SubscriptionAlreadyExistFault
Description
The supplied subscription name already exists.
Members
SubscriptionCategoryNotFoundFault
Description
The supplied category does not exist.
Members
SubscriptionNotFoundFault
Description
The subscription name does not exist.
Members
SwitchoverBlueGreenDeploymentResponse
Members
- BlueGreenDeployment
-
- Type: BlueGreenDeployment structure
Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
SwitchoverDetail
Description
Contains the details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Members
- SourceMember
-
- Type: string
The Amazon Resource Name (ARN) of a resource in the blue environment.
- Status
-
- Type: string
The switchover status of a resource in a blue/green deployment.
Values:
-
PROVISIONING
- The resource is being prepared to switch over. -
AVAILABLE
- The resource is ready to switch over. -
SWITCHOVER_IN_PROGRESS
- The resource is being switched over. -
SWITCHOVER_COMPLETED
- The resource has been switched over. -
SWITCHOVER_FAILED
- The resource attempted to switch over but failed. -
MISSING_SOURCE
- The source resource has been deleted. -
MISSING_TARGET
- The target resource has been deleted.
- TargetMember
-
- Type: string
The Amazon Resource Name (ARN) of a resource in the green environment.
SwitchoverGlobalClusterResult
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
SwitchoverReadReplicaResult
Members
- DBInstance
-
- Type: DBInstance structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.
Tag
Description
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Members
- Key
-
- Type: 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
-
- Type: 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}_.:/=+\\-@]*)$").
TagListMessage
Description
Members
- TagList
-
- Type: Array of Tag structures
List of tags returned by the
ListTagsForResource
operation.
TargetHealth
Description
Information about the connection health of an RDS Proxy target.
Members
- Description
-
- Type: string
A description of the health of the RDS Proxy target. If the
State
isAVAILABLE
, a description is not included. - Reason
-
- Type: string
The reason for the current health
State
of the RDS Proxy target. - State
-
- Type: string
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering
>unavailable
>available
>unavailable
>available
TenantDatabase
Description
A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases
action.
Members
- CharacterSetName
-
- Type: string
The character set of the tenant database.
- DBInstanceIdentifier
-
- Type: string
The ID of the DB instance that contains the tenant database.
- DbiResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the DB instance.
- DeletionProtection
-
- Type: boolean
Specifies whether deletion protection is enabled for the DB instance.
- MasterUsername
-
- Type: string
The master username of the tenant database.
- NcharCharacterSetName
-
- Type: string
The
NCHAR
character set name of the tenant database. - PendingModifiedValues
-
- Type: TenantDatabasePendingModifiedValues structure
Information about pending changes for a tenant database.
- Status
-
- Type: string
The status of the tenant database.
- TagList
-
- Type: Array of Tag structures
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- TenantDBName
-
- Type: string
The database name of the tenant database.
- TenantDatabaseARN
-
- Type: string
The Amazon Resource Name (ARN) for the tenant database.
- TenantDatabaseCreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the tenant database.
- TenantDatabaseResourceId
-
- Type: string
The Amazon Web Services Region-unique, immutable identifier for the tenant database.
TenantDatabaseAlreadyExistsFault
Description
You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
Members
TenantDatabaseNotFoundFault
Description
The specified tenant database wasn't found in the DB instance.
Members
TenantDatabasePendingModifiedValues
Description
A response element in the ModifyTenantDatabase
operation that describes changes that will be applied. Specific changes are identified by subelements.
Members
- MasterUserPassword
-
- Type: string
The master password for the tenant database.
- TenantDBName
-
- Type: string
The name of the tenant database.
TenantDatabaseQuotaExceededFault
Description
You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
Members
TenantDatabasesMessage
Members
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeTenantDatabases
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
. - TenantDatabases
-
- Type: Array of TenantDatabase structures
An array of the tenant databases requested by the
DescribeTenantDatabases
operation.
Timezone
Description
A time zone associated with a DBInstance
or a DBSnapshot
. This data type is an element in the response to the DescribeDBInstances
, the DescribeDBSnapshots
, and the DescribeDBEngineVersions
actions.
Members
- TimezoneName
-
- Type: string
The name of the time zone.
UnsupportedDBEngineVersionFault
Description
The specified DB engine version isn't supported for Aurora Limitless Database.
Members
UpgradeTarget
Description
The version of the database engine that a DB instance can be upgraded to.
Members
- AutoUpgrade
-
- Type: boolean
Indicates whether the target version is applied to any source DB instances that have
AutoMinorVersionUpgrade
set to true.This parameter is dynamic, and is set by RDS.
- Description
-
- Type: string
The version of the database engine that a DB instance can be upgraded to.
- Engine
-
- Type: string
The name of the upgrade target database engine.
- EngineVersion
-
- Type: string
The version number of the upgrade target database engine.
- IsMajorVersionUpgrade
-
- Type: boolean
Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
- SupportedEngineModes
-
- Type: Array of strings
A list of the supported DB engine modes for the target engine version.
- SupportsBabelfish
-
- Type: boolean
Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
- SupportsGlobalDatabases
-
- Type: boolean
Indicates whether you can use Aurora global databases with the target engine version.
- SupportsIntegrations
-
- Type: boolean
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
- SupportsLimitlessDatabase
-
- Type: boolean
Indicates whether the DB engine version supports Aurora Limitless Database.
- SupportsLocalWriteForwarding
-
- Type: boolean
Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
- SupportsParallelQuery
-
- Type: boolean
Indicates whether you can use Aurora parallel query with the target engine version.
UserAuthConfig
Description
Specifies the details of authentication used by a proxy to log in as a specific database user.
Members
- AuthScheme
-
- Type: string
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- ClientPasswordAuthType
-
- Type: string
The type of authentication the proxy uses for connections from clients.
- Description
-
- Type: string
A user-specified description about the authentication used by a proxy to log in as a specific database user.
- IAMAuth
-
- Type: string
A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The
ENABLED
value is valid only for proxies with RDS for Microsoft SQL Server. - SecretArn
-
- Type: string
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
- UserName
-
- Type: string
The name of the database user to which the proxy connects.
UserAuthConfigInfo
Description
Returns the details of authentication used by a proxy to log in as a specific database user.
Members
- AuthScheme
-
- Type: string
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- ClientPasswordAuthType
-
- Type: string
The type of authentication the proxy uses for connections from clients.
- Description
-
- Type: string
A user-specified description about the authentication used by a proxy to log in as a specific database user.
- IAMAuth
-
- Type: string
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The
ENABLED
value is valid only for proxies with RDS for Microsoft SQL Server. - SecretArn
-
- Type: string
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
- UserName
-
- Type: string
The name of the database user to which the proxy connects.
ValidDBInstanceModificationsMessage
Description
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications
action. You can use this information when you call ModifyDBInstance
.
Members
- Storage
-
- Type: Array of ValidStorageOptions structures
Valid storage options for your DB instance.
- SupportsDedicatedLogVolume
-
- Type: boolean
Indicates whether a DB instance supports using a dedicated log volume (DLV).
- ValidProcessorFeatures
-
- Type: Array of AvailableProcessorFeature structures
Valid processor features for your DB instance.
ValidStorageOptions
Description
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications
action.
Members
- IopsToStorageRatio
-
- Type: Array of DoubleRange structures
The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
- ProvisionedIops
-
- Type: Array of Range structures
The valid range of provisioned IOPS. For example, 1000-256,000.
- ProvisionedStorageThroughput
-
- Type: Array of Range structures
The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).
- StorageSize
-
- Type: Array of Range structures
The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.
- StorageThroughputToIopsRatio
-
- Type: Array of DoubleRange structures
The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.
- StorageType
-
- Type: string
The valid storage types for your DB instance. For example: gp2, gp3, io1, io2.
- SupportsStorageAutoscaling
-
- Type: boolean
Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
VpcSecurityGroupMembership
Description
This data type is used as a response element for queries on VPC security group membership.
Members
- Status
-
- Type: string
The membership status of the VPC security group.
Currently, the only valid status is
active
. - VpcSecurityGroupId
-
- Type: string
The name of the VPC security group.