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.
- 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.
- 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.
- CreateOptionGroup ( array $params = [] )
Creates a new option group.
- 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.
- 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 = [] )
The DeleteDBInstance action 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.
- 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.
- DeleteOptionGroup ( array $params = [] )
Deletes an existing option group.
- 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 = [] )
Returns information about blue/green deployments.
- DescribeCertificates ( array $params = [] )
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
- 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 = [] )
Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters.
- DescribeDBEngineVersions ( array $params = [] )
Returns a list of the available DB engines.
- DescribeDBInstanceAutomatedBackups ( array $params = [] )
Displays backups for both current and deleted instances.
- DescribeDBInstances ( array $params = [] )
Returns information about 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.
- DescribeDBSecurityGroups ( array $params = [] )
Returns a list of DBSecurityGroup descriptions.
- DescribeDBSnapshotAttributes ( array $params = [] )
Returns a list of DB snapshot attribute names and values for a manual 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.
- DescribeOptionGroupOptions ( array $params = [] )
Describes all available options.
- DescribeOptionGroups ( array $params = [] )
Describes the available option groups.
- DescribeOrderableDBInstanceOptions ( array $params = [] )
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
- 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.
- DescribeValidDBInstanceModifications ( array $params = [] )
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.
- DownloadDBLogFilePortion ( array $params = [] )
Downloads all or a portion of the specified log file, up to 1 MB in size.
- FailoverDBCluster ( array $params = [] )
Forces a failover for a DB cluster.
- FailoverGlobalCluster ( array $params = [] )
Initiates the failover process for an Aurora global database (GlobalCluster).
- 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 = [] )
Modify the settings for 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.
- 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 = [] )
Modify a setting for an Amazon Aurora global cluster.
- ModifyOptionGroup ( array $params = [] )
Modifies an existing option group.
- 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.
- 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 action.
- 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 action.
- 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 action.
- 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.
- 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
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusterParameterGroups
- DescribeDBClusterParameters
- DescribeDBClusterSnapshots
- DescribeDBClusters
- DescribeDBEngineVersions
- DescribeDBInstanceAutomatedBackups
- DescribeDBInstances
- DescribeDBLogFiles
- DescribeDBParameterGroups
- DescribeDBParameters
- DescribeDBProxies
- DescribeDBProxyEndpoints
- DescribeDBProxyTargetGroups
- DescribeDBProxyTargets
- DescribeDBSecurityGroups
- DescribeDBSnapshots
- DescribeDBSubnetGroups
- DescribeEngineDefaultParameters
- DescribeEventSubscriptions
- DescribeEvents
- DescribeExportTasks
- DescribeGlobalClusters
- DescribeOptionGroupOptions
- DescribeOptionGroups
- DescribeOrderableDBInstanceOptions
- DescribePendingMaintenanceActions
- DescribeReservedDBInstances
- DescribeReservedDBInstancesOfferings
- DescribeSourceRegions
- 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 |
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
-
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
DBClusterRoleAlreadyExistsFault:
The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
-
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.
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
-
DBInstanceIdentifierdoesn't refer to an existing DB instance. -
DBInstanceRoleAlreadyExistsFault:
The specified
RoleArnorFeatureNamevalue is already associated with the DB instance. -
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.
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
DBInstanceIdentifiervalue must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifiervalue must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupNamevalue must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupNamevalue must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifiervalue must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifiervalue must be supplied. -
If the source type is an RDS Proxy, a
DBProxyNamevalue 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
DescribeEventSubscriptionsaction.
Errors
-
The subscription name does not exist.
-
The requested source could not be found.
Examples
Example 1: To add a source identifier to an event notification subscription
This example add a source identifier to an event notification subscription.
$result = $client->addSourceIdentifierToSubscription([
'SourceIdentifier' => 'mymysqlinstance',
'SubscriptionName' => 'mymysqleventsubscription',
]);
Result syntax:
[
'EventSubscription' => [
],
]
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 Amazon RDS resources, see Tagging 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
-
DBInstanceIdentifierdoesn't refer to an existing DB instance. -
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
DBSnapshotIdentifierdoesn't refer to an existing DB snapshot. -
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:
BlueGreenDeploymentIdentifierdoesn't refer to an existing blue/green deployment.
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:
system-update,db-upgrade,hardware-maintenance,ca-certificate-rotation - 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
immediatecan'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-maintenanceopt-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
-
The specified resource ID was not found.
-
The requested operation can't be performed while the cluster is in this state.
-
The DB instance isn't in a valid state.
Examples
Example 1: To apply a pending maintenance action
This example immediately applies a pending system update to a DB instance.
$result = $client->applyPendingMaintenanceAction([
'ApplyAction' => 'system-update',
'OptInType' => 'immediate',
'ResourceIdentifier' => 'arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance',
]);
Result syntax:
[
'ResourcePendingMaintenanceActions' => [
],
]
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,
EC2SecurityGroupIdmust be provided. Otherwise,EC2SecurityGroupOwnerIdand eitherEC2SecurityGroupNameorEC2SecurityGroupIdmust be provided. - EC2SecurityGroupName
-
- Type: string
Name of the EC2 security group to authorize. For VPC DB security groups,
EC2SecurityGroupIdmust be provided. Otherwise,EC2SecurityGroupOwnerIdand eitherEC2SecurityGroupNameorEC2SecurityGroupIdmust be provided. - EC2SecurityGroupOwnerId
-
- Type: string
Amazon Web Services account number of the owner of the EC2 security group specified in the
EC2SecurityGroupNameparameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups,EC2SecurityGroupIdmust be provided. Otherwise,EC2SecurityGroupOwnerIdand eitherEC2SecurityGroupNameorEC2SecurityGroupIdmust 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
DescribeDBSecurityGroupsaction.
Errors
-
DBSecurityGroupNamedoesn'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
A value that indicates 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
A value that indicates 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
-
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
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
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 are the following:
-
database- Export all the data from a specified database. -
database.tabletable-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.schemaschema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.tabletable-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 that 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 that 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 that the snapshot or cluster export task ended.
- TaskStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that 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
-
The export task doesn't exist.
-
You can't cancel an export task that has completed.
CopyDBClusterParameterGroup
$result = $client->copyDBClusterParameterGroup([/* ... */]); $promise = $client->copyDBClusterParameterGroupAsync([/* ... */]);
Copies the specified DB cluster parameter group.
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.
- 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
DescribeDBClusterParameterGroupsaction.
Errors
-
DBParameterGroupNotFoundFault:
DBParameterGroupNamedoesn'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' => [
],
]
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 theSourceDBClusterSnapshotIdentifierin 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
A value that indicates 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
KmsKeyIdto 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
KmsKeyIdto 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
KmsKeyIdparameter, 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.
- 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>',
'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,
'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
DescribeDBClusterSnapshotsaction.
Errors
-
DBClusterSnapshotAlreadyExistsFault:
The user already has a DB cluster snapshot with the given identifier.
-
DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifierdoesn't refer to an existing DB cluster snapshot. -
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.
-
The request would result in the user exceeding the allowed number of DB snapshots.
-
An error occurred accessing an Amazon Web Services KMS key.
Examples
Example 1: To copy a DB cluster snapshot
The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.
$result = $client->copyDBClusterSnapshot([
'SourceDBClusterSnapshotIdentifier' => 'rds:sample-cluster-2016-09-14-10-38',
'TargetDBClusterSnapshotIdentifier' => 'cluster-snapshot-copy-1',
]);
Result syntax:
[
'DBClusterSnapshot' => [
],
]
CopyDBParameterGroup
$result = $client->copyDBParameterGroup([/* ... */]); $promise = $client->copyDBParameterGroupAsync([/* ... */]);
Copies the specified DB parameter group.
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.
- 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
DescribeDBParameterGroupsaction.
Errors
-
DBParameterGroupNotFoundFault:
DBParameterGroupNamedoesn'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
This example copies a DB parameter group.
$result = $client->copyDBParameterGroup([
'SourceDBParameterGroupIdentifier' => 'mymysqlparametergroup',
'TargetDBParameterGroupDescription' => 'My MySQL parameter group copy',
'TargetDBParameterGroupIdentifier' => 'mymysqlparametergroup-copy',
]);
Result syntax:
[
'DBParameterGroup' => [
],
]
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
A value that indicates 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
A value that indicates 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-01Example:
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.
- 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>',
'DbiResourceId' => '<string>',
'Encrypted' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LicenseModel' => '<string>',
'MasterUsername' => '<string>',
'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
DescribeDBSnapshotsaction.
Errors
-
DBSnapshotIdentifieris already used by an existing snapshot. -
DBSnapshotIdentifierdoesn't refer to an existing DB snapshot. -
The state of the DB snapshot doesn't allow deletion.
-
The request would result in the user exceeding the allowed number of DB snapshots.
-
An error occurred accessing an Amazon Web Services KMS key.
-
CustomAvailabilityZoneNotFoundFault:
CustomAvailabilityZoneIddoesn't refer to an existing custom Availability Zone identifier.
Examples
Example 1: To copy a DB snapshot
This example copies a DB snapshot.
$result = $client->copyDBSnapshot([
'SourceDBSnapshotIdentifier' => 'mydbsnapshot',
'TargetDBSnapshotIdentifier' => 'mydbsnapshot-copy',
]);
Result syntax:
[
'DBSnapshot' => [
],
]
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.
- 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.
-
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
This example copies an option group.
$result = $client->copyOptionGroup([
'SourceOptionGroupIdentifier' => 'mymysqloptiongroup',
'TargetOptionGroupDescription' => 'My MySQL option group copy',
'TargetOptionGroupIdentifier' => 'mymysqloptiongroup-copy',
]);
Result syntax:
[
'OptionGroup' => [
],
]
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. The staging environment stays in sync with the current production environment using logical replication.
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>',
],
// ...
],
'TargetDBClusterParameterGroupName' => '<string>',
'TargetDBParameterGroupName' => '<string>',
'TargetEngineVersion' => '<string>',
]);
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.
- 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.
- 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.
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
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.
Errors
-
DBInstanceIdentifierdoesn't refer to an existing DB instance. -
DBClusterIdentifierdoesn'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:
DBParameterGroupNamedoesn't refer to an existing DB parameter group. -
DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupNamedoesn't refer to an existing DB cluster parameter group. -
The request would result in the user exceeding the allowed number of DB instances.
-
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
-
The DB instance isn't in a valid state.
-
The requested operation can't be performed while the cluster is in this state.
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>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
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 to use for your custom engine version (CEV). The only supported value is
custom-oracle-ee. - 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 ofEngineandEngineVersionis unique per customer per Region. - ImageId
-
- Type: string
The ID of the AMI. An AMI ID is required to create a CEV for RDS Custom for SQL Server.
- 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.
- Tags
-
- Type: Array of Tag structures
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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>',
'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,
'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,
'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
CharacterSetNameparameter 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.
- Status
-
- Type: string
The status of the DB engine version, either
availableordeprecated. - 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
CharacterSetNameparameter of theCreateDBInstanceoperation. - 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.3The supported features are listed under
SupportedFeatureNamesin the output. - SupportedNcharCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetNameparameter of theCreateDBInstanceoperation. - SupportedTimezones
-
- Type: Array of Timezone structures
A list of the time zones supported by this engine for the
Timezoneparameter of theCreateDBInstanceaction. - SupportsBabelfish
-
- Type: boolean
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- SupportsCertificateRotationWithoutRestart
-
- Type: boolean
A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
- SupportsGlobalDatabases
-
- Type: boolean
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
- SupportsLogExportsToCloudwatchLogs
-
- Type: boolean
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
- SupportsParallelQuery
-
- Type: boolean
A value that 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.
- 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.
-
An error occurred accessing an Amazon Web Services KMS key.
CreateDBCluster
$result = $client->createDBCluster([/* ... */]); $promise = $client->createDBClusterAsync([/* ... */]);
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS 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 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>,
'CharacterSetName' => '<string>',
'CopyTagsToSnapshot' => true || false,
'DBClusterIdentifier' => '<string>', // REQUIRED
'DBClusterInstanceClass' => '<string>',
'DBClusterParameterGroupName' => '<string>',
'DBSubnetGroupName' => '<string>',
'DBSystemId' => '<string>',
'DatabaseName' => '<string>',
'DeletionProtection' => true || false,
'DestinationRegion' => '<string>',
'Domain' => '<string>',
'DomainIAMRoleName' => '<string>',
'EnableCloudwatchLogsExports' => ['<string>', ...],
'EnableGlobalWriteForwarding' => true || false,
'EnableHttpEndpoint' => true || false,
'EnableIAMDatabaseAuthentication' => true || false,
'EnablePerformanceInsights' => true || false,
'Engine' => '<string>', // REQUIRED
'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,
'ReplicationSourceIdentifier' => '<string>',
'ScalingConfiguration' => [
'AutoPause' => true || false,
'MaxCapacity' => <integer>,
'MinCapacity' => <integer>,
'SecondsBeforeTimeout' => <integer>,
'SecondsUntilAutoPause' => <integer>,
'TimeoutAction' => '<string>',
],
'ServerlessV2ScalingConfiguration' => [
'MaxCapacity' => <float>,
'MinCapacity' => <float>,
],
'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.
This setting is required to create a Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
- AutoMinorVersionUpgrade
-
- Type: boolean
A value that indicates 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: Multi-AZ DB clusters only
- AvailabilityZones
-
- Type: Array of strings
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
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.
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
- BackupRetentionPeriod
-
- Type: int
The number of days for which automated backups are retained.
Default: 1
Constraints:
-
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- CharacterSetName
-
- Type: string
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
- CopyTagsToSnapshot
-
- Type: boolean
A value that indicates whether to copy all tags from the DB cluster to snapshots of the 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 DB cluster 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:
my-cluster1Valid for: Aurora DB clusters and Multi-AZ DB clusters
- 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: Multi-AZ DB clusters only
- DBClusterParameterGroupName
-
- Type: string
The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
-
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- DBSubnetGroupName
-
- Type: string
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example:
mydbsubnetgroupValid for: Aurora DB clusters and Multi-AZ DB clusters
- DBSystemId
-
- Type: string
Reserved for future use.
- DatabaseName
-
- Type: string
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- DeletionProtection
-
- Type: boolean
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- 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: Aurora DB clusters only
- DomainIAMRoleName
-
- Type: string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of log types that need to be enabled for exporting 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
postgresqlandupgrade.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
- EnableGlobalWriteForwarding
-
- Type: boolean
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
- EnableHttpEndpoint
-
- Type: boolean
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service 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 query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
- EnableIAMDatabaseAuthentication
-
- Type: boolean
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
- EnablePerformanceInsights
-
- Type: boolean
A value that indicates 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: Multi-AZ DB clusters only
- Engine
-
- Required: Yes
- Type: string
The name of the database engine to be used for this DB cluster.
Valid Values:
-
aurora(for MySQL 5.6-compatible Aurora) -
aurora-mysql(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql -
mysql -
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- EngineMode
-
- Type: string
The DB engine mode of the DB cluster, either
provisioned,serverless,parallelquery,global, ormultimaster.The
parallelqueryengine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.The
globalengine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, andglobalengine mode isn't required for any 2.x versions.The
multimasterengine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.The
serverlessengine mode only applies for Aurora Serverless v1 DB clusters.For Aurora PostgreSQL, the
globalengine mode isn't required, and both theparallelqueryand themultimasterengine modes currently aren't supported.Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
Valid for: 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 MySQL 5.6-compatible Aurora, use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, 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
For information, see MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.
Aurora PostgreSQL
For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: 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: 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.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
- 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
ReplicationSourceIdentifieridentifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key. -
If the
StorageEncryptedparameter is enabled andReplicationSourceIdentifierisn't specified, 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.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set
KmsKeyIdto 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: Aurora DB clusters and Multi-AZ DB clusters
- ManageMasterUserPassword
-
- Type: boolean
A value that indicates 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
MasterUserPasswordis specified.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- 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
ManageMasterUserPasswordis turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- 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/secretsmanagerKMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanagerKMS 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: Aurora DB clusters and Multi-AZ DB clusters
- MasterUsername
-
- Type: string
The name of the master user for the 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.
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. The default is 0.
If
MonitoringRoleArnis specified, also setMonitoringIntervalto a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60Valid for: Multi-AZ DB clusters only
- 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
MonitoringIntervalis set to a value other than 0, supply aMonitoringRoleArnvalue.Valid for: Multi-AZ DB clusters only
- NetworkType
-
- Type: string
The network type of the DB cluster.
Valid values:
-
IPV4 -
DUAL
The network type is determined by the
DBSubnetGroupspecified for the DB cluster. ADBSubnetGroupcan 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
A value that indicates that the DB cluster should be associated with the specified option group.
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: Multi-AZ DB clusters only
- 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.
Valid for: Multi-AZ DB clusters only
- Port
-
- Type: int
The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default:
3306Valid values:
1150-65535RDS for PostgreSQL and Aurora PostgreSQL
Default:
5432Valid values:
1150-65535Valid for: Aurora DB clusters and Multi-AZ DB clusters
- 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
BackupRetentionPeriodparameter.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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- PreferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- PubliclyAccessible
-
- Type: boolean
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access 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.
Default: The default behavior varies depending on whether
DBSubnetGroupNameis specified.If
DBSubnetGroupNameisn't specified, andPubliclyAccessibleisn'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
DBSubnetGroupNameis specified, andPubliclyAccessibleisn'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
- 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: Aurora DB clusters and RDS for PostgreSQL Multi-AZ DB clusters
- ScalingConfiguration
-
- Type: ScalingConfiguration structure
For DB clusters in
serverlessDB 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.
- SourceRegion
-
- Type: string
A required parameter that indicates the region that the DB snapshot will be copied from. - StorageEncrypted
-
- Type: boolean
A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- StorageType
-
- Type: string
Specifies the storage type to be associated with the DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid values:
io1When specified, a value for the
Iopsparameter is required.Default:
io1Valid for: Multi-AZ DB clusters only
- Tags
-
- Type: Array of Tag structures
Tags to assign to the DB cluster.
Valid for: 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: 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>', ...],
'BacktrackConsumedChangeRecords' => <integer>,
'BacktrackWindow' => <integer>,
'BackupRetentionPeriod' => <integer>,
'Capacity' => <integer>,
'CharacterSetName' => '<string>',
'CloneGroupId' => '<string>',
'ClusterCreateTime' => <DateTime>,
'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>',
'DatabaseName' => '<string>',
'DbClusterResourceId' => '<string>',
'DeletionProtection' => true || false,
'DomainMemberships' => [
[
'Domain' => '<string>',
'FQDN' => '<string>',
'IAMRoleName' => '<string>',
'Status' => '<string>',
],
// ...
],
'EarliestBacktrackTime' => <DateTime>,
'EarliestRestorableTime' => <DateTime>,
'EnabledCloudwatchLogsExports' => ['<string>', ...],
'Endpoint' => '<string>',
'Engine' => '<string>',
'EngineMode' => '<string>',
'EngineVersion' => '<string>',
'GlobalWriteForwardingRequested' => true || false,
'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown',
'HostedZoneId' => '<string>',
'HttpEndpointEnabled' => true || false,
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LatestRestorableTime' => <DateTime>,
'MasterUserSecret' => [
'KmsKeyId' => '<string>',
'SecretArn' => '<string>',
'SecretStatus' => '<string>',
],
'MasterUsername' => '<string>',
'MonitoringInterval' => <integer>,
'MonitoringRoleArn' => '<string>',
'MultiAZ' => true || false,
'NetworkType' => '<string>',
'PendingModifiedValues' => [
'AllocatedStorage' => <integer>,
'BackupRetentionPeriod' => <integer>,
'DBClusterIdentifier' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'MasterUserPassword' => '<string>',
'PendingCloudwatchLogsExports' => [
'LogTypesToDisable' => ['<string>', ...],
'LogTypesToEnable' => ['<string>', ...],
],
],
'PercentProgress' => '<string>',
'PerformanceInsightsEnabled' => true || false,
'PerformanceInsightsKMSKeyId' => '<string>',
'PerformanceInsightsRetentionPeriod' => <integer>,
'Port' => <integer>,
'PreferredBackupWindow' => '<string>',
'PreferredMaintenanceWindow' => '<string>',
'PubliclyAccessible' => true || false,
'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>,
],
'Status' => '<string>',
'StorageEncrypted' => true || false,
'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
-
The user already has a DB cluster with the given identifier.
-
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.
-
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
-
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
-
DBSubnetGroupNamedoesn't refer to an existing DB subnet group. -
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
-
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.
-
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
The DB instance isn't in a valid state.
-
DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupNamedoesn't refer to an existing DB cluster parameter group. -
An error occurred accessing an Amazon Web Services KMS key.
-
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
DBInstanceIdentifierdoesn'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.
-
The
GlobalClusterIdentifierdoesn't refer to an existing global database cluster. -
InvalidGlobalClusterStateFault:
The global cluster is in an invalid state and can't perform the requested operation.
-
Domaindoesn't refer to an existing Active Directory domain.
Examples
Example 1: To create a DB cluster
This example creates a DB cluster.
$result = $client->createDBCluster([
'AvailabilityZones' => [
'us-east-1a',
],
'BackupRetentionPeriod' => 1,
'DBClusterIdentifier' => 'mydbcluster',
'DBClusterParameterGroupName' => 'mydbclusterparametergroup',
'DatabaseName' => 'myauroradb',
'Engine' => 'aurora',
'EngineVersion' => '5.6.10a',
'MasterUserPassword' => 'mypassword',
'MasterUsername' => 'myuser',
'Port' => 3306,
'StorageEncrypted' => 1,
]);
Result syntax:
[
'DBCluster' => [
],
]
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. Theinactivestate applies to an endpoint that can't be used for a certain kind of cluster, such as awriterendpoint 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.
-
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
The requested operation can't be performed while the cluster is in this state.
-
DBInstanceIdentifierdoesn't refer to an existing DB instance. -
The DB instance isn't in a valid state.
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:
aurora5.6,aurora-mysql5.7,aurora-mysql8.0Aurora PostgreSQL
Example:
aurora-postgresql9.6RDS for MySQL
Example:
mysql8.0RDS for PostgreSQL
Example:
postgres12To 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-postgresqlThe output contains duplicates.
The following are the valid DB engine values:
-
aurora(for MySQL 5.6-compatible Aurora) -
aurora-mysql(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
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
DescribeDBClusterParameterGroupsaction.
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
This example creates a DB cluster parameter group.
$result = $client->createDBClusterParameterGroup([
'DBClusterParameterGroupName' => 'mydbclusterparametergroup',
'DBParameterGroupFamily' => 'aurora5.6',
'Description' => 'My DB cluster parameter group',
]);
Result syntax:
[
'DBClusterParameterGroup' => [
],
]
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>',
'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,
'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
DescribeDBClusterSnapshotsaction.
Errors
-
DBClusterSnapshotAlreadyExistsFault:
The user already has a DB cluster snapshot with the given identifier.
-
The requested operation can't be performed while the cluster is in this state.
-
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
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
This example creates a DB cluster snapshot.
$result = $client->createDBClusterSnapshot([
'DBClusterIdentifier' => 'mydbcluster',
'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot',
]);
Result syntax:
[
'DBClusterSnapshot' => [
],
]
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>',
'DeletionProtection' => true || false,
'Domain' => '<string>',
'DomainIAMRoleName' => '<string>',
'EnableCloudwatchLogsExports' => ['<string>', ...],
'EnableCustomerOwnedIp' => true || false,
'EnableIAMDatabaseAuthentication' => true || false,
'EnablePerformanceInsights' => true || false,
'Engine' => '<string>', // REQUIRED
'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,
'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.
Type: Integer
Amazon Aurora
Not applicable. 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): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
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): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
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): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
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): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 5 to 3072.
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): Must be an integer from 100 to 65536.
-
Magnetic storage (standard): Must be an integer from 10 to 3072.
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):
-
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
A value that indicates 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
AutoMinorVersionUpgradetofalse. - 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.
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.
Example:
us-east-1dConstraint: The
AvailabilityZoneparameter 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. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. 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
Specifies where automated backups and manual snapshots are stored.
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
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
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, this value indicates that the DB instance should be associated with the specified
CharacterSet.This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster. - CopyTagsToSnapshot
-
- Type: boolean
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. 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. 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.
- DBClusterIdentifier
-
- Type: string
The identifier of the DB cluster that the instance will belong to.
This setting doesn't apply to RDS Custom.
- 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 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 meaning of this parameter differs according to the database engine you use.
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
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
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named
postgresis created in the DB instance.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
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify
null, the default valueORCLis used. You can't specify the string NULL, or any other reserved word, forDBName.Default:
ORCLConstraints:
-
Can't be longer than 8 characters
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.Default:
ORCLConstraints:
-
It must contain 1 to 8 alphanumeric characters.
-
It must contain a letter.
-
It can't be a word reserved by the database engine.
Amazon RDS Custom for SQL Server
Not applicable. Must be null.
SQL Server
Not applicable. Must be null.
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:
-
It must contain 1 to 64 alphanumeric characters.
-
It 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. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named
postgresis created in the DB cluster.Constraints:
-
It must contain 1 to 63 alphanumeric characters.
-
It must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
-
It can't be a word reserved by the database engine.
- DBParameterGroupName
-
- Type: string
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
This setting doesn't apply to RDS Custom.
Constraints:
-
It must be 1 to 255 letters, numbers, or hyphens.
-
The first character must be a letter.
-
It 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
VpcSecurityGroupIdssetting instead. - DBSubnetGroupName
-
- Type: string
A DB subnet group to associate with this DB instance.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example:
mydbsubnetgroup - DeletionProtection
-
- Type: boolean
A value that indicates 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.
Amazon Aurora
Not applicable. 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, 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.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
- DomainIAMRoleName
-
- Type: string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
- EnableCloudwatchLogsExports
-
- Type: Array of strings
The list of log types that need to be enabled for exporting 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.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
RDS Custom
Not applicable.
MariaDB
Possible values are
audit,error,general, andslowquery.Microsoft SQL Server
Possible values are
agentanderror.MySQL
Possible values are
audit,error,general, andslowquery.Oracle
Possible values are
alert,audit,listener,trace, andoemagent.PostgreSQL
Possible values are
postgresqlandupgrade. - EnableCustomerOwnedIp
-
- Type: boolean
A value that indicates 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
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
- EnablePerformanceInsights
-
- Type: boolean
A value that indicates 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.
- Engine
-
- Required: Yes
- Type: string
The name of the database engine to be used for this instance.
Not every database engine is available for every Amazon Web Services Region.
Valid Values:
-
aurora(for MySQL 5.6-compatible Aurora) -
aurora-mysql(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql -
custom-oracle-ee (for RDS Custom for Oracle instances) -
custom-sqlserver-ee (for RDS Custom for SQL Server instances) -
custom-sqlserver-se (for RDS Custom for SQL Server instances) -
custom-sqlserver-web (for RDS Custom for SQL Server instances) -
mariadb -
mysql -
oracle-ee -
oracle-ee-cdb -
oracle-se2 -
oracle-se2-cdb -
postgres -
sqlserver-ee -
sqlserver-se -
sqlserver-ex -
sqlserver-web
- EngineVersion
-
- Type: string
The version number of the database engine to use.
For a list of valid engine versions, use the
DescribeDBEngineVersionsoperation.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 Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
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.
MariaDB
For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide.
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 be initially allocated for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
- 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.
Amazon Aurora
Not applicable. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster.If
StorageEncryptedis enabled, and you do not specify a value for theKmsKeyIdparameter, 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.Amazon RDS Custom
A KMS key is required for RDS Custom 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
License model information for this DB instance.
Valid values:
license-included|bring-your-own-license|general-public-licenseThis setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
- ManageMasterUserPassword
-
- Type: boolean
A value that indicates 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
MasterUserPasswordis specified.
- MasterUserPassword
-
- Type: string
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
Constraints: Can't be specified if
ManageMasterUserPasswordis turned on.MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: 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/secretsmanagerKMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanagerKMS 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.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
Amazon RDS
Constraints:
-
Required.
-
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 RDS Custom.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
- 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. The default is 0.
If
MonitoringRoleArnis specified, then you must setMonitoringIntervalto a value other than 0.This setting doesn't apply to RDS Custom.
Valid Values:
0, 1, 5, 10, 15, 30, 60 - 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
MonitoringIntervalis set to a value other than 0, then you must supply aMonitoringRoleArnvalue.This setting doesn't apply to RDS Custom.
- MultiAZ
-
- Type: boolean
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZoneparameter if the DB instance is a Multi-AZ deployment.This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
- NcharCharacterSetName
-
- Type: string
The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn't apply to RDS Custom.
- NetworkType
-
- Type: string
The network type of the DB instance.
Valid values:
-
IPV4 -
DUAL
The network type is determined by the
DBSubnetGroupspecified for the DB instance. ADBSubnetGroupcan 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
A value that indicates that the DB instance should be associated with the specified option group.
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 RDS Custom.
Amazon Aurora
Not applicable.
- 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.
- 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.
This setting doesn't apply to RDS Custom.
- Port
-
- Type: int
The port number on which the database accepts connections.
MySQL
Default:
3306Valid values:
1150-65535Type: Integer
MariaDB
Default:
3306Valid values:
1150-65535Type: Integer
PostgreSQL
Default:
5432Valid values:
1150-65535Type: Integer
Oracle
Default:
1521Valid values:
1150-65535SQL Server
Default:
1433Valid values:
1150-65535except1234,1434,3260,3343,3389,47001, and49152-49156.Amazon Aurora
Default:
3306Valid values:
1150-65535Type: Integer
- PreferredBackupWindow
-
- Type: string
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriodparameter. 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.Amazon Aurora
Not applicable. 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, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
- 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.
Amazon Aurora
Not applicable.
- 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.
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
- PubliclyAccessible
-
- Type: boolean
A value that indicates 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.
Default: The default behavior varies depending on whether
DBSubnetGroupNameis specified.If
DBSubnetGroupNameisn't specified, andPubliclyAccessibleisn'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
DBSubnetGroupNameis specified, andPubliclyAccessibleisn'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
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
For RDS Custom instances, either set this parameter to
trueor leave it unset. If you set this parameter tofalse, RDS reports an error.Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
- StorageThroughput
-
- Type: int
Specifies the storage throughput value for the DB instance.
This setting applies only to the
gp3storage type.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 | standardIf you specify
io1orgp3, you must also include a value for theIopsparameter.Default:
io1if theIopsparameter is specified, otherwisegp2Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
- 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 RDS Custom.
Amazon Aurora
Not applicable.
- 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.
- Timezone
-
- Type: string
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- VpcSecurityGroupIds
-
- Type: Array of strings
A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. 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>',
'DbInstancePort' => <integer>,
'DbiResourceId' => '<string>',
'DeletionProtection' => true || false,
'DomainMemberships' => [
[
'Domain' => '<string>',
'FQDN' => '<string>',
'IAMRoleName' => '<string>',
'Status' => '<string>',
],
// ...
],
'EnabledCloudwatchLogsExports' => ['<string>', ...],
'Endpoint' => [
'Address' => '<string>',
'HostedZoneId' => '<string>',
'Port' => <integer>,
],
'Engine' => '<string>',
'EngineVersion' => '<string>',
'EnhancedMonitoringResourceArn' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'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,
'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>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'LicenseModel' => '<string>',
'MasterUserPassword' => '<string>',
'MultiAZ' => true || false,
'PendingCloudwatchLogsExports' => [
'LogTypesToDisable' => ['<string>', ...],
'LogTypesToEnable' => ['<string>', ...],
],
'Port' => <integer>,
'ProcessorFeatures' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResumeFullAutomationModeTime' => <DateTime>,
'StorageThroughput' => <integer>,
'StorageType' => '<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>', ...],
'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
-
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:
DBParameterGroupNamedoesn't refer to an existing DB parameter group. -
DBSecurityGroupNamedoesn't refer to an existing DB security group. -
The request would result in the user exceeding the allowed number of DB instances.
-
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
-
DBSubnetGroupNamedoesn'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.
-
The requested operation can't be performed while the cluster is in this state.
-
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
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.
-
The specified option group could not be found.
-
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
Storage of the
StorageTypespecified can't be associated with the DB instance. -
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.
-
An error occurred accessing an Amazon Web Services KMS key.
-
Domaindoesn't refer to an existing Active Directory domain. -
This error does not currently have a description.
-
The network type is invalid for the DB instance. Valid nework type values are
IPV4andDUAL. -
CertificateIdentifierdoesn't refer to an existing certificate.
Examples
Example 1: To create a DB instance.
This example creates a DB instance.
$result = $client->createDBInstance([
'AllocatedStorage' => 5,
'DBInstanceClass' => 'db.t2.micro',
'DBInstanceIdentifier' => 'mymysqlinstance',
'Engine' => 'MySQL',
'MasterUserPassword' => 'MyPassword',
'MasterUsername' => 'MyUser',
]);
Result syntax:
[
'DBInstance' => [
],
]
CreateDBInstanceReadReplica
$result = $client->createDBInstanceReadReplica([/* ... */]); $promise = $client->createDBInstanceReadReplicaAsync([/* ... */]);
Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.
Your source DB instance must have backup retention enabled.
Parameter Syntax
$result = $client->createDBInstanceReadReplica([
'AllocatedStorage' => <integer>,
'AutoMinorVersionUpgrade' => true || false,
'AvailabilityZone' => '<string>',
'CopyTagsToSnapshot' => true || false,
'CustomIamInstanceProfile' => '<string>',
'DBInstanceClass' => '<string>',
'DBInstanceIdentifier' => '<string>', // REQUIRED
'DBParameterGroupName' => '<string>',
'DBSubnetGroupName' => '<string>',
'DeletionProtection' => true || false,
'DestinationRegion' => '<string>',
'Domain' => '<string>',
'DomainIAMRoleName' => '<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',
'SourceDBInstanceIdentifier' => '<string>', // REQUIRED
'SourceRegion' => '<string>',
'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 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
A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
This setting doesn't apply to RDS Custom.
Default: Inherits 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 - CopyTagsToSnapshot
-
- Type: boolean
A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. 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 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 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 DB instance.
If you do not specify a value for
DBParameterGroupName, then Amazon RDS uses theDBParameterGroupof source DB instance for a same Region read replica, or the defaultDBParameterGroupfor the specified DB engine for a cross-Region read replica.Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported 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
Specifies 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:
-
Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.
-
If supplied, must match the name of an existing DBSubnetGroup.
-
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 - DeletionProtection
-
- Type: boolean
A value that indicates 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.
- 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.
- DomainIAMRoleName
-
- Type: string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
- 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.
- EnableCustomerOwnedIp
-
- Type: boolean
A value that indicates 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
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information 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.
- EnablePerformanceInsights
-
- Type: boolean
A value that indicates 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.
- Iops
-
- Type: int
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated 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, then do not 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.
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.
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 collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If
MonitoringRoleArnis specified, then you must also setMonitoringIntervalto a value other than 0.This setting doesn't apply to RDS Custom.
Valid Values:
0, 1, 5, 10, 15, 30, 60 - 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
MonitoringIntervalis set to a value other than 0, then you must supply aMonitoringRoleArnvalue.This setting doesn't apply to RDS Custom.
- MultiAZ
-
- Type: boolean
A value that indicates 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 database is a Multi-AZ DB instance.
This setting doesn't apply to RDS Custom.
- NetworkType
-
- Type: string
The network type of the DB instance.
Valid values:
-
IPV4 -
DUAL
The network type is determined by the
DBSubnetGroupspecified for read replica. ADBSubnetGroupcan 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 the DB instance is associated with. If omitted, the option group associated with the source instance is used.
For SQL Server, you must use the option group associated with the source instance.
This setting doesn't apply to RDS Custom.
- 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.
- 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.
This setting doesn't apply to RDS Custom.
- Port
-
- Type: int
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values:
1150-65535 - 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.
- PubliclyAccessible
-
- Type: boolean
A value that indicates 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. - SourceDBInstanceIdentifier
-
- Required: Yes
- 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 five read replicas.
Constraints:
-
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
-
Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.
-
For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
-
For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
-
Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-Region replication).
-
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.
- StorageType
-
- Type: string
Specifies the storage type to be associated with the read replica.
Valid values:
gp2 | gp3 | io1 | standardIf you specify
io1orgp3, you must also include a value for theIopsparameter.Default:
io1if theIopsparameter 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.
- UseDefaultProcessorFeatures
-
- Type: boolean
A value that indicates 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 Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn't apply to RDS Custom.
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>',
'DbInstancePort' => <integer>,
'DbiResourceId' => '<string>',
'DeletionProtection' => true || false,
'DomainMemberships' => [
[
'Domain' => '<string>',
'FQDN' => '<string>',
'IAMRoleName' => '<string>',
'Status' => '<string>',
],
// ...
],
'EnabledCloudwatchLogsExports' => ['<string>', ...],
'Endpoint' => [
'Address' => '<string>',
'HostedZoneId' => '<string>',
'Port' => <integer>,
],
'Engine' => '<string>',
'EngineVersion' => '<string>',
'EnhancedMonitoringResourceArn' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'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,
'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>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'LicenseModel' => '<string>',
'MasterUserPassword' => '<string>',
'MultiAZ' => true || false,
'PendingCloudwatchLogsExports' => [
'LogTypesToDisable' => ['<string>', ...],
'LogTypesToEnable' => ['<string>', ...],
],
'Port' => <integer>,
'ProcessorFeatures' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResumeFullAutomationModeTime' => <DateTime>,
'StorageThroughput' => <integer>,
'StorageType' => '<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>', ...],
'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
-
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:
DBParameterGroupNamedoesn't refer to an existing DB parameter group. -
DBSecurityGroupNamedoesn't refer to an existing DB security group. -
The request would result in the user exceeding the allowed number of DB instances.
-
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
-
DBInstanceIdentifierdoesn't refer to an existing DB instance. -
The DB instance isn't in a valid state.
-
DBSubnetGroupNamedoesn'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.
-
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
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.
-
The specified option group could not be found.
-
The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.
-
The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
-
Storage of the
StorageTypespecified can't be associated with the DB instance. -
An error occurred accessing an Amazon Web Services KMS key.
-
Domaindoesn't refer to an existing Active Directory domain. -
The network type is invalid for the DB instance. Valid nework type values are
IPV4andDUAL.
Examples
Example 1: To create a DB instance read replica.
This example creates a DB instance read replica.
$result = $client->createDBInstanceReadReplica([
'AvailabilityZone' => 'us-east-1a',
'CopyTagsToSnapshot' => 1,
'DBInstanceClass' => 'db.t2.micro',
'DBInstanceIdentifier' => 'mydbreadreplica',
'PubliclyAccessible' => 1,
'SourceDBInstanceIdentifier' => 'mymysqlinstance',
'StorageType' => 'gp2',
'Tags' => [
[
'Key' => 'mydbreadreplicakey',
'Value' => 'mydbreadreplicavalue',
],
],
]);
Result syntax:
[
'DBInstance' => [
],
]
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 mysqlThe output contains duplicates.
The following are the valid DB engine values:
-
aurora(for MySQL 5.6-compatible Aurora) -
aurora-mysql(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql -
mariadb -
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
DescribeDBParameterGroupsaction.
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.
This example creates a DB parameter group.
$result = $client->createDBParameterGroup([
'DBParameterGroupFamily' => 'mysql5.6',
'DBParameterGroupName' => 'mymysqlparametergroup',
'Description' => 'My MySQL parameter group',
]);
Result syntax:
[
'DBParameterGroup' => [
],
]
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|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
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
A Boolean parameter that 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|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
DBProxystructure corresponding to the new proxy.
Errors
-
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
-
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.
- TargetRole
-
- Type: string
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only 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
DBProxyEndpointobject 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
-
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
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.
-
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
DescribeDBSecurityGroupsaction.
Errors
-
DBSecurityGroupAlreadyExistsFault:
A DB security group with the name specified in
DBSecurityGroupNamealready 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' => [
],
]
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.
Result Syntax
[
'DBSnapshot' => [
'AllocatedStorage' => <integer>,
'AvailabilityZone' => '<string>',
'DBInstanceIdentifier' => '<string>',
'DBSnapshotArn' => '<string>',
'DBSnapshotIdentifier' => '<string>',
'DbiResourceId' => '<string>',
'Encrypted' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LicenseModel' => '<string>',
'MasterUsername' => '<string>',
'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
DescribeDBSnapshotsaction.
Errors
-
DBSnapshotIdentifieris already used by an existing snapshot. -
The DB instance isn't in a valid state.
-
DBInstanceIdentifierdoesn't refer to an existing DB instance. -
The request would result in the user exceeding the allowed number of DB snapshots.
Examples
Example 1: To create a DB snapshot.
This example creates a DB snapshot.
$result = $client->createDBSnapshot([
'DBInstanceIdentifier' => 'mymysqlinstance',
'DBSnapshotIdentifier' => 'mydbsnapshot',
]);
Result syntax:
[
'DBSnapshot' => [
],
]
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
DescribeDBSubnetGroupsaction.
Errors
-
DBSubnetGroupAlreadyExistsFault:
DBSubnetGroupNameis already used by an existing DB subnet group. -
DBSubnetGroupQuotaExceededFault:
The request would result in the user exceeding the allowed number of DB subnet groups.
-
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.
-
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.
This example creates a DB subnet group.
$result = $client->createDBSubnetGroup([
'DBSubnetGroupDescription' => 'My DB subnet group',
'DBSubnetGroupName' => 'mydbsubnetgroup',
'SubnetIds' => [
'subnet-1fab8a69',
'subnet-d43a468c',
],
]);
Result syntax:
[
'DBSubnetGroup' => [
],
]
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
A value that indicates 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 theDescribeEventCategoriesoperation. - SnsTopicArn
-
- Required: Yes
- 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.
- 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
SourceIdsare supplied,SourceTypemust also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifiervalue must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifiervalue must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupNamevalue must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupNamevalue must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifiervalue must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifiervalue must be supplied. -
If the source type is an RDS Proxy, a
DBProxyNamevalue 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 - 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.
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
DescribeEventSubscriptionsaction.
Errors
-
EventSubscriptionQuotaExceededFault:
You have reached the maximum number of event subscriptions.
-
SubscriptionAlreadyExistFault:
The supplied subscription name already exists.
-
SNS has responded that there is a problem with the SNS topic specified.
-
You do not have permission to publish to the SNS topic ARN.
-
The SNS topic ARN does not exist.
-
SubscriptionCategoryNotFoundFault:
The supplied category does not exist.
-
The requested source could not be found.
Examples
Example 1: To create an event notification subscription
This example creates an event notification subscription.
$result = $client->createEventSubscription([
'Enabled' => 1,
'EventCategories' => [
'availability',
],
'SnsTopicArn' => 'arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic',
'SourceIds' => [
'mymysqlinstance',
],
'SourceType' => 'db-instance',
'SubscriptionName' => 'mymysqleventsubscription',
]);
Result syntax:
[
'EventSubscription' => [
],
]
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 add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This action applies only to Aurora DB clusters.
Parameter Syntax
$result = $client->createGlobalCluster([
'DatabaseName' => '<string>',
'DeletionProtection' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'GlobalClusterIdentifier' => '<string>',
'SourceDBClusterIdentifier' => '<string>',
'StorageEncrypted' => true || false,
]);
Parameter Details
Members
- DatabaseName
-
- Type: string
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.
- DeletionProtection
-
- Type: boolean
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
- Engine
-
- Type: string
The name of the database engine to be used for this DB cluster.
- EngineVersion
-
- Type: string
The engine version of the Aurora global database.
- GlobalClusterIdentifier
-
- Type: string
The cluster identifier of the new global database cluster.
- SourceDBClusterIdentifier
-
- Type: string
The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.
- StorageEncrypted
-
- Type: boolean
The storage encryption setting for the new global database cluster.
Result Syntax
[
'GlobalCluster' => [
'DatabaseName' => '<string>',
'DeletionProtection' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'FailoverState' => [
'FromDbClusterArn' => '<string>',
'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>', ...],
],
// ...
],
'GlobalClusterResourceId' => '<string>',
'Status' => '<string>',
'StorageEncrypted' => true || false,
],
]
Result Details
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
Errors
-
GlobalClusterAlreadyExistsFault:
The
GlobalClusterIdentifieralready exists. Choose a new global database identifier (unique name) to create a new global database cluster. -
GlobalClusterQuotaExceededFault:
The number of global database clusters for this account is already at the maximum allowed.
-
The requested operation can't be performed while the cluster is in this state.
-
DBClusterIdentifierdoesn't refer to an existing DB cluster.
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
Specifies the name of the engine that this option group should be associated with.
Valid Values:
-
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 option group
This example creates an option group.
$result = $client->createOptionGroup([
'EngineName' => 'MySQL',
'MajorEngineVersion' => '5.6',
'OptionGroupDescription' => 'My MySQL 5.6 option group',
'OptionGroupName' => 'mymysqloptiongroup',
]);
Result syntax:
[
'OptionGroup' => [
],
]
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 blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.
Constraints:
-
Must match an existing blue/green deployment identifier.
- DeleteTarget
-
- Type: boolean
A value that indicates 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
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.
Errors
-
BlueGreenDeploymentNotFoundFault:
BlueGreenDeploymentIdentifierdoesn'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.
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. The only supported engine is
custom-oracle-ee. - 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
EngineandEngineVersionis 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>',
'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,
'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,
'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
CharacterSetNameparameter 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.
- Status
-
- Type: string
The status of the DB engine version, either
availableordeprecated. - 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
CharacterSetNameparameter of theCreateDBInstanceoperation. - 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.3The supported features are listed under
SupportedFeatureNamesin the output. - SupportedNcharCharacterSets
-
- Type: Array of CharacterSet structures
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetNameparameter of theCreateDBInstanceoperation. - SupportedTimezones
-
- Type: Array of Timezone structures
A list of the time zones supported by this engine for the
Timezoneparameter of theCreateDBInstanceaction. - SupportsBabelfish
-
- Type: boolean
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- SupportsCertificateRotationWithoutRestart
-
- Type: boolean
A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
- SupportsGlobalDatabases
-
- Type: boolean
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
- SupportsLogExportsToCloudwatchLogs
-
- Type: boolean
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
- SupportsParallelQuery
-
- Type: boolean
A value that 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.
- 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.
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
'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.
- FinalDBSnapshotIdentifier
-
- Type: string
The DB cluster snapshot identifier of the new DB cluster snapshot created when
SkipFinalSnapshotis disabled.Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the
SkipFinalShapshotparameter 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
A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
You must specify a
FinalDBSnapshotIdentifierparameter ifSkipFinalSnapshotis disabled.
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>', ...],
'BacktrackConsumedChangeRecords' => <integer>,
'BacktrackWindow' => <integer>,
'BackupRetentionPeriod' => <integer>,
'Capacity' => <integer>,
'CharacterSetName' => '<string>',
'CloneGroupId' => '<string>',
'ClusterCreateTime' => <DateTime>,
'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>',
'DatabaseName' => '<string>',
'DbClusterResourceId' => '<string>',
'DeletionProtection' => true || false,
'DomainMemberships' => [
[
'Domain' => '<string>',
'FQDN' => '<string>',
'IAMRoleName' => '<string>',
'Status' => '<string>',
],
// ...
],
'EarliestBacktrackTime' => <DateTime>,
'EarliestRestorableTime' => <DateTime>,
'EnabledCloudwatchLogsExports' => ['<string>', ...],
'Endpoint' => '<string>',
'Engine' => '<string>',
'EngineMode' => '<string>',
'EngineVersion' => '<string>',
'GlobalWriteForwardingRequested' => true || false,
'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown',
'HostedZoneId' => '<string>',
'HttpEndpointEnabled' => true || false,
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LatestRestorableTime' => <DateTime>,
'MasterUserSecret' => [
'KmsKeyId' => '<string>',
'SecretArn' => '<string>',
'SecretStatus' => '<string>',
],
'MasterUsername' => '<string>',
'MonitoringInterval' => <integer>,
'MonitoringRoleArn' => '<string>',
'MultiAZ' => true || false,
'NetworkType' => '<string>',
'PendingModifiedValues' => [
'AllocatedStorage' => <integer>,
'BackupRetentionPeriod' => <integer>,
'DBClusterIdentifier' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'MasterUserPassword' => '<string>',
'PendingCloudwatchLogsExports' => [
'LogTypesToDisable' => ['<string>', ...],
'LogTypesToEnable' => ['<string>', ...],
],
],
'PercentProgress' => '<string>',
'PerformanceInsightsEnabled' => true || false,
'PerformanceInsightsKMSKeyId' => '<string>',
'PerformanceInsightsRetentionPeriod' => <integer>,
'Port' => <integer>,
'PreferredBackupWindow' => '<string>',
'PreferredMaintenanceWindow' => '<string>',
'PubliclyAccessible' => true || false,
'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>,
],
'Status' => '<string>',
'StorageEncrypted' => true || false,
'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
-
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
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.
-
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 delete a DB cluster.
This example deletes the specified DB cluster.
$result = $client->deleteDBCluster([
'DBClusterIdentifier' => 'mydbcluster',
'SkipFinalSnapshot' => 1,
]);
Result syntax:
[
'DBCluster' => [
],
]
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
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. Theinactivestate applies to an endpoint that can't be used for a certain kind of cluster, such as awriterendpoint 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.
-
The requested operation can't be performed while the cluster is in this state.
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
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:
DBParameterGroupNamedoesn't refer to an existing DB parameter group.
Examples
Example 1: To delete a DB cluster parameter group.
This 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
Result Syntax
[
'DBClusterSnapshot' => [
'AllocatedStorage' => <integer>,
'AvailabilityZones' => ['<string>', ...],
'ClusterCreateTime' => <DateTime>,
'DBClusterIdentifier' => '<string>',
'DBClusterSnapshotArn' => '<string>',
'DBClusterSnapshotIdentifier' => '<string>',
'DBSystemId' => '<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,
'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
DescribeDBClusterSnapshotsaction.
Errors
-
InvalidDBClusterSnapshotStateFault:
The supplied value isn't a valid DB cluster snapshot state.
-
DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifierdoesn't refer to an existing DB cluster snapshot.
Examples
Example 1: To delete a DB cluster snapshot.
This example deletes the specified DB cluster snapshot.
$result = $client->deleteDBClusterSnapshot([
'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot',
]);
Result syntax:
[
'DBClusterSnapshot' => [
],
]
DeleteDBInstance
$result = $client->deleteDBInstance([/* ... */]); $promise = $client->deleteDBInstanceAsync([/* ... */]);
The DeleteDBInstance action 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. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
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 call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
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
A value that indicates 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
DBSnapshotIdentifierof the newDBSnapshotcreated when theSkipFinalSnapshotparameter 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
A value that indicates 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
FinalDBSnapshotIdentifierparameter.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>',
'DbInstancePort' => <integer>,
'DbiResourceId' => '<string>',
'DeletionProtection' => true || false,
'DomainMemberships' => [
[
'Domain' => '<string>',
'FQDN' => '<string>',
'IAMRoleName' => '<string>',
'Status' => '<string>',
],
// ...
],
'EnabledCloudwatchLogsExports' => ['<string>', ...],
'Endpoint' => [
'Address' => '<string>',
'HostedZoneId' => '<string>',
'Port' => <integer>,
],
'Engine' => '<string>',
'EngineVersion' => '<string>',
'EnhancedMonitoringResourceArn' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'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,
'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>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'LicenseModel' => '<string>',
'MasterUserPassword' => '<string>',
'MultiAZ' => true || false,
'PendingCloudwatchLogsExports' => [
'LogTypesToDisable' => ['<string>', ...],
'LogTypesToEnable' => ['<string>', ...],
],
'Port' => <integer>,
'ProcessorFeatures' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResumeFullAutomationModeTime' => <DateTime>,
'StorageThroughput' => <integer>,
'StorageType' => '<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>', ...],
'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
-
DBInstanceIdentifierdoesn't refer to an existing DB instance. -
The DB instance isn't in a valid state.
-
DBSnapshotIdentifieris already used by an existing snapshot. -
The request would result in the user exceeding the allowed number of DB snapshots.
-
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.
This example deletes the specified DB instance.
$result = $client->deleteDBInstance([
'DBInstanceIdentifier' => 'mymysqlinstance',
'SkipFinalSnapshot' => 1,
]);
Result syntax:
[
'DBInstance' => [
],
]
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>',
'BackupRetentionPeriod' => <integer>,
'BackupTarget' => '<string>',
'DBInstanceArn' => '<string>',
'DBInstanceAutomatedBackupsArn' => '<string>',
'DBInstanceAutomatedBackupsReplications' => [
[
'DBInstanceAutomatedBackupsArn' => '<string>',
],
// ...
],
'DBInstanceIdentifier' => '<string>',
'DbiResourceId' => '<string>',
'Encrypted' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LicenseModel' => '<string>',
'MasterUsername' => '<string>',
'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.
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
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:
DBParameterGroupNamedoesn'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' => 'mydbparamgroup3',
]);
DeleteDBProxy
$result = $client->deleteDBProxy([/* ... */]); $promise = $client->deleteDBProxyAsync([/* ... */]);
Deletes an existing DB proxy.
Parameter Syntax
$result = $client->deleteDBProxy([
'DBProxyName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'DBProxy' => [
'Auth' => [
[
'AuthScheme' => 'SECRETS',
'ClientPasswordAuthType' => 'MYSQL_NATIVE_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
-
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
-
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
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
-
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.
-
DBSecurityGroupNamedoesn'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',
]);
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
Result Syntax
[
'DBSnapshot' => [
'AllocatedStorage' => <integer>,
'AvailabilityZone' => '<string>',
'DBInstanceIdentifier' => '<string>',
'DBSnapshotArn' => '<string>',
'DBSnapshotIdentifier' => '<string>',
'DbiResourceId' => '<string>',
'Encrypted' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LicenseModel' => '<string>',
'MasterUsername' => '<string>',
'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
DescribeDBSnapshotsaction.
Errors
-
The state of the DB snapshot doesn't allow deletion.
-
DBSnapshotIdentifierdoesn't refer to an existing DB snapshot.
Examples
Example 1: To delete a DB cluster snapshot.
This example deletes the specified DB snapshot.
$result = $client->deleteDBSnapshot([
'DBSnapshotIdentifier' => 'mydbsnapshot',
]);
Result syntax:
[
'DBSnapshot' => [
],
]
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
Result Syntax
[]
Result Details
Errors
-
InvalidDBSubnetGroupStateFault:
The DB subnet group cannot be deleted because it's in use.
-
The DB subnet isn't in the available state.
-
DBSubnetGroupNamedoesn't refer to an existing DB subnet group.
Examples
Example 1: To delete a DB subnet group.
This example deletes the specified DB subnetgroup.
$result = $client->deleteDBSubnetGroup([
'DBSubnetGroupName' => 'mydbsubnetgroup',
]);
DeleteEventSubscription
$result = $client->deleteEventSubscription([/* ... */]); $promise = $client->deleteEventSubscriptionAsync([/* ... */]);
Deletes an RDS event notification subscription.
Parameter Syntax
$result = $client->deleteEventSubscription([
'SubscriptionName' => '<string>', // REQUIRED
]);
Parameter Details
Members
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
DescribeEventSubscriptionsaction.
Errors
-
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 a DB event subscription.
This example deletes the specified DB event subscription.
$result = $client->deleteEventSubscription([
'SubscriptionName' => 'myeventsubscription',
]);
Result syntax:
[
'EventSubscription' => [
],
]
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
Result Syntax
[
'GlobalCluster' => [
'DatabaseName' => '<string>',
'DeletionProtection' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'FailoverState' => [
'FromDbClusterArn' => '<string>',
'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>', ...],
],
// ...
],
'GlobalClusterResourceId' => '<string>',
'Status' => '<string>',
'StorageEncrypted' => true || false,
],
]
Result Details
Members
- GlobalCluster
-
- Type: GlobalCluster structure
A data type representing an Aurora global database.
Errors
-
The
GlobalClusterIdentifierdoesn't refer to an existing global database cluster. -
InvalidGlobalClusterStateFault:
The global cluster is in an invalid state and can't perform the requested operation.
DeleteOptionGroup
$result = $client->deleteOptionGroup([/* ... */]); $promise = $client->deleteOptionGroupAsync([/* ... */]);
Deletes an existing option group.
Parameter Syntax
$result = $client->deleteOptionGroup([
'OptionGroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified option group could not be found.
-
The option group isn't in the available state.
Examples
Example 1: To delete an option group.
This example deletes the specified option group.
$result = $client->deleteOptionGroup([
'OptionGroupName' => 'mydboptiongroup',
]);
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
DBProxythat is associated with theDBProxyTargetGroup. - TargetGroupName
-
- Type: string
The identifier of the
DBProxyTargetGroup.
Result Syntax
[]
Result Details
Errors
-
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.
-
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
-
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
AccountQuotaobjects. 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 list account attributes
This example lists account attributes.
$result = $client->describeAccountAttributes([ ]);
Result syntax:
[ ]
DescribeBlueGreenDeployments
$result = $client->describeBlueGreenDeployments([/* ... */]); $promise = $client->describeBlueGreenDeploymentsAsync([/* ... */]);
Returns information about 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 this parameter is specified, information from only the specific blue/green deployment is returned. This parameter isn't case-sensitive.
Constraints:
-
If supplied, 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.
Supported filters:
-
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
DescribeBlueGreenDeploymentsrequest. 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
MaxRecordsvalue, 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
[
'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
Contains a list of blue/green deployments for the user.
- Marker
-
- Type: string
A pagination token that can be used in a later DescribeBlueGreenDeployments request.
Errors
-
BlueGreenDeploymentNotFoundFault:
BlueGreenDeploymentIdentifierdoesn't refer to an existing blue/green deployment.
DescribeCertificates
$result = $client->describeCertificates([/* ... */]); $promise = $client->describeCertificatesAsync([/* ... */]);
Lists the set of 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
DescribeCertificatesrequest. 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
MaxRecordsvalue, 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>,
],
// ...
],
'Marker' => '<string>',
]
Result Details
Members
- Certificates
-
- Type: Array of Certificate structures
The list of
Certificateobjects for the Amazon Web Services account. - Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeCertificatesrequest. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords.
Errors
-
CertificateIdentifierdoesn't refer to an existing certificate.
Examples
Example 1: To list certificates
This example lists up to 20 certificates for the specified certificate identifier.
$result = $client->describeCertificates([
'CertificateIdentifier' => 'rds-ca-2015',
'MaxRecords' => 20,
]);
Result syntax:
[ ]
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 A Universally Unique Identifier (UUID) URN Namespace.
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
DescribeDBClusterBacktracksrequest. 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
MaxRecordsvalue, 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
DescribeDBClusterBacktracksrequest.
Errors
-
DBClusterIdentifierdoesn't refer to an existing DB cluster. -
DBClusterBacktrackNotFoundFault:
BacktrackIdentifierdoesn't refer to an existing backtrack.
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,....Namecan be one of:db-cluster-endpoint-type,db-cluster-endpoint-custom-type,db-cluster-endpoint-id,db-cluster-endpoint-status.Valuesfor thedb-cluster-endpoint-typefilter can be one or more of:reader,writer,custom.Valuesfor thedb-cluster-endpoint-custom-typefilter can be one or more of:reader,any.Valuesfor thedb-cluster-endpoint-statusfilter can be one or more of:available,creating,deleting,inactive,modifying. - Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterEndpointsrequest. 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
MaxRecordsvalue, 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
DescribeDBClusterEndpointsrequest. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords.
Errors
-
DBClusterIdentifierdoesn't refer to an existing DB cluster.
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
DescribeDBClusterParameterGroupsrequest. 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
MaxRecordsvalue, 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
DescribeDBClusterParameterGroupsrequest. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords.
Errors
-
DBParameterGroupNotFoundFault:
DBParameterGroupNamedoesn't refer to an existing DB parameter group.
Examples
Example 1: To list DB cluster parameter group settings
This example lists settings for the specified DB cluster parameter group.
$result = $client->describeDBClusterParameterGroups([
'DBClusterParameterGroupName' => 'mydbclusterparametergroup',
]);
Result syntax:
[ ]
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
DescribeDBClusterParametersrequest. 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
MaxRecordsvalue, 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 value that indicates to return only parameters for a specific source. Parameter sources can be
engine,service, orcustomer.
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
DescribeDBClusterParametersrequest. 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:
DBParameterGroupNamedoesn't refer to an existing DB parameter group.
Examples
Example 1: To list DB cluster parameters
This example lists system parameters for the specified DB cluster parameter group.
$result = $client->describeDBClusterParameters([
'DBClusterParameterGroupName' => 'mydbclusterparametergroup',
'Source' => 'system',
]);
Result syntax:
[ ]
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
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
DescribeDBClusterSnapshotAttributesAPI 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
ModifyDBClusterSnapshotAttributeAPI action.
Errors
-
DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifierdoesn't refer to an existing DB cluster snapshot.
Examples
Example 1: To list DB cluster snapshot attributes
This example lists attributes for the specified DB cluster snapshot.
$result = $client->describeDBClusterSnapshotAttributes([
'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot',
]);
Result syntax:
[
'DBClusterSnapshotAttributesResult' => [
],
]
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>',
'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
DBClusterSnapshotIdentifierparameter. 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
DBClusterIdentifierparameter. 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
SnapshotTypeparameter must also be specified.
- 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
A value that indicates 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
A value that indicates 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
ModifyDBClusterSnapshotAttributeAPI action. - Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBClusterSnapshotsrequest. 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
MaxRecordsvalue, 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
SnapshotTypevalue, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling theIncludeSharedparameter. You can include public DB cluster snapshots with these results by enabling theIncludePublicparameter.The
IncludeSharedandIncludePublicparameters don't apply forSnapshotTypevalues ofmanualorautomated. TheIncludePublicparameter doesn't apply whenSnapshotTypeis set toshared. TheIncludeSharedparameter doesn't apply whenSnapshotTypeis set topublic.
Result Syntax
[
'DBClusterSnapshots' => [
[
'AllocatedStorage' => <integer>,
'AvailabilityZones' => ['<string>', ...],
'ClusterCreateTime' => <DateTime>,
'DBClusterIdentifier' => '<string>',
'DBClusterSnapshotArn' => '<string>',
'DBClusterSnapshotIdentifier' => '<string>',
'DBSystemId' => '<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,
'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
DescribeDBClusterSnapshotsrequest. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords.
Errors
-
DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifierdoesn't refer to an existing DB cluster snapshot.
Examples
Example 1: To list DB cluster snapshots
This example lists settings for the specified, manually-created cluster snapshot.
$result = $client->describeDBClusterSnapshots([
'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot',
'SnapshotType' => 'manual',
]);
Result syntax:
[ ]
DescribeDBClusters
$result = $client->describeDBClusters([/* ... */]); $promise = $client->describeDBClustersAsync([/* ... */]);
Returns information about 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 from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match an existing DBClusterIdentifier.
- 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. -
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
Optional Boolean parameter that 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
DescribeDBClustersrequest. 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
MaxRecordsvalue, 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>', ...],
'BacktrackConsumedChangeRecords' => <integer>,
'BacktrackWindow' => <integer>,
'BackupRetentionPeriod' => <integer>,
'Capacity' => <integer>,
'CharacterSetName' => '<string>',
'CloneGroupId' => '<string>',
'ClusterCreateTime' => <DateTime>,
'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>',
'DatabaseName' => '<string>',
'DbClusterResourceId' => '<string>',
'DeletionProtection' => true || false,
'DomainMemberships' => [
[
'Domain' => '<string>',
'FQDN' => '<string>',
'IAMRoleName' => '<string>',
'Status' => '<string>',
],
// ...
],
'EarliestBacktrackTime' => <DateTime>,
'EarliestRestorableTime' => <DateTime>,
'EnabledCloudwatchLogsExports' => ['<string>', ...],
'Endpoint' => '<string>',
'Engine' => '<string>',
'EngineMode' => '<string>',
'EngineVersion' => '<string>',
'GlobalWriteForwardingRequested' => true || false,
'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown',
'HostedZoneId' => '<string>',
'HttpEndpointEnabled' => true || false,
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LatestRestorableTime' => <DateTime>,
'MasterUserSecret' => [
'KmsKeyId' => '<string>',
'SecretArn' => '<string>',
'SecretStatus' => '<string>',
],
'MasterUsername' => '<string>',
'MonitoringInterval' => <integer>,
'MonitoringRoleArn' => '<string>',
'MultiAZ' => true || false,
'NetworkType' => '<string>',
'PendingModifiedValues' => [
'AllocatedStorage' => <integer>,
'BackupRetentionPeriod' => <integer>,
'DBClusterIdentifier' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'MasterUserPassword' => '<string>',
'PendingCloudwatchLogsExports' => [
'LogTypesToDisable' => ['<string>', ...],
'LogTypesToEnable' => ['<string>', ...],
],
],
'PercentProgress' => '<string>',
'PerformanceInsightsEnabled' => true || false,
'PerformanceInsightsKMSKeyId' => '<string>',
'PerformanceInsightsRetentionPeriod' => <integer>,
'Port' => <integer>,
'PreferredBackupWindow' => '<string>',
'PreferredMaintenanceWindow' => '<string>',
'PubliclyAccessible' => true || false,
'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>,
],
'Status' => '<string>',
'StorageEncrypted' => true || false,
'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
-
DBClusterIdentifierdoesn't refer to an existing DB cluster.
Examples
Example 1: To list DB clusters
This example lists settings for the specified DB cluster.
$result = $client->describeDBClusters([
'DBClusterIdentifier' => 'mynewdbcluster',
]);
Result syntax:
[ ]
DescribeDBEngineVersions
$result = $client->describeDBEngineVersions([/* ... */]); $promise = $client->describeDBEngineVersionsAsync([/* ... */]);
Returns a list of the available 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 DBParameterGroupFamily.
- DefaultOnly
-
- Type: boolean
A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
- Engine
-
- Type: string
The database engine to return.
Valid Values:
-
aurora(for MySQL 5.6-compatible Aurora) -
aurora-mysql(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) -
aurora-postgresql -
mariadb -
mysql -
oracle-ee -
oracle-ee-cdb -
oracle-se2 -
oracle-se2-cdb -
postgres -
sqlserver-ee -
sqlserver-se -
sqlserver-ex -
sqlserver-web
- EngineVersion
-
- Type: string
The database engine version to return.
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
A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
- ListSupportedCharacterSets
-
- Type: boolean
A value that indicates whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the
CharacterSetNameparameter 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 set
ListSupportedCharacterSetstotrue, RDS Custom returns no results. - ListSupportedTimezones
-
- Type: boolean
A value that indicates whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the
TimeZoneparameter 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 set
ListSupportedTimezonestotrue, 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
MaxRecordsvalue 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>',
'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,
'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,
'SupportsParallelQuery' => true || false,
],
// ...
],
],
// ...
],
'Marker' => '<string>',
]
Result Details
Members
- DBEngineVersions
-
- Type: Array of DBEngineVersion structures
A list of
DBEngineVersionelements. - 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 list DB engine version settings
This example lists settings for the specified DB engine version.
$result = $client->describeDBEngineVersions([
'DBParameterGroupFamily' => 'mysql5.6',
'DefaultOnly' => 1,
'Engine' => 'mysql',
'EngineVersion' => '5.6',
'ListSupportedCharacterSets' => 1,
]);
Result syntax:
[ ]
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' 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 -
retained- automated backups for deleted instances and after backup replication is stopped -
creating- automated backups that are waiting for the first automated snapshot to be available
-
-
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
MaxRecordsvalue, 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>',
'BackupRetentionPeriod' => <integer>,
'BackupTarget' => '<string>',
'DBInstanceArn' => '<string>',
'DBInstanceAutomatedBackupsArn' => '<string>',
'DBInstanceAutomatedBackupsReplications' => [
[
'DBInstanceAutomatedBackupsArn' => '<string>',
],
// ...
],
'DBInstanceIdentifier' => '<string>',
'DbiResourceId' => '<string>',
'Encrypted' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LicenseModel' => '<string>',
'MasterUsername' => '<string>',
'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
DBInstanceAutomatedBackupinstances. - 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.
DescribeDBInstances
$result = $client->describeDBInstances([/* ... */]); $promise = $client->describeDBInstancesAsync([/* ... */]);
Returns information about 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 DBInstance.
- 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 will only include 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
DescribeDBInstancesrequest. 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
MaxRecordsvalue, 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>',
'DbInstancePort' => <integer>,
'DbiResourceId' => '<string>',
'DeletionProtection' => true || false,
'DomainMemberships' => [
[
'Domain' => '<string>',
'FQDN' => '<string>',
'IAMRoleName' => '<string>',
'Status' => '<string>',
],
// ...
],
'EnabledCloudwatchLogsExports' => ['<string>', ...],
'Endpoint' => [
'Address' => '<string>',
'HostedZoneId' => '<string>',
'Port' => <integer>,
],
'Engine' => '<string>',
'EngineVersion' => '<string>',
'EnhancedMonitoringResourceArn' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'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,
'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>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'Iops' => <integer>,
'LicenseModel' => '<string>',
'MasterUserPassword' => '<string>',
'MultiAZ' => true || false,
'PendingCloudwatchLogsExports' => [
'LogTypesToDisable' => ['<string>', ...],
'LogTypesToEnable' => ['<string>', ...],
],
'Port' => <integer>,
'ProcessorFeatures' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResumeFullAutomationModeTime' => <DateTime>,
'StorageThroughput' => <integer>,
'StorageType' => '<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>', ...],
'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
DBInstanceinstances. - 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
-
DBInstanceIdentifierdoesn't refer to an existing DB instance.
Examples
Example 1: To list DB instance settings
This example lists settings for the specified DB instance.
$result = $client->describeDBInstances([
'DBInstanceIdentifier' => 'mymysqlinstance',
]);
Result syntax:
[ ]
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
DescribeDBLogFilesrequest.
Errors
-
DBInstanceIdentifierdoesn't refer to an existing DB instance.
Examples
Example 1: To list DB log file names
This example lists matching log file names for the specified DB instance, file name pattern, last write date in POSIX time with milleseconds, and minimum file size.
$result = $client->describeDBLogFiles([
'DBInstanceIdentifier' => 'mymysqlinstance',
'FileLastWritten' => 1470873600000,
'FileSize' => 0,
'FilenameContains' => 'error',
]);
Result syntax:
[ ]
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
DescribeDBParameterGroupsrequest. 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
MaxRecordsvalue, 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
DBParameterGroupinstances. - 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:
DBParameterGroupNamedoesn't refer to an existing DB parameter group.
Examples
Example 1: To list information about DB parameter groups
This example lists information about the specified DB parameter group.
$result = $client->describeDBParameterGroups([
'DBParameterGroupName' => 'mymysqlparametergroup',
]);
Result syntax:
[ ]
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
DescribeDBParametersrequest. 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
MaxRecordsvalue, 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
Parametervalues.
Errors
-
DBParameterGroupNotFoundFault:
DBParameterGroupNamedoesn't refer to an existing DB parameter group.
Examples
Example 1: To list information about DB parameters
This example lists information for up to the first 20 system parameters for the specified DB parameter group.
$result = $client->describeDBParameters([
'DBParameterGroupName' => 'mymysqlparametergroup',
'MaxRecords' => 20,
'Source' => 'system',
]);
Result syntax:
[ ]
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
MaxRecordsvalue, 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|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
DBProxydata 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
-
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
MaxRecordsvalue, 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
ProxyEndpointobjects 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
-
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
-
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
DBProxyassociated 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
MaxRecordsvalue, 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
DBProxyTargetGroupto 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
DBProxyTargetGroupobjects, containing details of the corresponding target groups.
Errors
-
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.
-
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
DBProxyTargetto 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
MaxRecordsvalue, 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
DBProxyTargetGroupto 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
DBProxyTargetobjects, containing details of the corresponding targets.
Errors
-
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
-
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.
-
The requested operation can't be performed while the proxy is in this state.
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
DescribeDBSecurityGroupsrequest. 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
MaxRecordsvalue, 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
DBSecurityGroupinstances. - 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
-
DBSecurityGroupNamedoesn'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:
[ ]
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
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
DescribeDBSnapshotAttributesAPI 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
ModifyDBSnapshotAttributeAPI action.
Errors
-
DBSnapshotIdentifierdoesn't refer to an existing DB snapshot.
Examples
Example 1: To list DB snapshot attributes
This example lists attributes for the specified DB snapshot.
$result = $client->describeDBSnapshotAttributes([
'DBSnapshotIdentifier' => 'mydbsnapshot',
]);
Result syntax:
[
'DBSnapshotAttributesResult' => [
],
]
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
SnapshotTypeparameter 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
A value that indicates 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
A value that indicates 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
ModifyDBSnapshotAttributeAPI action.This setting doesn't apply to RDS Custom.
- Marker
-
- Type: string
An optional pagination token provided by a previous
DescribeDBSnapshotsrequest. 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
MaxRecordsvalue, 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
awsbackuptype does not apply to Aurora.
If you don't specify a
SnapshotTypevalue, 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 theIncludeSharedparameter. You can include public snapshots with these results by enabling theIncludePublicparameter.The
IncludeSharedandIncludePublicparameters don't apply forSnapshotTypevalues ofmanualorautomated. TheIncludePublicparameter doesn't apply whenSnapshotTypeis set toshared. TheIncludeSharedparameter doesn't apply whenSnapshotTypeis set topublic.
Result Syntax
[
'DBSnapshots' => [
[
'AllocatedStorage' => <integer>,
'AvailabilityZone' => '<string>',
'DBInstanceIdentifier' => '<string>',
'DBSnapshotArn' => '<string>',
'DBSnapshotIdentifier' => '<string>',
'DbiResourceId' => '<string>',
'Encrypted' => true || false,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => <DateTime>,
'Iops' => <integer>,
'KmsKeyId' => '<string>',
'LicenseModel' => '<string>',
'MasterUsername' => '<string>',
'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
DBSnapshotinstances. - 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
-
DBSnapshotIdentifierdoesn't refer to an existing DB snapshot.
Examples
Example 1: To list DB snapshot attributes
This example lists all manually-created, shared snapshots for the specified DB instance.
$result = $client->describeDBSnapshots([
'DBInstanceIdentifier' => 'mymysqlinstance',
'IncludePublic' => ,
'IncludeShared' => 1,
'SnapshotType' => 'manual',
]);
Result syntax:
[ ]
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
MaxRecordsvalue, 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
DBSubnetGroupinstances. - 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
-
DBSubnetGroupNamedoesn't refer to an existing DB subnet group.
Examples
Example 1: To list information about DB subnet groups
This example lists information about the specified DB subnet group.
$result = $client->describeDBSubnetGroups([
'DBSubnetGroupName' => 'mydbsubnetgroup',
]);
Result syntax:
[ ]
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
DescribeEngineDefaultClusterParametersrequest. 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
MaxRecordsvalue, 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
DescribeEngineDefaultParametersaction.
Errors
There are no errors described for this operation.
Examples
Example 1: To list default parameters for a DB cluster engine
This example lists default parameters for the specified DB cluster engine.
$result = $client->describeEngineDefaultClusterParameters([
'DBParameterGroupFamily' => 'aurora5.6',
]);
Result syntax:
[
'EngineDefaults' => [
],
]
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:
-
aurora5.6 -
aurora-mysql5.7 -
aurora-mysql8.0 -
aurora-postgresql10 -
aurora-postgresql11 -
aurora-postgresql12 -
aurora-postgresql13 -
aurora-postgresql14 -
custom-oracle-ee-19 -
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
DescribeEngineDefaultParametersrequest. 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
MaxRecordsvalue, 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
DescribeEngineDefaultParametersaction.
Errors
There are no errors described for this operation.
Examples
Example 1: To list default parameters for a DB engine
This example lists default parameters for the specified DB engine.
$result = $client->describeEngineDefaultParameters([
'DBParameterGroupFamily' => 'mysql5.6',
]);
Result syntax:
[
'EngineDefaults' => [
],
]
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
EventCategoriesMapdata types.
Errors
There are no errors described for this operation.
Examples
Example 1: To list event categories.
This example lists all DB instance event categories.
$result = $client->describeEventCategories([
'SourceType' => 'db-instance',
]);
Result syntax:
[ ]
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
MaxRecordsvalue, 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
-
The subscription name does not exist.
Examples
Example 1: To list information about DB event notification subscriptions
This example lists information for the specified DB event notification subscription.
$result = $client->describeEventSubscriptions([
'SubscriptionName' => 'mymysqleventsubscription',
]);
Result syntax:
[ ]
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
MaxRecordsvalue, 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
SourceIdentifieris supplied,SourceTypemust also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifiervalue must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifiervalue must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupNamevalue must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupNamevalue must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifiervalue must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifiervalue must be supplied. -
If the source type is an RDS Proxy, a
DBProxyNamevalue 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
Eventinstances. - 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 list information about events
This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080 minutes).
$result = $client->describeEvents([
'Duration' => 10080,
'EventCategories' => [
'backup',
],
'SourceIdentifier' => 'mymysqlinstance',
'SourceType' => 'db-instance',
]);
Result syntax:
[ ]
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
DescribeExportTasksrequest. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by theMaxRecordsparameter. - 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
DescribeExportTasksrequest 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
DescribeExportTasksrequest. A marker is used for pagination to identify the location to begin output for the next response ofDescribeExportTasks.
Errors
-
The export task doesn't exist.
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
This parameter isn't currently supported.
- 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
DescribeGlobalClustersrequest. 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
MaxRecordsvalue, 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,
'Engine' => '<string>',
'EngineVersion' => '<string>',
'FailoverState' => [
'FromDbClusterArn' => '<string>',
'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>', ...],
],
// ...
],
'GlobalClusterResourceId' => '<string>',
'Status' => '<string>',
'StorageEncrypted' => true || false,
],
// ...
],
'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
DescribeGlobalClustersrequest. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords.
Errors
-
The
GlobalClusterIdentifierdoesn't refer to an existing global database cluster.
DescribeOptionGroupOptions
$result = $client->describeOptionGroupOptions([/* ... */]); $promise = $client->describeOptionGroupOptionsAsync([/* ... */]);
Describes all available options.
Parameter Syntax
$result = $client->describeOptionGroupOptions([
'EngineName' => '<string>', // REQUIRED
'Filters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MajorEngineVersion' => '<string>',
'Marker' => '<string>',
'MaxRecords' => <integer>,
]);