openapi: 3.0.0
info:
version: 2014-10-31
x-release: v4
title: Amazon Relational Database Service
description: "
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
arn:aws:iam::123456789012:role/AuroraAccessRole.
schema:
type: string
- name: FeatureName
in: query
required: false
description: 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.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AddRoleToDBCluster
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: AddRoleToDBCluster
operationId: POST_AddRoleToDBCluster
description: Associates an Identity and Access Management (IAM) role with a DB cluster.
responses:
"200":
description: Success
"480":
description: DBClusterNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBClusterNotFoundFault"
"481":
description: DBClusterRoleAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBClusterRoleAlreadyExistsFault"
"482":
description: InvalidDBClusterStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBClusterStateFault"
"483":
description: DBClusterRoleQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBClusterRoleQuotaExceededFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/AddRoleToDBClusterMessage"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AddRoleToDBCluster
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=AddRoleToDBInstance:
get:
x-aws-operation-name: AddRoleToDBInstance
operationId: GET_AddRoleToDBInstance
description: 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.
responses: "200": description: Success "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBInstanceRoleAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceRoleAlreadyExistsFault" "482": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "483": description: DBInstanceRoleQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceRoleQuotaExceededFault" parameters: - name: DBInstanceIdentifier in: query required: true description: The name of the DB instance to associate the IAM role with. schema: type: string - name: RoleArn in: query required: true description: The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for examplearn:aws:iam::123456789012:role/AccessRole.
schema:
type: string
- name: FeatureName
in: query
required: true
description: 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.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AddRoleToDBInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: AddRoleToDBInstance
operationId: POST_AddRoleToDBInstance
description: 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.
responses: "200": description: Success "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBInstanceRoleAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceRoleAlreadyExistsFault" "482": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "483": description: DBInstanceRoleQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceRoleQuotaExceededFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/AddRoleToDBInstanceMessage" parameters: - name: Action in: query required: true schema: type: string enum: - AddRoleToDBInstance - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=AddSourceIdentifierToSubscription: get: x-aws-operation-name: AddSourceIdentifierToSubscription operationId: GET_AddSourceIdentifierToSubscription description: Adds a source identifier to an existing RDS event notification subscription. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AddSourceIdentifierToSubscriptionResult" "480": description: SubscriptionNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/SubscriptionNotFoundFault" "481": description: SourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/SourceNotFoundFault" parameters: - name: SubscriptionName in: query required: true description: The name of the RDS event notification subscription you want to add a source identifier to. schema: type: string - name: SourceIdentifier in: query required: true description:The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
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.
responses: "200": description: Success "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "482": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "483": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" "484": description: DBProxyTargetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault" "485": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" parameters: - name: ResourceName in: query required: true description: 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). schema: type: string - name: Tags in: query required: true description: The tags to be assigned to the Amazon RDS resource. schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: Action in: query required: true schema: type: string enum: - AddTagsToResource - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AddTagsToResource operationId: POST_AddTagsToResource description: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.
responses: "200": description: Success "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "482": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "483": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" "484": description: DBProxyTargetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault" "485": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/AddTagsToResourceMessage" parameters: - name: Action in: query required: true schema: type: string enum: - AddTagsToResource - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ApplyPendingMaintenanceAction: get: x-aws-operation-name: ApplyPendingMaintenanceAction operationId: GET_ApplyPendingMaintenanceAction description: Applies a pending maintenance action to a resource (for example, to a DB instance). responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ApplyPendingMaintenanceActionResult" "480": description: ResourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" parameters: - name: ResourceIdentifier in: query required: true description: 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). schema: type: string - name: ApplyAction in: query required: true description: "The pending maintenance action to apply to this resource.
Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.
Valid values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
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.
EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
schema:
type: string
- name: EC2SecurityGroupId
in: query
required: false
description: Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
schema:
type: string
- name: EC2SecurityGroupOwnerId
in: query
required: false
description: Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AuthorizeDBSecurityGroupIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: AuthorizeDBSecurityGroupIngress
operationId: POST_AuthorizeDBSecurityGroupIngress
description: 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.
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.
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
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
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.
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.
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
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 the SourceDBClusterSnapshotIdentifier in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CopyDBClusterSnapshotResult" "480": description: DBClusterSnapshotAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotAlreadyExistsFault" "481": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" "482": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "483": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" "484": description: SnapshotQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/SnapshotQuotaExceededFault" "485": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" parameters: - name: SourceDBClusterSnapshotIdentifier in: query required: true description: "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
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
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
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 the SourceDBClusterSnapshotIdentifier in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CopyDBClusterSnapshotResult" "480": description: DBClusterSnapshotAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotAlreadyExistsFault" "481": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" "482": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "483": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" "484": description: SnapshotQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/SnapshotQuotaExceededFault" "485": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CopyDBClusterSnapshotMessage" parameters: - name: Action in: query required: true schema: type: string enum: - CopyDBClusterSnapshot - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=CopyDBParameterGroup: get: x-aws-operation-name: CopyDBParameterGroup operationId: GET_CopyDBParameterGroup description: Copies the specified DB parameter group. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CopyDBParameterGroupResult" "480": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "481": description: DBParameterGroupAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupAlreadyExistsFault" "482": description: DBParameterGroupQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupQuotaExceededFault" parameters: - name: SourceDBParameterGroupIdentifier in: query required: true description: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.
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
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CopyDBSnapshotResult" "480": description: DBSnapshotAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotAlreadyExistsFault" "481": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "482": description: InvalidDBSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSnapshotStateFault" "483": description: SnapshotQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/SnapshotQuotaExceededFault" "484": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "485": description: CustomAvailabilityZoneNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CustomAvailabilityZoneNotFoundFault" parameters: - name: SourceDBSnapshotIdentifier in: query required: true description: 'The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
Constraints:
Must specify a valid system snapshot in the "available" state.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
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
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.
schema: type: string - name: Tags in: query required: false description: "" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: CopyTags in: query required: false description: 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. schema: type: boolean - name: PreSignedUrl in: query required: false description: "When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
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.
schema: type: string - name: TargetCustomAvailabilityZone in: query required: false description: "The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv.
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CopyDBSnapshotResult" "480": description: DBSnapshotAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotAlreadyExistsFault" "481": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "482": description: InvalidDBSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSnapshotStateFault" "483": description: SnapshotQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/SnapshotQuotaExceededFault" "484": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "485": description: CustomAvailabilityZoneNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CustomAvailabilityZoneNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CopyDBSnapshotMessage" parameters: - name: Action in: query required: true schema: type: string enum: - CopyDBSnapshot - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=CopyOptionGroup: get: x-aws-operation-name: CopyOptionGroup operationId: GET_CopyOptionGroup description: Copies the specified option group. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CopyOptionGroupResult" "480": description: OptionGroupAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupAlreadyExistsFault" "481": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "482": description: OptionGroupQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupQuotaExceededFault" parameters: - name: SourceOptionGroupIdentifier in: query required: true description:The identifier for the source option group.
Constraints:
Must specify a valid option group.
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
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateBlueGreenDeploymentResponse" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "482": description: SourceDatabaseNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/SourceDatabaseNotSupportedFault" "483": description: SourceClusterNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/SourceClusterNotSupportedFault" "484": description: BlueGreenDeploymentAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentAlreadyExistsFault" "485": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "486": description: DBClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNotFoundFault" "487": description: InstanceQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/InstanceQuotaExceededFault" "488": description: DBClusterQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterQuotaExceededFault" "489": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "490": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" parameters: - name: BlueGreenDeploymentName in: query required: true description: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.
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.
schema: type: string pattern: ^arn:[A-Za-z][0-9A-Za-z-:._]* minLength: 1 maxLength: 2048 - name: TargetEngineVersion in: query required: false description:The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
schema: type: string pattern: "[0-9A-Za-z-_.]+" minLength: 1 maxLength: 64 - name: TargetDBParameterGroupName in: query required: false description: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.
schema: type: string pattern: "[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]" minLength: 1 maxLength: 255 - name: TargetDBClusterParameterGroupName in: query required: false description: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.
schema: type: string pattern: "[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]" minLength: 1 maxLength: 255 - name: Tags in: query required: false description: Tags to assign to the blue/green deployment. schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: Action in: query required: true schema: type: string enum: - CreateBlueGreenDeployment - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateBlueGreenDeployment operationId: POST_CreateBlueGreenDeployment description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateBlueGreenDeploymentResponse" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "482": description: SourceDatabaseNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/SourceDatabaseNotSupportedFault" "483": description: SourceClusterNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/SourceClusterNotSupportedFault" "484": description: BlueGreenDeploymentAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentAlreadyExistsFault" "485": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "486": description: DBClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNotFoundFault" "487": description: InstanceQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/InstanceQuotaExceededFault" "488": description: DBClusterQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterQuotaExceededFault" "489": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "490": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateBlueGreenDeploymentRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateBlueGreenDeployment - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=CreateCustomDBEngineVersion: get: x-aws-operation-name: CreateCustomDBEngineVersion operationId: GET_CreateCustomDBEngineVersion description: Creates a custom DB engine version (CEV). responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBEngineVersion" "480": description: CustomDBEngineVersionAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/CustomDBEngineVersionAlreadyExistsFault" "481": description: CustomDBEngineVersionQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/CustomDBEngineVersionQuotaExceededFault" "482": description: Ec2ImagePropertiesNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/Ec2ImagePropertiesNotSupportedFault" "483": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "484": description: CreateCustomDBEngineVersionFault content: text/xml: schema: $ref: "#/components/schemas/CreateCustomDBEngineVersionFault" parameters: - name: Engine in: query required: true description: The database engine to use for your custom engine version (CEV). The only supported value iscustom-oracle-ee.
schema:
type: string
pattern: ^[A-Za-z0-9-]{1,35}$
minLength: 1
maxLength: 35
- name: EngineVersion
in: query
required: true
description: 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 of Engine and EngineVersion is unique per customer per Region.
schema:
type: string
pattern: ^[a-z0-9_.-]{1,60}$
minLength: 1
maxLength: 60
- name: DatabaseInstallationFilesS3BucketName
in: query
required: false
description: 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.
schema:
type: string
pattern: .*
minLength: 3
maxLength: 63
- name: DatabaseInstallationFilesS3Prefix
in: query
required: false
description: 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.
schema:
type: string
pattern: .*
minLength: 1
maxLength: 255
- name: ImageId
in: query
required: false
description: The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
schema:
type: string
pattern: .*
minLength: 1
maxLength: 255
- name: KMSKeyId
in: query
required: false
description: 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.
schema: type: string pattern: "[a-zA-Z0-9_:\\-\\/]+" minLength: 1 maxLength: 2048 - name: Description in: query required: false description: An optional description of your CEV. schema: type: string pattern: .* minLength: 1 maxLength: 1000 - name: Manifest in: query required: false description: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:
Version of the CEV manifest. The date is in the format YYYY-MM-DD.
Ordered list of installation files for the CEV.
Ordered list of OPatch installers used for the Oracle DB engine.
The PSU and RU patches for this CEV.
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.
schema: type: string pattern: "[\\s\\S]*" minLength: 1 maxLength: 51000 - name: Tags in: query required: false description: "" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: Action in: query required: true schema: type: string enum: - CreateCustomDBEngineVersion - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateCustomDBEngineVersion operationId: POST_CreateCustomDBEngineVersion description: Creates a custom DB engine version (CEV). responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBEngineVersion" "480": description: CustomDBEngineVersionAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/CustomDBEngineVersionAlreadyExistsFault" "481": description: CustomDBEngineVersionQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/CustomDBEngineVersionQuotaExceededFault" "482": description: Ec2ImagePropertiesNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/Ec2ImagePropertiesNotSupportedFault" "483": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "484": description: CreateCustomDBEngineVersionFault content: text/xml: schema: $ref: "#/components/schemas/CreateCustomDBEngineVersionFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateCustomDBEngineVersionMessage" parameters: - name: Action in: query required: true schema: type: string enum: - CreateCustomDBEngineVersion - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=CreateDBCluster: get: x-aws-operation-name: CreateDBCluster operationId: GET_CreateDBCluster description:Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
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
' schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: AvailabilityZone - name: BackupRetentionPeriod in: query required: false description: "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
" schema: type: integer - name: CharacterSetName in: query required: false description: "A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
" schema: type: string - name: DatabaseName in: query required: false description: "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
" schema: type: string - name: DBClusterIdentifier in: query required: true description: "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-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: DBClusterParameterGroupName in: query required: false description: "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
" schema: type: string - name: VpcSecurityGroupIds in: query required: false description: "A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: DBSubnetGroupName in: query required: false description: "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: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: Engine in: query required: true description: "The name of the database engine to be used for this DB cluster.
Valid Values:
aurora-mysql
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: EngineVersion in: query required: false description: 'The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
For information, see Database engine updates for Amazon Aurora MySQL 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 Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' schema: type: string - name: Port in: query required: false description: "The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: integer - name: MasterUsername in: query required: false description: "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
" schema: type: string - name: MasterUserPassword in: query required: false description: "The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: OptionGroupName in: query required: false description: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.
schema: type: string - name: PreferredBackupWindow in: query required: false description: 'The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' schema: type: string - name: PreferredMaintenanceWindow in: query required: false description: 'The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred 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
' schema: type: string - name: ReplicationSourceIdentifier in: query required: false description: "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 Multi-AZ DB clusters
" schema: type: string - name: Tags in: query required: false description: "Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: StorageEncrypted in: query required: false description: "A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: boolean - name: KmsKeyId in: query required: false description: "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn'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 KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: PreSignedUrl in: query required: false description: "When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.
The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
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
" schema: type: boolean - name: BacktrackWindow in: query required: false description: "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
" schema: type: integer - name: EnableCloudwatchLogsExports in: query required: false description: '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, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
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
' schema: type: array items: $ref: "#/components/schemas/String" - name: EngineMode in: query required: false description: 'The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
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
' schema: type: string - name: ScalingConfiguration in: query required: false description: "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction: allOf: - $ref: "#/components/schemas/String" - description:The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
SecondsBeforeTimeout: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
description:Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
- name: DeletionProtection in: query required: false description: "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
" schema: type: boolean - name: GlobalClusterIdentifier in: query required: false description: "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
" schema: type: string - name: EnableHttpEndpoint in: query required: false description: '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
' schema: type: boolean - name: CopyTagsToSnapshot in: query required: false description: "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
" schema: type: boolean - name: Domain in: query required: false description: '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
' schema: type: string - name: DomainIAMRoleName in: query required: false description: "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
" schema: type: string - name: EnableGlobalWriteForwarding in: query required: false description: "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
" schema: type: boolean - name: DBClusterInstanceClass in: query required: false description: '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
' schema: type: string - name: AllocatedStorage in: query required: false description: "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
" schema: type: integer - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
" schema: type: string - name: Iops in: query required: false description: 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
' schema: type: integer - name: PubliclyAccessible in: query required: false description: "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 DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
" schema: type: boolean - name: AutoMinorVersionUpgrade in: query required: false description: "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
" schema: type: boolean - name: MonitoringInterval in: query required: false description: "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 MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
" schema: type: integer - name: MonitoringRoleArn in: query required: false description: 'The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
' schema: type: string - name: EnablePerformanceInsights in: query required: false description: '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
' schema: type: boolean - name: PerformanceInsightsKMSKeyId in: query required: false description: "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
" schema: type: string - name: PerformanceInsightsRetentionPeriod in: query required: false description: "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
" schema: type: integer - name: ServerlessV2ScalingConfiguration in: query required: false description: "" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. MaxCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. description:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- name: NetworkType in: query required: false description: 'The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' schema: type: string - name: DBSystemId in: query required: false description: Reserved for future use. schema: type: string - name: ManageMasterUserPassword in: query required: false description: "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 MasterUserPassword is specified.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: boolean - name: MasterUserSecretKmsKeyId in: query required: false description: "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 the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: SourceRegion in: query required: false description: The ID of the region that contains the source for the read replica. schema: type: string - name: Action in: query required: true schema: type: string enum: - CreateDBCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateDBCluster operationId: POST_CreateDBCluster description:Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
READER, WRITER, ANY."
schema:
type: string
- name: StaticMembers
in: query
required: false
description: List of DB instance identifiers that are part of the custom endpoint group.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: ExcludedMembers
in: query
required: false
description: 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.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: Tags
in: query
required: false
description: The tags to be assigned to the Amazon RDS resource.
schema:
type: array
description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. '
items:
allOf:
- $ref: "#/components/schemas/Tag"
- xml:
name: Tag
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBClusterEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: CreateDBClusterEndpoint
operationId: POST_CreateDBClusterEndpoint
description: Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateDBClusterParameterGroupResult" "480": description: DBParameterGroupQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupQuotaExceededFault" "481": description: DBParameterGroupAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupAlreadyExistsFault" parameters: - name: DBClusterParameterGroupName in: query required: true description: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.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora-mysql5.7, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql14
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres12
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mysql
postgres
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateDBClusterParameterGroupResult" "480": description: DBParameterGroupQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupQuotaExceededFault" "481": description: DBParameterGroupAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupAlreadyExistsFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateDBClusterParameterGroupMessage" parameters: - name: Action in: query required: true schema: type: string enum: - CreateDBClusterParameterGroup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=CreateDBClusterSnapshot: get: x-aws-operation-name: CreateDBClusterSnapshot operationId: GET_CreateDBClusterSnapshot description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateDBClusterSnapshotResult" "480": description: DBClusterSnapshotAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotAlreadyExistsFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "483": description: SnapshotQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/SnapshotQuotaExceededFault" "484": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" parameters: - name: DBClusterSnapshotIdentifier in: query required: true description: "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
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
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateDBClusterSnapshotResult" "480": description: DBClusterSnapshotAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotAlreadyExistsFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "483": description: SnapshotQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/SnapshotQuotaExceededFault" "484": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateDBClusterSnapshotMessage" parameters: - name: Action in: query required: true schema: type: string enum: - CreateDBClusterSnapshot - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=CreateDBInstance: get: x-aws-operation-name: CreateDBInstance operationId: GET_CreateDBInstance description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateDBInstanceResult" "480": description: DBInstanceAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAlreadyExistsFault" "481": description: InsufficientDBInstanceCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientDBInstanceCapacityFault" "482": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "483": description: DBSecurityGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSecurityGroupNotFoundFault" "484": description: InstanceQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/InstanceQuotaExceededFault" "485": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "486": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "487": description: DBSubnetGroupDoesNotCoverEnoughAZs content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupDoesNotCoverEnoughAZs" "488": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "489": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "490": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "491": description: ProvisionedIopsNotAvailableInAZFault content: text/xml: schema: $ref: "#/components/schemas/ProvisionedIopsNotAvailableInAZFault" "492": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "493": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "494": description: StorageTypeNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/StorageTypeNotSupportedFault" "495": description: AuthorizationNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/AuthorizationNotFoundFault" "496": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "497": description: DomainNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DomainNotFoundFault" "498": description: BackupPolicyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BackupPolicyNotFoundFault" "499": description: NetworkTypeNotSupported content: text/xml: schema: $ref: "#/components/schemas/NetworkTypeNotSupported" "500": description: CertificateNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CertificateNotFoundFault" parameters: - name: DBName in: query required: false description: "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 postgres is 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 value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL
Constraints:
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: ORCL
Constraints:
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 postgres is 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.
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
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.
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-mysql (for Aurora MySQL DB instances)
aurora-postgresql (for Aurora PostgreSQL DB instances)
custom-oracle-ee (for RDS Custom for Oracle DB instances)
custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
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.
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 ManageMasterUserPassword is 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.
" schema: type: string - name: DBSecurityGroups in: query required: false description:A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
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.
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: AvailabilityZone in: query required: false description: "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-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
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
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:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
' schema: type: string - name: DBParameterGroupName in: query required: false description: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.
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
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
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.
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
" schema: type: integer - name: MultiAZ in: query required: false description:A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
schema: type: boolean - name: EngineVersion in: query required: false description: 'The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions operation.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
Amazon 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.
' schema: type: string - name: AutoMinorVersionUpgrade in: query required: false description: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 AutoMinorVersionUpgrade to false.
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
" schema: type: string - name: Iops in: query required: false description: '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.
' schema: type: integer - name: OptionGroupName in: query required: false description: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.
schema: type: string - name: CharacterSetName in: query required: false description: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.
The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn't apply to RDS Custom.
schema: type: string - name: PubliclyAccessible in: query required: false description: "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 DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
The identifier of the DB cluster that the instance will belong to.
This setting doesn't apply to RDS Custom.
schema: type: string - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
" schema: type: string - name: TdeCredentialArn in: query required: false description: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.
schema: type: string - name: TdeCredentialPassword in: query required: false description:The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
schema: type: string - name: StorageEncrypted in: query required: false description: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 true or leave it unset. If you set this parameter to false, RDS reports an error.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
schema: type: boolean - name: KmsKeyId in: query required: false description: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 StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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.
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.
schema: type: string - name: CopyTagsToSnapshot in: query required: false description: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.
schema: type: boolean - name: MonitoringInterval in: query required: false description: "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 MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
schema: type: string - name: DomainIAMRoleName in: query required: false description: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.
schema: type: string - name: PromotionTier in: query required: false description: "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
" schema: type: integer - name: Timezone in: query required: false description: The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server. schema: type: string - name: EnableIAMDatabaseAuthentication in: query required: false description: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.
schema: type: boolean - name: EnablePerformanceInsights in: query required: false description: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.
schema: type: boolean - name: PerformanceInsightsKMSKeyId in: query required: false description: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.
schema: type: string - name: PerformanceInsightsRetentionPeriod in: query required: false description: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.
schema: type: integer - name: EnableCloudwatchLogsExports in: query required: false description: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, and slowquery.
Microsoft SQL Server
Possible values are agent and error.
MySQL
Possible values are audit, error, general, and slowquery.
Oracle
Possible values are alert, audit, listener, trace, and oemagent.
PostgreSQL
Possible values are postgresql and upgrade.
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.
schema: type: array items: allOf: - $ref: "#/components/schemas/ProcessorFeature" - xml: name: ProcessorFeature - name: DeletionProtection in: query required: false description: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.
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.
schema: type: integer - name: EnableCustomerOwnedIp in: query required: false description: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.
schema: type: boolean - name: CustomIamInstanceProfile in: query required: false description: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.
schema: type: string - name: BackupTarget in: query required: false description:Specifies where automated backups and manual snapshots are stored.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
schema: type: string - name: NetworkType in: query required: false description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
schema: type: string - name: StorageThroughput in: query required: false description:Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
schema: type: integer - name: ManageMasterUserPassword in: query required: false description: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 MasterUserPassword is specified.
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 the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
schema: type: string - name: CACertificateIdentifier in: query required: false description: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.
schema: type: string - name: Action in: query required: true schema: type: string enum: - CreateDBInstance - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateDBInstance operationId: POST_CreateDBInstance description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateDBInstanceResult" "480": description: DBInstanceAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAlreadyExistsFault" "481": description: InsufficientDBInstanceCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientDBInstanceCapacityFault" "482": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "483": description: DBSecurityGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSecurityGroupNotFoundFault" "484": description: InstanceQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/InstanceQuotaExceededFault" "485": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "486": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "487": description: DBSubnetGroupDoesNotCoverEnoughAZs content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupDoesNotCoverEnoughAZs" "488": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "489": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "490": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "491": description: ProvisionedIopsNotAvailableInAZFault content: text/xml: schema: $ref: "#/components/schemas/ProvisionedIopsNotAvailableInAZFault" "492": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "493": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "494": description: StorageTypeNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/StorageTypeNotSupportedFault" "495": description: AuthorizationNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/AuthorizationNotFoundFault" "496": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "497": description: DomainNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DomainNotFoundFault" "498": description: BackupPolicyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BackupPolicyNotFoundFault" "499": description: NetworkTypeNotSupported content: text/xml: schema: $ref: "#/components/schemas/NetworkTypeNotSupported" "500": description: CertificateNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CertificateNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateDBInstanceMessage" parameters: - name: Action in: query required: true schema: type: string enum: - CreateDBInstance - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=CreateDBInstanceReadReplica: get: x-aws-operation-name: CreateDBInstanceReadReplica operationId: GET_CreateDBInstanceReadReplica description:Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. 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 attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
Can't be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
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.
' schema: type: string - name: AvailabilityZone in: query required: false description: "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
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
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 is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom.
schema: type: boolean - name: AutoMinorVersionUpgrade in: query required: false description: "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
" schema: type: boolean - name: Iops in: query required: false description: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. schema: type: integer - name: OptionGroupName in: query required: false description:The option group the DB instance is associated with. If omitted, the option group associated with the source instance or cluster is used.
For SQL Server, you must use the option group associated with the source.
This setting doesn't apply to RDS Custom.
schema: type: string - name: DBParameterGroupName in: query required: false description: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 the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for 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
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.
schema: type: boolean - name: Tags in: query required: false description: "" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: DBSubnetGroupName in: query required: false description: "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:
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
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.
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the read replica.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
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 MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
schema: type: string - name: KmsKeyId in: query required: false description:The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
schema: type: string - name: PreSignedUrl in: query required: false description: "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
This setting applies only when replicating from a source DB instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
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.
schema: type: boolean - name: EnablePerformanceInsights in: query required: false description: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.
schema: type: boolean - name: PerformanceInsightsKMSKeyId in: query required: false description: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.
schema: type: string - name: PerformanceInsightsRetentionPeriod in: query required: false description: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.
schema: type: integer - name: EnableCloudwatchLogsExports in: query required: false description: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.
schema: type: array items: $ref: "#/components/schemas/String" - name: ProcessorFeatures in: query required: false description: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.
schema: type: array items: allOf: - $ref: "#/components/schemas/ProcessorFeature" - xml: name: ProcessorFeature - name: UseDefaultProcessorFeatures in: query required: false description: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.
schema: type: boolean - name: DeletionProtection in: query required: false description: 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. schema: type: boolean - name: Domain in: query required: false description: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.
schema: type: string - name: DomainIAMRoleName in: query required: false description: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.
schema: type: string - name: ReplicaMode in: query required: false description: "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.
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.
schema: type: integer - name: CustomIamInstanceProfile in: query required: false description: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.
schema: type: string - name: NetworkType in: query required: false description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
schema: type: string - name: StorageThroughput in: query required: false description:Specifies the storage throughput value for the read replica.
This setting doesn't apply to RDS Custom or Amazon Aurora.
schema: type: integer - name: EnableCustomerOwnedIp in: query required: false description: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.
schema: type: boolean - name: AllocatedStorage in: query required: false description: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.
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
Must be the identifier of an existing Multi-AZ DB cluster.
Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported.
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. 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 attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
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.
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.
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
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.
MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
schema:
type: string
enum:
- MYSQL
- POSTGRESQL
- SQLSERVER
- name: Auth
in: query
required: true
description: The authorization mechanism that the proxy uses.
schema:
type: array
items:
$ref: "#/components/schemas/UserAuthConfig"
- name: RoleArn
in: query
required: true
description: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
schema:
type: string
- name: VpcSubnetIds
in: query
required: true
description: One or more VPC subnet IDs to associate with the new proxy.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: VpcSecurityGroupIds
in: query
required: false
description: One or more VPC security group IDs to associate with the new proxy.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: RequireTLS
in: query
required: false
description: 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.
schema:
type: boolean
- name: IdleClientTimeout
in: query
required: false
description: 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.
schema:
type: integer
- name: DebugLogging
in: query
required: false
description: 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.
schema:
type: boolean
- name: Tags
in: query
required: false
description: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
schema:
type: array
description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. '
items:
allOf:
- $ref: "#/components/schemas/Tag"
- xml:
name: Tag
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBProxy
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: CreateDBProxy
operationId: POST_CreateDBProxy
description: Creates a new DB proxy.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBProxyResponse"
"480":
description: InvalidSubnet
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidSubnet"
"481":
description: DBProxyAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyAlreadyExistsFault"
"482":
description: DBProxyQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyQuotaExceededFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBProxyRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBProxy
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=CreateDBProxyEndpoint:
get:
x-aws-operation-name: CreateDBProxyEndpoint
operationId: GET_CreateDBProxyEndpoint
description: 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.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBProxyEndpointResponse"
"480":
description: InvalidSubnet
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidSubnet"
"481":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"482":
description: DBProxyEndpointAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointAlreadyExistsFault"
"483":
description: DBProxyEndpointQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointQuotaExceededFault"
"484":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
parameters:
- name: DBProxyName
in: query
required: true
description: The name of the DB proxy associated with the DB proxy endpoint that you create.
schema:
type: string
pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*"
minLength: 1
maxLength: 63
- name: DBProxyEndpointName
in: query
required: true
description: The name of the DB proxy endpoint to create.
schema:
type: string
pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*"
minLength: 1
maxLength: 63
- name: VpcSubnetIds
in: query
required: true
description: 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.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: VpcSecurityGroupIds
in: query
required: false
description: 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.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: TargetRole
in: query
required: false
description: 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 is READ_WRITE.
schema:
type: string
enum:
- READ_WRITE
- READ_ONLY
- name: Tags
in: query
required: false
description: ""
schema:
type: array
description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. '
items:
allOf:
- $ref: "#/components/schemas/Tag"
- xml:
name: Tag
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBProxyEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: CreateDBProxyEndpoint
operationId: POST_CreateDBProxyEndpoint
description: 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.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBProxyEndpointResponse"
"480":
description: InvalidSubnet
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidSubnet"
"481":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"482":
description: DBProxyEndpointAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointAlreadyExistsFault"
"483":
description: DBProxyEndpointQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointQuotaExceededFault"
"484":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBProxyEndpointRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBProxyEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=CreateDBSecurityGroup:
get:
x-aws-operation-name: CreateDBSecurityGroup
operationId: GET_CreateDBSecurityGroup
description: 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.
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
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.
available or storage-optimization state.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBSnapshotResult"
"480":
description: DBSnapshotAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBSnapshotAlreadyExistsFault"
"481":
description: InvalidDBInstanceStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceStateFault"
"482":
description: DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceNotFoundFault"
"483":
description: SnapshotQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/SnapshotQuotaExceededFault"
parameters:
- name: DBSnapshotIdentifier
in: query
required: true
description: "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
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
available or storage-optimization state.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBSnapshotResult"
"480":
description: DBSnapshotAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBSnapshotAlreadyExistsFault"
"481":
description: InvalidDBInstanceStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceStateFault"
"482":
description: DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceNotFoundFault"
"483":
description: SnapshotQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/SnapshotQuotaExceededFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBSnapshotMessage"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBSnapshot
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=CreateDBSubnetGroup:
get:
x-aws-operation-name: CreateDBSubnetGroup
operationId: GET_CreateDBSubnetGroup
description: 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.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/CreateDBSubnetGroupResult"
"480":
description: DBSubnetGroupAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBSubnetGroupAlreadyExistsFault"
"481":
description: DBSubnetGroupQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBSubnetGroupQuotaExceededFault"
"482":
description: DBSubnetQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBSubnetQuotaExceededFault"
"483":
description: DBSubnetGroupDoesNotCoverEnoughAZs
content:
text/xml:
schema:
$ref: "#/components/schemas/DBSubnetGroupDoesNotCoverEnoughAZs"
"484":
description: InvalidSubnet
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidSubnet"
parameters:
- name: DBSubnetGroupName
in: query
required: true
description: "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
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateEventSubscriptionResult" "480": description: EventSubscriptionQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/EventSubscriptionQuotaExceededFault" "481": description: SubscriptionAlreadyExistFault content: text/xml: schema: $ref: "#/components/schemas/SubscriptionAlreadyExistFault" "482": description: SNSInvalidTopicFault content: text/xml: schema: $ref: "#/components/schemas/SNSInvalidTopicFault" "483": description: SNSNoAuthorizationFault content: text/xml: schema: $ref: "#/components/schemas/SNSNoAuthorizationFault" "484": description: SNSTopicArnNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/SNSTopicArnNotFoundFault" "485": description: SubscriptionCategoryNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/SubscriptionCategoryNotFoundFault" "486": description: SourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/SourceNotFoundFault" parameters: - name: SubscriptionName in: query required: true description: "The name of the subscription.
Constraints: The name must be less than 255 characters.
" schema: type: string - name: SnsTopicArn in: query required: true description: 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. schema: type: string - name: SourceType in: query required: false description: "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, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
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 the DescribeEventCategories operation.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/String"
- xml:
name: EventCategory
- name: SourceIds
in: query
required: false
description: The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateEventSubscriptionResult" "480": description: EventSubscriptionQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/EventSubscriptionQuotaExceededFault" "481": description: SubscriptionAlreadyExistFault content: text/xml: schema: $ref: "#/components/schemas/SubscriptionAlreadyExistFault" "482": description: SNSInvalidTopicFault content: text/xml: schema: $ref: "#/components/schemas/SNSInvalidTopicFault" "483": description: SNSNoAuthorizationFault content: text/xml: schema: $ref: "#/components/schemas/SNSNoAuthorizationFault" "484": description: SNSTopicArnNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/SNSTopicArnNotFoundFault" "485": description: SubscriptionCategoryNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/SubscriptionCategoryNotFoundFault" "486": description: SourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/SourceNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateEventSubscriptionMessage" parameters: - name: Action in: query required: true schema: type: string enum: - CreateEventSubscription - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=CreateGlobalCluster: get: x-aws-operation-name: CreateGlobalCluster operationId: GET_CreateGlobalCluster description: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.
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.
Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateOptionGroupResult" "480": description: OptionGroupAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupAlreadyExistsFault" "481": description: OptionGroupQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupQuotaExceededFault" parameters: - name: OptionGroupName in: query required: true description: "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
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
Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateOptionGroupResult" "480": description: OptionGroupAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupAlreadyExistsFault" "481": description: OptionGroupQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupQuotaExceededFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateOptionGroupMessage" parameters: - name: Action in: query required: true schema: type: string enum: - CreateOptionGroup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DeleteBlueGreenDeployment: get: x-aws-operation-name: DeleteBlueGreenDeployment operationId: GET_DeleteBlueGreenDeployment description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteBlueGreenDeploymentResponse" "480": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" "481": description: InvalidBlueGreenDeploymentStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidBlueGreenDeploymentStateFault" parameters: - name: BlueGreenDeploymentIdentifier in: query required: true description: "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.
SWITCHOVER_COMPLETED.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteBlueGreenDeployment
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DeleteBlueGreenDeployment
operationId: POST_DeleteBlueGreenDeployment
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteBlueGreenDeploymentResponse" "480": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" "481": description: InvalidBlueGreenDeploymentStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidBlueGreenDeploymentStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteBlueGreenDeploymentRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteBlueGreenDeployment - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DeleteCustomDBEngineVersion: get: x-aws-operation-name: DeleteCustomDBEngineVersion operationId: GET_DeleteCustomDBEngineVersion description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBEngineVersion" "480": description: CustomDBEngineVersionNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CustomDBEngineVersionNotFoundFault" "481": description: InvalidCustomDBEngineVersionStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidCustomDBEngineVersionStateFault" parameters: - name: Engine in: query required: true description: The database engine. The only supported engines arecustom-oracle-ee and custom-oracle-ee-cdb.
schema:
type: string
pattern: ^[A-Za-z0-9-]{1,35}$
minLength: 1
maxLength: 35
- name: EngineVersion
in: query
required: true
description: The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
schema:
type: string
pattern: ^[a-z0-9_.-]{1,60}$
minLength: 1
maxLength: 60
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCustomDBEngineVersion
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DeleteCustomDBEngineVersion
operationId: POST_DeleteCustomDBEngineVersion
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBEngineVersion" "480": description: CustomDBEngineVersionNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CustomDBEngineVersionNotFoundFault" "481": description: InvalidCustomDBEngineVersionStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidCustomDBEngineVersionStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteCustomDBEngineVersionMessage" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteCustomDBEngineVersion - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DeleteDBCluster: get: x-aws-operation-name: DeleteDBCluster operationId: GET_DeleteDBCluster description:The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteDBClusterResult" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: DBClusterSnapshotAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotAlreadyExistsFault" "483": description: SnapshotQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/SnapshotQuotaExceededFault" "484": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" parameters: - name: DBClusterIdentifier in: query required: true description:The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
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 FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.
Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter 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
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteDBClusterResult" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: DBClusterSnapshotAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotAlreadyExistsFault" "483": description: SnapshotQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/SnapshotQuotaExceededFault" "484": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteDBClusterMessage" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteDBCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DeleteDBClusterEndpoint: get: x-aws-operation-name: DeleteDBClusterEndpoint operationId: GET_DeleteDBClusterEndpoint description:Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
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.
responses: "200": description: Success "480": description: InvalidDBParameterGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBParameterGroupStateFault" "481": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" parameters: - name: DBClusterParameterGroupName in: query required: true description:The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You can't delete a default DB cluster parameter group.
Can't be associated with any DB clusters.
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.
responses: "200": description: Success "480": description: InvalidDBParameterGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBParameterGroupStateFault" "481": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteDBClusterParameterGroupMessage" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteDBClusterParameterGroup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DeleteDBClusterSnapshot: get: x-aws-operation-name: DeleteDBClusterSnapshot operationId: GET_DeleteDBClusterSnapshot description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteDBClusterSnapshotResult" "480": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" "481": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" parameters: - name: DBClusterSnapshotIdentifier in: query required: true description: "The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteDBClusterSnapshotResult" "480": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" "481": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteDBClusterSnapshotMessage" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteDBClusterSnapshot - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DeleteDBInstance: get: x-aws-operation-name: DeleteDBInstance operationId: GET_DeleteDBInstance description: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.
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.
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 FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-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.
schema: type: boolean - name: FinalDBSnapshotIdentifier in: query required: false description:The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn't apply to RDS Custom.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Can't be specified when deleting a read replica.
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.
DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DeleteDBInstanceAutomatedBackupResult"
"480":
description: InvalidDBInstanceAutomatedBackupStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceAutomatedBackupStateFault"
"481":
description: DBInstanceAutomatedBackupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceAutomatedBackupNotFoundFault"
parameters:
- name: DbiResourceId
in: query
required: false
description: The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
schema:
type: string
- name: DBInstanceAutomatedBackupsArn
in: query
required: false
description: 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.
schema: type: string - name: Action in: query required: true schema: type: string enum: - DeleteDBInstanceAutomatedBackup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteDBInstanceAutomatedBackup operationId: POST_DeleteDBInstanceAutomatedBackup description: Deletes automated backups using theDbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DeleteDBInstanceAutomatedBackupResult"
"480":
description: InvalidDBInstanceAutomatedBackupStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceAutomatedBackupStateFault"
"481":
description: DBInstanceAutomatedBackupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceAutomatedBackupNotFoundFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DeleteDBInstanceAutomatedBackupMessage"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteDBInstanceAutomatedBackup
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DeleteDBParameterGroup:
get:
x-aws-operation-name: DeleteDBParameterGroup
operationId: GET_DeleteDBParameterGroup
description: Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
responses:
"200":
description: Success
"480":
description: InvalidDBParameterGroupStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBParameterGroupStateFault"
"481":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
parameters:
- name: DBParameterGroupName
in: query
required: true
description: The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Can't be associated with any DB instances
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.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DeleteDBProxyEndpointResponse"
"480":
description: DBProxyEndpointNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointNotFoundFault"
"481":
description: InvalidDBProxyEndpointStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyEndpointStateFault"
parameters:
- name: DBProxyEndpointName
in: query
required: true
description: The name of the DB proxy endpoint to delete.
schema:
type: string
pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*"
minLength: 1
maxLength: 63
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteDBProxyEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DeleteDBProxyEndpoint
operationId: POST_DeleteDBProxyEndpoint
description: 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.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DeleteDBProxyEndpointResponse"
"480":
description: DBProxyEndpointNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointNotFoundFault"
"481":
description: InvalidDBProxyEndpointStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyEndpointStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DeleteDBProxyEndpointRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteDBProxyEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DeleteDBSecurityGroup:
get:
x-aws-operation-name: DeleteDBSecurityGroup
operationId: GET_DeleteDBSecurityGroup
description: 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.
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"
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.
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.
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
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.
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
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.
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.
The name of the option group to be deleted.
You can't delete default option groups.
DBProxyTarget data structures and a DBProxyTargetGroup.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DeregisterDBProxyTargetsResponse"
"480":
description: DBProxyTargetNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetNotFoundFault"
"481":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"482":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"483":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
parameters:
- name: DBProxyName
in: query
required: true
description: The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
schema:
type: string
- name: TargetGroupName
in: query
required: false
description: The identifier of the DBProxyTargetGroup.
schema:
type: string
- name: DBInstanceIdentifiers
in: query
required: false
description: One or more DB instance identifiers.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: DBClusterIdentifiers
in: query
required: false
description: One or more DB cluster identifiers.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterDBProxyTargets
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DeregisterDBProxyTargets
operationId: POST_DeregisterDBProxyTargets
description: Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DeregisterDBProxyTargetsResponse"
"480":
description: DBProxyTargetNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetNotFoundFault"
"481":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"482":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"483":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DeregisterDBProxyTargetsRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterDBProxyTargets
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeAccountAttributes:
get:
x-aws-operation-name: DescribeAccountAttributes
operationId: GET_DescribeAccountAttributes
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AccountAttributesMessage" parameters: - name: Action in: query required: true schema: type: string enum: - DescribeAccountAttributes - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeAccountAttributes operationId: POST_DescribeAccountAttributes description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AccountAttributesMessage" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeAccountAttributesMessage" parameters: - name: Action in: query required: true schema: type: string enum: - DescribeAccountAttributes - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeBlueGreenDeployments: get: x-aws-operation-name: DescribeBlueGreenDeployments operationId: GET_DescribeBlueGreenDeployments description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeBlueGreenDeploymentsResponse" "480": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" parameters: - name: BlueGreenDeploymentIdentifier in: query required: false description: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.
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.
DescribeBlueGreenDeployments request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer minimum: 20 maximum: 100 - name: Action in: query required: true schema: type: string enum: - DescribeBlueGreenDeployments - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeBlueGreenDeployments operationId: POST_DescribeBlueGreenDeployments description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeBlueGreenDeploymentsResponse" "480": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeBlueGreenDeploymentsRequest" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeBlueGreenDeployments - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeCertificates: get: x-aws-operation-name: DescribeCertificates operationId: GET_DescribeCertificates description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CertificateMessage" "480": description: CertificateNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CertificateNotFoundFault" parameters: - name: CertificateIdentifier in: query required: false description: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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCertificates
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeCertificates
operationId: POST_DescribeCertificates
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CertificateMessage" "480": description: CertificateNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CertificateNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeCertificatesMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeCertificates - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBClusterBacktracks: get: x-aws-operation-name: DescribeDBClusterBacktracks operationId: GET_DescribeDBClusterBacktracks description: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.
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
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
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBClusterBacktracks
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBClusterBacktracks
operationId: POST_DescribeDBClusterBacktracks
description: 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.
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying."
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Filter"
- xml:
name: Filter
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBClusterEndpoints
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBClusterEndpoints
operationId: POST_DescribeDBClusterEndpoints
description: Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupsMessage" "480": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" parameters: - name: DBClusterParameterGroupName in: query required: false description:The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBClusterParameterGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBClusterParameterGroups
operationId: POST_DescribeDBClusterParameterGroups
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupsMessage" "480": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBClusterParameterGroupsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBClusterParameterGroups - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBClusterParameters: get: x-aws-operation-name: DescribeDBClusterParameters operationId: GET_DescribeDBClusterParameters description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupDetails" "480": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" parameters: - name: DBClusterParameterGroupName in: query required: true description: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.
engine, service, or customer.
schema:
type: string
- name: Filters
in: query
required: false
description: This parameter isn't currently supported.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Filter"
- xml:
name: Filter
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBClusterParameters
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBClusterParameters
operationId: POST_DescribeDBClusterParameters
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupDetails" "480": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBClusterParametersMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBClusterParameters - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBClusterSnapshotAttributes: get: x-aws-operation-name: DescribeDBClusterSnapshotAttributes operationId: GET_DescribeDBClusterSnapshotAttributes description: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.
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.
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotMessage" "480": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" parameters: - name: DBClusterIdentifier in: query required: false description:The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: IncludeShared
in: query
required: false
description: 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 ModifyDBClusterSnapshotAttribute API action.
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.
schema: type: boolean - name: Action in: query required: true schema: type: string enum: - DescribeDBClusterSnapshots - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeDBClusterSnapshots operationId: POST_DescribeDBClusterSnapshots description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotMessage" "480": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBClusterSnapshotsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBClusterSnapshots - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBClusters: get: x-aws-operation-name: DescribeDBClusters operationId: GET_DescribeDBClusters description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterMessage" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" parameters: - name: DBClusterIdentifier in: query required: false description: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.
A filter that specifies one or more DB clusters to describe.
Supported filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: IncludeShared
in: query
required: false
description: Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBClusters
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBClusters
operationId: POST_DescribeDBClusters
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterMessage" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBClustersMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBClusters - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBEngineVersions: get: x-aws-operation-name: DescribeDBEngineVersions operationId: GET_DescribeDBEngineVersions description: Returns a list of the available DB engines. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBEngineVersionMessage" parameters: - name: Engine in: query required: false description:The database engine to return.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
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
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: 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 byMaxRecords.
schema:
type: string
- name: DefaultOnly
in: query
required: false
description: A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
schema:
type: boolean
- name: ListSupportedCharacterSets
in: query
required: false
description: 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 CharacterSetName parameter for CreateDBInstance, 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 ListSupportedCharacterSets to true, RDS Custom returns no results.
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 TimeZone parameter for CreateDBInstance, 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 ListSupportedTimezones to true, RDS Custom returns no results.
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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAutomatedBackupMessage" "480": description: DBInstanceAutomatedBackupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAutomatedBackupNotFoundFault" parameters: - name: DbiResourceId in: query required: false description: The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive. schema: type: string - name: DBInstanceIdentifier in: query required: false description: (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. schema: type: string - name: Filters in: query required: false description: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.
schema: type: array items: allOf: - $ref: "#/components/schemas/Filter" - xml: name: Filter - name: MaxRecords in: query required: false description: The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
schema:
type: integer
- name: Marker
in: query
required: false
description: The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
schema:
type: string
- name: DBInstanceAutomatedBackupsArn
in: query
required: false
description: 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.
schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeDBInstanceAutomatedBackups - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeDBInstanceAutomatedBackups operationId: POST_DescribeDBInstanceAutomatedBackups description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAutomatedBackupMessage" "480": description: DBInstanceAutomatedBackupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAutomatedBackupNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBInstanceAutomatedBackupsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBInstanceAutomatedBackups - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBInstances: get: x-aws-operation-name: DescribeDBInstances operationId: GET_DescribeDBInstances description: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.
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.
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBInstances
operationId: POST_DescribeDBInstances
description: 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.
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeDBLogFilesResponse" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" parameters: - name: DBInstanceIdentifier in: query required: true description: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.
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeDBLogFilesResponse" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBLogFilesMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBLogFiles - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBParameterGroups: get: x-aws-operation-name: DescribeDBParameterGroups operationId: GET_DescribeDBParameterGroups description: Returns a list ofDBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupsMessage"
"480":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
parameters:
- name: DBParameterGroupName
in: query
required: false
description: The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBParameterGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBParameterGroups
operationId: POST_DescribeDBParameterGroups
description: Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupsMessage"
"480":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBParameterGroupsMessage"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBParameterGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeDBParameters:
get:
x-aws-operation-name: DescribeDBParameters
operationId: GET_DescribeDBParameters
description: Returns the detailed parameter list for a particular DB parameter group.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupDetails"
"480":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
parameters:
- name: DBParameterGroupName
in: query
required: true
description: The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBParameters
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBParameters
operationId: POST_DescribeDBParameters
description: Returns the detailed parameter list for a particular DB parameter group.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupDetails"
"480":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBParametersMessage"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBParameters
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeDBProxies:
get:
x-aws-operation-name: DescribeDBProxies
operationId: GET_DescribeDBProxies
description: Returns information about DB proxies.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBProxiesResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
parameters:
- name: DBProxyName
in: query
required: false
description: 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.
schema:
type: string
- name: Filters
in: query
required: false
description: This parameter is not currently supported.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Filter"
- xml:
name: Filter
- name: Marker
in: query
required: false
description: 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.
schema:
type: string
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer minimum: 20 maximum: 100 - name: Action in: query required: true schema: type: string enum: - DescribeDBProxies - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeDBProxies operationId: POST_DescribeDBProxies description: Returns information about DB proxies. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeDBProxiesResponse" "480": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBProxiesRequest" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBProxies - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBProxyEndpoints: get: x-aws-operation-name: DescribeDBProxyEndpoints operationId: GET_DescribeDBProxyEndpoints description: Returns information about DB proxy endpoints. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeDBProxyEndpointsResponse" "480": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" "481": description: DBProxyEndpointNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyEndpointNotFoundFault" parameters: - name: DBProxyName in: query required: false description: 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. schema: type: string pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" minLength: 1 maxLength: 63 - name: DBProxyEndpointName in: query required: false description: 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. schema: type: string pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" minLength: 1 maxLength: 63 - name: Filters in: query required: false description: This parameter is not currently supported. schema: type: array items: allOf: - $ref: "#/components/schemas/Filter" - xml: name: Filter - name: Marker in: query required: false description: 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 byMaxRecords.
schema:
type: string
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer minimum: 20 maximum: 100 - name: Action in: query required: true schema: type: string enum: - DescribeDBProxyEndpoints - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeDBProxyEndpoints operationId: POST_DescribeDBProxyEndpoints description: Returns information about DB proxy endpoints. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeDBProxyEndpointsResponse" "480": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" "481": description: DBProxyEndpointNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyEndpointNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBProxyEndpointsRequest" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBProxyEndpoints - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBProxyTargetGroups: get: x-aws-operation-name: DescribeDBProxyTargetGroups operationId: GET_DescribeDBProxyTargetGroups description: Returns information about DB proxy target groups, represented byDBProxyTargetGroup data structures.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBProxyTargetGroupsResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"482":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
parameters:
- name: DBProxyName
in: query
required: true
description: The identifier of the DBProxy associated with the target group.
schema:
type: string
- name: TargetGroupName
in: query
required: false
description: The identifier of the DBProxyTargetGroup to describe.
schema:
type: string
- name: Filters
in: query
required: false
description: This parameter is not currently supported.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Filter"
- xml:
name: Filter
- name: Marker
in: query
required: false
description: 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.
schema:
type: string
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer minimum: 20 maximum: 100 - name: Action in: query required: true schema: type: string enum: - DescribeDBProxyTargetGroups - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeDBProxyTargetGroups operationId: POST_DescribeDBProxyTargetGroups description: Returns information about DB proxy target groups, represented byDBProxyTargetGroup data structures.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBProxyTargetGroupsResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"482":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBProxyTargetGroupsRequest"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBProxyTargetGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeDBProxyTargets:
get:
x-aws-operation-name: DescribeDBProxyTargets
operationId: GET_DescribeDBProxyTargets
description: Returns information about DBProxyTarget objects. This API supports pagination.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBProxyTargetsResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyTargetNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetNotFoundFault"
"482":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"483":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
parameters:
- name: DBProxyName
in: query
required: true
description: The identifier of the DBProxyTarget to describe.
schema:
type: string
- name: TargetGroupName
in: query
required: false
description: The identifier of the DBProxyTargetGroup to describe.
schema:
type: string
- name: Filters
in: query
required: false
description: This parameter is not currently supported.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Filter"
- xml:
name: Filter
- name: Marker
in: query
required: false
description: 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.
schema:
type: string
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer minimum: 20 maximum: 100 - name: Action in: query required: true schema: type: string enum: - DescribeDBProxyTargets - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeDBProxyTargets operationId: POST_DescribeDBProxyTargets description: Returns information aboutDBProxyTarget objects. This API supports pagination.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBProxyTargetsResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyTargetNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetNotFoundFault"
"482":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"483":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeDBProxyTargetsRequest"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBProxyTargets
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeDBSecurityGroups:
get:
x-aws-operation-name: DescribeDBSecurityGroups
operationId: GET_DescribeDBSecurityGroups
description: 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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBSecurityGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBSecurityGroups
operationId: POST_DescribeDBSecurityGroups
description: 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.
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.
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.
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.
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The awsbackup type does not apply to Aurora.
If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: IncludeShared
in: query
required: false
description: 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 ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
schema: type: boolean - name: IncludePublic in: query required: false description: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.
schema: type: boolean - name: DbiResourceId in: query required: false description: A specific DB resource ID to describe. schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeDBSnapshots - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeDBSnapshots operationId: POST_DescribeDBSnapshots description: Returns information about DB snapshots. This API action supports pagination. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotMessage" "480": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBSnapshotsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBSnapshots - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeDBSubnetGroups: get: x-aws-operation-name: DescribeDBSubnetGroups operationId: GET_DescribeDBSubnetGroups description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupMessage" "480": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" parameters: - name: DBSubnetGroupName in: query required: false description: The name of the DB subnet group to return details for. schema: type: string - name: Filters in: query required: false description: This parameter isn't currently supported. schema: type: array items: allOf: - $ref: "#/components/schemas/Filter" - xml: name: Filter - name: MaxRecords in: query required: false description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: 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 byMaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBSubnetGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeDBSubnetGroups
operationId: POST_DescribeDBSubnetGroups
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupMessage" "480": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeDBSubnetGroupsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDBSubnetGroups - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeEngineDefaultClusterParameters: get: x-aws-operation-name: DescribeEngineDefaultClusterParameters operationId: GET_DescribeEngineDefaultClusterParameters description: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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeEngineDefaultClusterParametersResult" parameters: - name: DBParameterGroupFamily in: query required: true description: The name of the DB cluster parameter group family to return engine parameter information for. schema: type: string - name: Filters in: query required: false description: This parameter isn't currently supported. schema: type: array items: allOf: - $ref: "#/components/schemas/Filter" - xml: name: Filter - name: MaxRecords in: query required: false description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeEngineDefaultClusterParameters
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeEngineDefaultClusterParameters
operationId: POST_DescribeEngineDefaultClusterParameters
description: 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.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeEngineDefaultClusterParametersResult" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeEngineDefaultClusterParametersMessage" parameters: - name: Action in: query required: true schema: type: string enum: - DescribeEngineDefaultClusterParameters - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeEngineDefaultParameters: get: x-aws-operation-name: DescribeEngineDefaultParameters operationId: GET_DescribeEngineDefaultParameters description: Returns the default engine and system parameter information for the specified database engine. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeEngineDefaultParametersResult" parameters: - name: DBParameterGroupFamily in: query required: true description:The name of the DB parameter group family.
Valid Values:
aurora-mysql5.7
aurora-mysql8.0
aurora-postgresql10
aurora-postgresql11
aurora-postgresql12
aurora-postgresql13
aurora-postgresql14
custom-oracle-ee-19
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
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeEngineDefaultParameters
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeEngineDefaultParameters
operationId: POST_DescribeEngineDefaultParameters
description: Returns the default engine and system parameter information for the specified database engine.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeEngineDefaultParametersResult"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeEngineDefaultParametersMessage"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeEngineDefaultParameters
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeEventCategories:
get:
x-aws-operation-name: DescribeEventCategories
operationId: GET_DescribeEventCategories
description: 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 .
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/EventCategoriesMessage"
parameters:
- name: SourceType
in: query
required: false
description: "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
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: 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 byMaxRecords .
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeEventSubscriptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeEventSubscriptions
operationId: POST_DescribeEventSubscriptions
description: 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.
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.
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.
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
' schema: type: string format: date-time - name: EndTime in: query required: false description: '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
' schema: type: string format: date-time - name: Duration in: query required: false description: "The number of minutes to retrieve events for.
Default: 60
" schema: type: integer - name: EventCategories in: query required: false description: A list of event categories that trigger notifications for a event notification subscription. schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: EventCategory - name: Filters in: query required: false description: This parameter isn't currently supported. schema: type: array items: allOf: - $ref: "#/components/schemas/Filter" - xml: name: Filter - name: MaxRecords in: query required: false description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: 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 byMaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeEvents
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeEvents
operationId: POST_DescribeEvents
description: 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.
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
DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
schema:
type: string
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer minimum: 20 maximum: 100 - name: SourceType in: query required: false description: The type of source for the export. schema: type: string enum: - SNAPSHOT - CLUSTER - name: Action in: query required: true schema: type: string enum: - DescribeExportTasks - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeExportTasks operationId: POST_DescribeExportTasks description: Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ExportTasksMessage" "480": description: ExportTaskNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ExportTaskNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeExportTasksMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeExportTasks - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeGlobalClusters: get: x-aws-operation-name: DescribeGlobalClusters operationId: GET_DescribeGlobalClusters description: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.
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeGlobalClusters
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeGlobalClusters
operationId: POST_DescribeGlobalClusters
description: 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.
A required parameter. Options available for the given engine name are described.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: 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 byMaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeOptionGroupOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeOptionGroupOptions
operationId: POST_DescribeOptionGroupOptions
description: Describes all available options.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/OptionGroupOptionsMessage"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeOptionGroupOptionsMessage"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeOptionGroupOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeOptionGroups:
get:
x-aws-operation-name: DescribeOptionGroups
operationId: GET_DescribeOptionGroups
description: Describes the available option groups.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/OptionGroups"
"480":
description: OptionGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/OptionGroupNotFoundFault"
parameters:
- name: OptionGroupName
in: query
required: false
description: The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
schema:
type: string
- name: Filters
in: query
required: false
description: This parameter isn't currently supported.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Filter"
- xml:
name: Filter
- name: Marker
in: query
required: false
description: An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: EngineName in: query required: false description:Filters the list of option groups to only include groups associated with a specific database engine.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name of the engine to retrieve DB instance options for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
RDS Custom supports only the BYOL licensing model.
schema: type: string - name: AvailabilityZoneGroup in: query required: false description:The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
schema: type: string - name: Vpc in: query required: false description:A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
schema: type: boolean - name: Filters in: query required: false description: This parameter isn't currently supported. schema: type: array items: allOf: - $ref: "#/components/schemas/Filter" - xml: name: Filter - name: MaxRecords in: query required: false description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 10000.
" schema: type: integer - name: Marker in: query required: false description: 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 byMaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeOrderableDBInstanceOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeOrderableDBInstanceOptions
operationId: POST_DescribeOrderableDBInstanceOptions
description: Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/OrderableDBInstanceOptionsMessage"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeOrderableDBInstanceOptionsMessage"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeOrderableDBInstanceOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribePendingMaintenanceActions:
get:
x-aws-operation-name: DescribePendingMaintenanceActions
operationId: GET_DescribePendingMaintenanceActions
description: Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/PendingMaintenanceActionsMessage"
"480":
description: ResourceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceNotFoundFault"
parameters:
- name: ResourceIdentifier
in: query
required: false
description: The ARN of a resource to return pending maintenance actions for.
schema:
type: string
- name: Filters
in: query
required: false
description: A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
schema:
type: string
- name: MaxRecords
in: query
required: false
description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Action in: query required: true schema: type: string enum: - DescribePendingMaintenanceActions - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribePendingMaintenanceActions operationId: POST_DescribePendingMaintenanceActions description: Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/PendingMaintenanceActionsMessage" "480": description: ResourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribePendingMaintenanceActionsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribePendingMaintenanceActions - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DescribeReservedDBInstances: get: x-aws-operation-name: DescribeReservedDBInstances operationId: GET_DescribeReservedDBInstances description: Returns information about reserved DB instances for this account, or about a specified reserved DB instance. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ReservedDBInstanceMessage" "480": description: ReservedDBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ReservedDBInstanceNotFoundFault" parameters: - name: ReservedDBInstanceId in: query required: false description: The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. schema: type: string - name: ReservedDBInstancesOfferingId in: query required: false description: The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. schema: type: string - name: DBInstanceClass in: query required: false description: The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class. schema: type: string - name: Duration in: query required: false description: "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: 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 byMaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeReservedDBInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeReservedDBInstances
operationId: POST_DescribeReservedDBInstances
description: Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ReservedDBInstanceMessage"
"480":
description: ReservedDBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ReservedDBInstanceNotFoundFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeReservedDBInstancesMessage"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeReservedDBInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeReservedDBInstancesOfferings:
get:
x-aws-operation-name: DescribeReservedDBInstancesOfferings
operationId: GET_DescribeReservedDBInstancesOfferings
description: Lists available reserved DB instance offerings.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ReservedDBInstancesOfferingMessage"
"480":
description: ReservedDBInstancesOfferingNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ReservedDBInstancesOfferingNotFoundFault"
parameters:
- name: ReservedDBInstancesOfferingId
in: query
required: false
description: "The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: 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 byMaxRecords.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeReservedDBInstancesOfferings
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeReservedDBInstancesOfferings
operationId: POST_DescribeReservedDBInstancesOfferings
description: Lists available reserved DB instance offerings.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ReservedDBInstancesOfferingMessage"
"480":
description: ReservedDBInstancesOfferingNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ReservedDBInstancesOfferingNotFoundFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeReservedDBInstancesOfferingsMessage"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeReservedDBInstancesOfferings
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=DescribeSourceRegions:
get:
x-aws-operation-name: DescribeSourceRegions
operationId: GET_DescribeSourceRegions
description: Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.
The source Amazon Web Services Region name. For example, us-east-1.
Constraints:
Must specify a valid Amazon Web Services Region name.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" schema: type: integer - name: Marker in: query required: false description: An optional pagination token provided by a previousDescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
schema:
type: string
- name: Filters
in: query
required: false
description: This parameter isn't currently supported.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Filter"
- xml:
name: Filter
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSourceRegions
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeSourceRegions
operationId: POST_DescribeSourceRegions
description: Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeValidDBInstanceModificationsResult" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" parameters: - name: DBInstanceIdentifier in: query required: true description: The customer identifier or the ARN of your DB instance. schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeValidDBInstanceModifications - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeValidDBInstanceModifications operationId: POST_DescribeValidDBInstanceModifications description:You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeValidDBInstanceModificationsResult" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeValidDBInstanceModificationsMessage" parameters: - name: Action in: query required: true schema: type: string enum: - DescribeValidDBInstanceModifications - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=DownloadDBLogFilePortion: get: x-aws-operation-name: DownloadDBLogFilePortion operationId: GET_DownloadDBLogFilePortion description:Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DownloadDBLogFilePortionDetails" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBLogFileNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBLogFileNotFoundFault" parameters: - name: DBInstanceIdentifier in: query required: true description: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.
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DownloadDBLogFilePortionDetails" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBLogFileNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBLogFileNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DownloadDBLogFilePortionMessage" parameters: - name: NumberOfLines in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DownloadDBLogFilePortion - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=FailoverDBCluster: get: x-aws-operation-name: FailoverDBCluster operationId: GET_FailoverDBCluster description:Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/FailoverDBClusterResult" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" parameters: - name: DBClusterIdentifier in: query required: true description:A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
schema: type: string - name: Action in: query required: true schema: type: string enum: - FailoverDBCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: FailoverDBCluster operationId: POST_FailoverDBCluster description:Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/FailoverDBClusterResult" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/FailoverDBClusterMessage" parameters: - name: Action in: query required: true schema: type: string enum: - FailoverDBCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=FailoverGlobalCluster: get: x-aws-operation-name: FailoverGlobalCluster operationId: GET_FailoverGlobalCluster description:Initiates the failover process for an Aurora global database (GlobalCluster).
A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.
For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.
This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.
Identifier of the Aurora global database (GlobalCluster) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.
Constraints:
Must match the identifier of an existing GlobalCluster (Aurora global database).
Initiates the failover process for an Aurora global database (GlobalCluster).
A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.
For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.
This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/TagListMessage" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "482": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "483": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" "484": description: DBProxyTargetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault" "485": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" parameters: - name: ResourceName in: query required: true description: The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. schema: type: string - name: Filters in: query required: false description: This parameter isn't currently supported. schema: type: array items: allOf: - $ref: "#/components/schemas/Filter" - xml: name: Filter - name: Action in: query required: true schema: type: string enum: - ListTagsForResource - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ListTagsForResource operationId: POST_ListTagsForResource description:Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/TagListMessage" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "482": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "483": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" "484": description: DBProxyTargetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault" "485": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ListTagsForResourceMessage" parameters: - name: Action in: query required: true schema: type: string enum: - ListTagsForResource - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ModifyActivityStream: get: x-aws-operation-name: ModifyActivityStream operationId: GET_ModifyActivityStream description:Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyActivityStreamResponse" "480": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "481": description: ResourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" parameters: - name: ResourceArn in: query required: false description: The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example,arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.
schema:
type: string
- name: AuditPolicyState
in: query
required: false
description: The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
schema:
type: string
enum:
- locked
- unlocked
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyActivityStream
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: ModifyActivityStream
operationId: POST_ModifyActivityStream
description: Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyActivityStreamResponse" "480": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "481": description: ResourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ModifyActivityStreamRequest" parameters: - name: Action in: query required: true schema: type: string enum: - ModifyActivityStream - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ModifyCertificates: get: x-aws-operation-name: ModifyCertificates operationId: GET_ModifyCertificates description:Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyCertificatesResult" "480": description: CertificateNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CertificateNotFoundFault" parameters: - name: CertificateIdentifier in: query required: false description:The new default certificate identifier to override the current one with.
To determine the valid values, use the describe-certificates CLI command or the DescribeCertificates API operation.
Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyCertificatesResult" "480": description: CertificateNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CertificateNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ModifyCertificatesMessage" parameters: - name: Action in: query required: true schema: type: string enum: - ModifyCertificates - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ModifyCurrentDBClusterCapacity: get: x-aws-operation-name: ModifyCurrentDBClusterCapacity operationId: GET_ModifyCurrentDBClusterCapacity description:Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This action only applies to Aurora Serverless v1 DB clusters.
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
schema: type: integer - name: TimeoutAction in: query required: false description:The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This action only applies to Aurora Serverless v1 DB clusters.
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBEngineVersion" "480": description: CustomDBEngineVersionNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CustomDBEngineVersionNotFoundFault" "481": description: InvalidCustomDBEngineVersionStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidCustomDBEngineVersionStateFault" parameters: - name: Engine in: query required: true description: The DB engine. The only supported values arecustom-oracle-ee and custom-oracle-ee-cdb.
schema:
type: string
pattern: ^[A-Za-z0-9-]{1,35}$
minLength: 1
maxLength: 35
- name: EngineVersion
in: query
required: true
description: The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
schema:
type: string
pattern: ^[a-z0-9_.-]{1,60}$
minLength: 1
maxLength: 60
- name: Description
in: query
required: false
description: An optional description of your CEV.
schema:
type: string
pattern: .*
minLength: 1
maxLength: 1000
- name: Status
in: query
required: false
description: The availability status to be assigned to the CEV. Valid values are as follows:
You can use this CEV to create a new RDS Custom DB instance.
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBEngineVersion" "480": description: CustomDBEngineVersionNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/CustomDBEngineVersionNotFoundFault" "481": description: InvalidCustomDBEngineVersionStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidCustomDBEngineVersionStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ModifyCustomDBEngineVersionMessage" parameters: - name: Action in: query required: true schema: type: string enum: - ModifyCustomDBEngineVersion - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ModifyDBCluster: get: x-aws-operation-name: ModifyDBCluster operationId: GET_ModifyDBCluster description:Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyDBClusterResult" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "483": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "484": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "485": description: InvalidDBSubnetGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSubnetGroupStateFault" "486": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "487": description: DBClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNotFoundFault" "488": description: InvalidDBSecurityGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSecurityGroupStateFault" "489": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "490": description: DBClusterAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterAlreadyExistsFault" "491": description: DBInstanceAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAlreadyExistsFault" "492": description: DomainNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DomainNotFoundFault" parameters: - name: DBClusterIdentifier in: query required: true description: "The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: NewDBClusterIdentifier in: query required: false description: "The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: ApplyImmediately in: query required: false description: "A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: boolean - name: BackupRetentionPeriod in: query required: false description: "The number of days for which automated backups are retained. Specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: integer - name: DBClusterParameterGroupName in: query required: false description: "The name of the DB cluster parameter group to use for the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: VpcSecurityGroupIds in: query required: false description: "A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: Port in: query required: false description: "The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters only
" schema: type: integer - name: MasterUserPassword in: query required: false description: "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: OptionGroupName in: query required: false description: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.
schema: type: string - name: PreferredBackupWindow in: query required: false description: 'The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' schema: type: string - name: PreferredMaintenanceWindow in: query required: false description: 'The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred 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
' schema: type: string - name: EnableIAMDatabaseAuthentication in: query required: false description: "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
" schema: type: boolean - name: BacktrackWindow in: query required: false description: "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
" schema: type: integer - name: CloudwatchLogsExportConfiguration in: query required: false description: 'The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
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
' schema: type: object properties: EnableLogTypes: allOf: - $ref: "#/components/schemas/LogTypeList" - description: The list of log types to enable. DisableLogTypes: allOf: - $ref: "#/components/schemas/LogTypeList" - description: The list of log types to disable. description:The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
- name: EngineVersion in: query required: false description: "The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: AllowMajorVersionUpgrade in: query required: false description: "A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
Valid for: Aurora DB clusters only
" schema: type: boolean - name: DBInstanceParameterGroupName in: query required: false description: "The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
Valid for: Aurora DB clusters only
" schema: type: string - name: Domain in: query required: false description: 'The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' schema: type: string - name: DomainIAMRoleName in: query required: false description: "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
" schema: type: string - name: ScalingConfiguration in: query required: false description: "The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for: Aurora DB clusters only
" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction: allOf: - $ref: "#/components/schemas/String" - description:The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
SecondsBeforeTimeout: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
description:Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
- name: DeletionProtection in: query required: false description: "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
" schema: type: boolean - name: EnableHttpEndpoint in: query required: false description: '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
' schema: type: boolean - name: CopyTagsToSnapshot in: query required: false description: "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
" schema: type: boolean - name: EnableGlobalWriteForwarding in: query required: false description: "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
" schema: type: boolean - name: DBClusterInstanceClass in: query required: false description: 'The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
' schema: type: string - name: AllocatedStorage in: query required: false description: "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
" schema: type: integer - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
" schema: type: string - name: Iops in: query required: false description: 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
' schema: type: integer - name: AutoMinorVersionUpgrade in: query required: false description: "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
" schema: type: boolean - name: MonitoringInterval in: query required: false description: "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 MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
" schema: type: integer - name: MonitoringRoleArn in: query required: false description: 'The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
' schema: type: string - name: EnablePerformanceInsights in: query required: false description: '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
' schema: type: boolean - name: PerformanceInsightsKMSKeyId in: query required: false description: "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
" schema: type: string - name: PerformanceInsightsRetentionPeriod in: query required: false description: "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
" schema: type: integer - name: ServerlessV2ScalingConfiguration in: query required: false description: "" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. MaxCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. description:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- name: NetworkType in: query required: false description: 'The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' schema: type: string - name: ManageMasterUserPassword in: query required: false description: "A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: boolean - name: RotateMasterUserPassword in: query required: false description: 'A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' schema: type: boolean - name: MasterUserSecretKmsKeyId in: query required: false description: "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: EngineMode in: query required: false description: 'The DB engine mode of the DB cluster, either provisioned or serverless.
The DB engine mode can be modified only from serverless to provisioned.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
' schema: type: string - name: AllowEngineModeChange in: query required: false description: "A value that indicates whether engine mode changes from serverless to provisioned are allowed.
Constraints: You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.
Valid for: Aurora Serverless v1 DB clusters only
" schema: type: boolean - name: Action in: query required: true schema: type: string enum: - ModifyDBCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ModifyDBCluster operationId: POST_ModifyDBCluster description:Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyDBClusterResult" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "483": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "484": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "485": description: InvalidDBSubnetGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSubnetGroupStateFault" "486": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "487": description: DBClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNotFoundFault" "488": description: InvalidDBSecurityGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSecurityGroupStateFault" "489": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "490": description: DBClusterAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterAlreadyExistsFault" "491": description: DBInstanceAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAlreadyExistsFault" "492": description: DomainNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DomainNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ModifyDBClusterMessage" parameters: - name: Action in: query required: true schema: type: string enum: - ModifyDBCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ModifyDBClusterEndpoint: get: x-aws-operation-name: ModifyDBClusterEndpoint operationId: GET_ModifyDBClusterEndpoint description:Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
READER, WRITER, ANY."
schema:
type: string
- name: StaticMembers
in: query
required: false
description: List of DB instance identifiers that are part of the custom endpoint group.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: ExcludedMembers
in: query
required: false
description: 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.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBClusterEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: ModifyDBClusterEndpoint
operationId: POST_ModifyDBClusterEndpoint
description: Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNameMessage" "480": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "481": description: InvalidDBParameterGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBParameterGroupStateFault" parameters: - name: DBClusterParameterGroupName in: query required: true description: The name of the DB cluster parameter group to modify. schema: type: string - name: Parameters in: query required: true description: "A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNameMessage" "480": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "481": description: InvalidDBParameterGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBParameterGroupStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ModifyDBClusterParameterGroupMessage" parameters: - name: Action in: query required: true schema: type: string enum: - ModifyDBClusterParameterGroup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ModifyDBClusterSnapshotAttribute: get: x-aws-operation-name: ModifyDBClusterSnapshotAttribute operationId: GET_ModifyDBClusterSnapshotAttribute description:Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
DescribeValidDBInstanceModifications before you call ModifyDBInstance.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBInstanceResult"
"480":
description: InvalidDBInstanceStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceStateFault"
"481":
description: InvalidDBSecurityGroupStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBSecurityGroupStateFault"
"482":
description: DBInstanceAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceAlreadyExistsFault"
"483":
description: DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceNotFoundFault"
"484":
description: DBSecurityGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBSecurityGroupNotFoundFault"
"485":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
"486":
description: InsufficientDBInstanceCapacityFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InsufficientDBInstanceCapacityFault"
"487":
description: StorageQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/StorageQuotaExceededFault"
"488":
description: InvalidVPCNetworkStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidVPCNetworkStateFault"
"489":
description: ProvisionedIopsNotAvailableInAZFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ProvisionedIopsNotAvailableInAZFault"
"490":
description: OptionGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/OptionGroupNotFoundFault"
"491":
description: DBUpgradeDependencyFailureFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBUpgradeDependencyFailureFault"
"492":
description: StorageTypeNotSupportedFault
content:
text/xml:
schema:
$ref: "#/components/schemas/StorageTypeNotSupportedFault"
"493":
description: AuthorizationNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/AuthorizationNotFoundFault"
"494":
description: CertificateNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/CertificateNotFoundFault"
"495":
description: DomainNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DomainNotFoundFault"
"496":
description: BackupPolicyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/BackupPolicyNotFoundFault"
"497":
description: KMSKeyNotAccessibleFault
content:
text/xml:
schema:
$ref: "#/components/schemas/KMSKeyNotAccessibleFault"
"498":
description: InvalidDBClusterStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBClusterStateFault"
"499":
description: NetworkTypeNotSupported
content:
text/xml:
schema:
$ref: "#/components/schemas/NetworkTypeNotSupported"
parameters:
- name: DBInstanceIdentifier
in: query
required: true
description: The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see CreateDBInstance.
The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.
Default: Uses existing setting
' schema: type: string - name: DBSubnetGroupName in: query required: false description: "The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match existing DBSecurityGroups.
A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints: Can't be specified if ManageMasterUserPassword is 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.
Amazon RDS API operations never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
" schema: type: string - name: BackupRetentionPeriod in: query required: false description: "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
" schema: type: string - name: MultiAZ in: query required: false description:A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
schema: type: boolean - name: EngineVersion in: query required: false description:The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or later than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
" schema: type: boolean - name: AutoMinorVersionUpgrade in: query required: false description:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. Otherwise, the operation returns an error.
The license model for the DB instance.
This setting doesn't apply to RDS Custom.
Valid values: license-included | bring-your-own-license | general-public-license
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
" schema: type: integer - name: OptionGroupName in: query required: false description:A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
schema: type: string - name: NewDBInstanceIdentifier in: query required: false description: "The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid values: gp2 | gp3 | io1 | standard
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
schema: type: string - name: TdeCredentialPassword in: query required: false description:The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
schema: type: string - name: CACertificateIdentifier in: query required: false description: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.
schema: type: string - name: Domain in: query required: false description:The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
schema: type: string - name: CopyTagsToSnapshot in: query required: false description:A value that indicates whether to copy all 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. For more information, see ModifyDBCluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
MySQL
Default: 3306
Valid values: 1150-65535
MariaDB
Default: 3306
Valid values: 1150-65535
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
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.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
schema: type: string - name: DomainIAMRoleName in: query required: false description:The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
schema: type: string - name: PromotionTier in: query required: false description: "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
" schema: type: integer - name: EnableIAMDatabaseAuthentication in: query required: false description: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.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
schema: type: boolean - name: EnablePerformanceInsights in: query required: false description: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.
schema: type: boolean - name: PerformanceInsightsKMSKeyId in: query required: false description: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.
schema: type: string - name: PerformanceInsightsRetentionPeriod in: query required: false description: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.
schema: type: integer - name: CloudwatchLogsExportConfiguration in: query required: false description:The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
schema: type: object properties: EnableLogTypes: allOf: - $ref: "#/components/schemas/LogTypeList" - description: The list of log types to enable. DisableLogTypes: allOf: - $ref: "#/components/schemas/LogTypeList" - description: The list of log types to disable. description:The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
- name: ProcessorFeatures in: query required: false description: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.
schema: type: array items: allOf: - $ref: "#/components/schemas/ProcessorFeature" - xml: name: ProcessorFeature - name: UseDefaultProcessorFeatures in: query required: false description: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.
schema: type: boolean - name: DeletionProtection in: query required: false description: 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. schema: type: boolean - name: MaxAllocatedStorage in: query required: false description: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.
schema: type: integer - name: CertificateRotationRestart in: query required: false description:A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
schema: type: boolean - name: ReplicaMode in: query required: false description:A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
schema: type: string enum: - open-read-only - mounted - name: EnableCustomerOwnedIp in: query required: false description: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.
schema: type: boolean - name: AwsBackupRecoveryPointArn in: query required: false description:The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
schema: type: string pattern: ^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\-]+:)?[a-z][a-z0-9\-]{0,255}$ minLength: 43 maxLength: 350 - name: AutomationMode in: query required: false description: "The automation mode of the RDS Custom DB instance:full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes."
schema:
type: string
enum:
- full
- all-paused
- name: ResumeFullAutomationModeMinutes
in: query
required: false
description: The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
schema:
type: integer
- name: NetworkType
in: query
required: false
description: The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
schema: type: string - name: StorageThroughput in: query required: false description:Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
schema: type: integer - name: ManageMasterUserPassword in: query required: false description:A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
schema: type: string - name: Action in: query required: true schema: type: string enum: - ModifyDBInstance - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ModifyDBInstance operationId: POST_ModifyDBInstance description: Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, callDescribeValidDBInstanceModifications before you call ModifyDBInstance.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBInstanceResult"
"480":
description: InvalidDBInstanceStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceStateFault"
"481":
description: InvalidDBSecurityGroupStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBSecurityGroupStateFault"
"482":
description: DBInstanceAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceAlreadyExistsFault"
"483":
description: DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceNotFoundFault"
"484":
description: DBSecurityGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBSecurityGroupNotFoundFault"
"485":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
"486":
description: InsufficientDBInstanceCapacityFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InsufficientDBInstanceCapacityFault"
"487":
description: StorageQuotaExceededFault
content:
text/xml:
schema:
$ref: "#/components/schemas/StorageQuotaExceededFault"
"488":
description: InvalidVPCNetworkStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidVPCNetworkStateFault"
"489":
description: ProvisionedIopsNotAvailableInAZFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ProvisionedIopsNotAvailableInAZFault"
"490":
description: OptionGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/OptionGroupNotFoundFault"
"491":
description: DBUpgradeDependencyFailureFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBUpgradeDependencyFailureFault"
"492":
description: StorageTypeNotSupportedFault
content:
text/xml:
schema:
$ref: "#/components/schemas/StorageTypeNotSupportedFault"
"493":
description: AuthorizationNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/AuthorizationNotFoundFault"
"494":
description: CertificateNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/CertificateNotFoundFault"
"495":
description: DomainNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DomainNotFoundFault"
"496":
description: BackupPolicyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/BackupPolicyNotFoundFault"
"497":
description: KMSKeyNotAccessibleFault
content:
text/xml:
schema:
$ref: "#/components/schemas/KMSKeyNotAccessibleFault"
"498":
description: InvalidDBClusterStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBClusterStateFault"
"499":
description: NetworkTypeNotSupported
content:
text/xml:
schema:
$ref: "#/components/schemas/NetworkTypeNotSupported"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBInstanceMessage"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=ModifyDBParameterGroup:
get:
x-aws-operation-name: ModifyDBParameterGroup
operationId: GET_ModifyDBParameterGroup
description: 'Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify 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.
The name of the DB parameter group.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.
You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.
For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
" schema: type: array items: allOf: - $ref: "#/components/schemas/Parameter" - xml: name: Parameter - name: Action in: query required: true schema: type: string enum: - ModifyDBParameterGroup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ModifyDBParameterGroup operationId: POST_ModifyDBParameterGroup description: 'Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify 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.
DBProxy to modify.
schema:
type: string
- name: NewDBProxyName
in: query
required: false
description: The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
schema:
type: string
- name: Auth
in: query
required: false
description: The new authentication settings for the DBProxy.
schema:
type: array
items:
$ref: "#/components/schemas/UserAuthConfig"
- name: RequireTLS
in: query
required: false
description: Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
schema:
type: boolean
- name: IdleClientTimeout
in: query
required: false
description: 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.
schema:
type: integer
- name: DebugLogging
in: query
required: false
description: 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.
schema:
type: boolean
- name: RoleArn
in: query
required: false
description: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
schema:
type: string
- name: SecurityGroups
in: query
required: false
description: The new list of security groups for the DBProxy.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBProxy
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: ModifyDBProxy
operationId: POST_ModifyDBProxy
description: Changes the settings for an existing DB proxy.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBProxyResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyAlreadyExistsFault"
"482":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBProxyRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBProxy
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=ModifyDBProxyEndpoint:
get:
x-aws-operation-name: ModifyDBProxyEndpoint
operationId: GET_ModifyDBProxyEndpoint
description: Changes the settings for an existing DB proxy endpoint.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBProxyEndpointResponse"
"480":
description: DBProxyEndpointNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointNotFoundFault"
"481":
description: DBProxyEndpointAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointAlreadyExistsFault"
"482":
description: InvalidDBProxyEndpointStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyEndpointStateFault"
"483":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
parameters:
- name: DBProxyEndpointName
in: query
required: true
description: The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
schema:
type: string
pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*"
minLength: 1
maxLength: 63
- name: NewDBProxyEndpointName
in: query
required: false
description: The new identifier for the DBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
schema:
type: string
pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*"
minLength: 1
maxLength: 63
- name: VpcSecurityGroupIds
in: query
required: false
description: The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBProxyEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: ModifyDBProxyEndpoint
operationId: POST_ModifyDBProxyEndpoint
description: Changes the settings for an existing DB proxy endpoint.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBProxyEndpointResponse"
"480":
description: DBProxyEndpointNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointNotFoundFault"
"481":
description: DBProxyEndpointAlreadyExistsFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyEndpointAlreadyExistsFault"
"482":
description: InvalidDBProxyEndpointStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyEndpointStateFault"
"483":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBProxyEndpointRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBProxyEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=ModifyDBProxyTargetGroup:
get:
x-aws-operation-name: ModifyDBProxyTargetGroup
operationId: GET_ModifyDBProxyTargetGroup
description: Modifies the properties of a DBProxyTargetGroup.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBProxyTargetGroupResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"482":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
parameters:
- name: TargetGroupName
in: query
required: true
description: The name of the target group to modify.
schema:
type: string
- name: DBProxyName
in: query
required: true
description: The name of the proxy.
schema:
type: string
- name: ConnectionPoolConfig
in: query
required: false
description: The settings that determine the size and behavior of the connection pool for the target group.
schema:
type: object
properties:
MaxConnectionsPercent:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints: Must be between 1 and 100.
" MaxIdleConnectionsPercent: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
Default: 120
Constraints: between 1 and 3600, or 0 representing unlimited
" SessionPinningFilters: allOf: - $ref: "#/components/schemas/StringList" - description: "Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters
" InitQuery: allOf: - $ref: "#/components/schemas/String" - description: "One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
Default: no initialization query
" description: Specifies the settings that control the size and behavior of the connection pool associated with aDBProxyTargetGroup.
- name: NewName
in: query
required: false
description: The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBProxyTargetGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: ModifyDBProxyTargetGroup
operationId: POST_ModifyDBProxyTargetGroup
description: Modifies the properties of a DBProxyTargetGroup.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBProxyTargetGroupResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"482":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/ModifyDBProxyTargetGroupRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBProxyTargetGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=ModifyDBSnapshot:
get:
x-aws-operation-name: ModifyDBSnapshot
operationId: GET_ModifyDBSnapshot
description: Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyDBSnapshotResult" "480": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" parameters: - name: DBSnapshotIdentifier in: query required: true description: The identifier of the DB snapshot to modify. schema: type: string - name: EngineVersion in: query required: false description:The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
5.5.46 (supported for 5.1 DB snapshots)
Oracle
12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
schema: type: string - name: OptionGroupName in: query required: false description:The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
schema: type: string - name: Action in: query required: true schema: type: string enum: - ModifyDBSnapshot - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ModifyDBSnapshot operationId: POST_ModifyDBSnapshot description:Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyDBSnapshotResult" "480": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ModifyDBSnapshotMessage" parameters: - name: Action in: query required: true schema: type: string enum: - ModifyDBSnapshot - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ModifyDBSnapshotAttribute: get: x-aws-operation-name: ModifyDBSnapshotAttribute operationId: GET_ModifyDBSnapshotAttribute description:Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
A list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/String"
- xml:
name: EventCategory
- name: Enabled
in: query
required: false
description: A value that indicates whether to activate the subscription.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyEventSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: ModifyEventSubscription
operationId: POST_ModifyEventSubscription
description: Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
" schema: type: boolean - name: Action in: query required: true schema: type: string enum: - ModifyGlobalCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ModifyGlobalCluster operationId: POST_ModifyGlobalCluster description:Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
schema: type: string - name: OptionsToInclude in: query required: false description: Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration. schema: type: array items: allOf: - $ref: "#/components/schemas/OptionConfiguration" - xml: name: OptionConfiguration - name: OptionsToRemove in: query required: false description: Options in this list are removed from the option group. schema: type: array items: $ref: "#/components/schemas/String" - name: ApplyImmediately in: query required: false description: A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group. schema: type: boolean - name: Action in: query required: true schema: type: string enum: - ModifyOptionGroup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ModifyOptionGroup operationId: POST_ModifyOptionGroup description: Modifies an existing option group. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ModifyOptionGroupResult" "480": description: InvalidOptionGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidOptionGroupStateFault" "481": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ModifyOptionGroupMessage" parameters: - name: Action in: query required: true schema: type: string enum: - ModifyOptionGroup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=PromoteReadReplica: get: x-aws-operation-name: PromoteReadReplica operationId: GET_PromoteReadReplica description:Promotes a read replica DB instance to a standalone DB instance.
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing read replica DB instance.
Example: mydbinstance
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
Promotes a read replica DB instance to a standalone DB instance.
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster read replica.
Example: my-cluster-replica1
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
" schema: type: string - name: ReservedDBInstanceId in: query required: false description: "Customer-specified identifier to track this reservation.
Example: myreservationID
" schema: type: string - name: DBInstanceCount in: query required: false description: "The number of instances to reserve.
Default: 1
You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RebootDBClusterResult" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" parameters: - name: DBClusterIdentifier in: query required: true description:The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBCluster.
You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RebootDBClusterResult" "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RebootDBClusterMessage" parameters: - name: Action in: query required: true schema: type: string enum: - RebootDBCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=RebootDBInstance: get: x-aws-operation-name: RebootDBInstance operationId: GET_RebootDBInstance description:You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
" schema: type: boolean - name: Action in: query required: true schema: type: string enum: - RebootDBInstance - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RebootDBInstance operationId: POST_RebootDBInstance description:You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
DBProxyTarget data structures with a DBProxyTargetGroup.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/RegisterDBProxyTargetsResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"482":
description: DBClusterNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBClusterNotFoundFault"
"483":
description: DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceNotFoundFault"
"484":
description: DBProxyTargetAlreadyRegisteredFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetAlreadyRegisteredFault"
"485":
description: InvalidDBInstanceStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceStateFault"
"486":
description: InvalidDBClusterStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBClusterStateFault"
"487":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
"488":
description: InsufficientAvailableIPsInSubnetFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InsufficientAvailableIPsInSubnetFault"
parameters:
- name: DBProxyName
in: query
required: true
description: The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
schema:
type: string
- name: TargetGroupName
in: query
required: false
description: The identifier of the DBProxyTargetGroup.
schema:
type: string
- name: DBInstanceIdentifiers
in: query
required: false
description: One or more DB instance identifiers.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: DBClusterIdentifiers
in: query
required: false
description: One or more DB cluster identifiers.
schema:
type: array
items:
$ref: "#/components/schemas/String"
- name: Action
in: query
required: true
schema:
type: string
enum:
- RegisterDBProxyTargets
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: RegisterDBProxyTargets
operationId: POST_RegisterDBProxyTargets
description: Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/RegisterDBProxyTargetsResponse"
"480":
description: DBProxyNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyNotFoundFault"
"481":
description: DBProxyTargetGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault"
"482":
description: DBClusterNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBClusterNotFoundFault"
"483":
description: DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceNotFoundFault"
"484":
description: DBProxyTargetAlreadyRegisteredFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBProxyTargetAlreadyRegisteredFault"
"485":
description: InvalidDBInstanceStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceStateFault"
"486":
description: InvalidDBClusterStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBClusterStateFault"
"487":
description: InvalidDBProxyStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBProxyStateFault"
"488":
description: InsufficientAvailableIPsInSubnetFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InsufficientAvailableIPsInSubnetFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/RegisterDBProxyTargetsRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RegisterDBProxyTargets
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=RemoveFromGlobalCluster:
get:
x-aws-operation-name: RemoveFromGlobalCluster
operationId: GET_RemoveFromGlobalCluster
description: Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This action only applies to Aurora DB clusters.
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This action only applies to Aurora DB clusters.
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: DBClusterRoleNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterRoleNotFoundFault" "482": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" parameters: - name: DBClusterIdentifier in: query required: true description: The name of the DB cluster to disassociate the IAM role from. schema: type: string - name: RoleArn in: query required: true description: The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for examplearn:aws:iam::123456789012:role/AuroraAccessRole.
schema:
type: string
- name: FeatureName
in: query
required: false
description: The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- RemoveRoleFromDBCluster
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: RemoveRoleFromDBCluster
operationId: POST_RemoveRoleFromDBCluster
description: Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success "480": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "481": description: DBClusterRoleNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterRoleNotFoundFault" "482": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RemoveRoleFromDBClusterMessage" parameters: - name: Action in: query required: true schema: type: string enum: - RemoveRoleFromDBCluster - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=RemoveRoleFromDBInstance: get: x-aws-operation-name: RemoveRoleFromDBInstance operationId: GET_RemoveRoleFromDBInstance description: Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance. responses: "200": description: Success "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBInstanceRoleNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceRoleNotFoundFault" "482": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" parameters: - name: DBInstanceIdentifier in: query required: true description: The name of the DB instance to disassociate the IAM role from. schema: type: string - name: RoleArn in: query required: true description: The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example,arn:aws:iam::123456789012:role/AccessRole.
schema:
type: string
- name: FeatureName
in: query
required: true
description: The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- RemoveRoleFromDBInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: RemoveRoleFromDBInstance
operationId: POST_RemoveRoleFromDBInstance
description: Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
responses:
"200":
description: Success
"480":
description: DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceNotFoundFault"
"481":
description: DBInstanceRoleNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceRoleNotFoundFault"
"482":
description: InvalidDBInstanceStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceStateFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/RemoveRoleFromDBInstanceMessage"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RemoveRoleFromDBInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=RemoveSourceIdentifierFromSubscription:
get:
x-aws-operation-name: RemoveSourceIdentifierFromSubscription
operationId: GET_RemoveSourceIdentifierFromSubscription
description: Removes a source identifier from an existing RDS event notification subscription.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/RemoveSourceIdentifierFromSubscriptionResult"
"480":
description: SubscriptionNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/SubscriptionNotFoundFault"
"481":
description: SourceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/SourceNotFoundFault"
parameters:
- name: SubscriptionName
in: query
required: true
description: The name of the RDS event notification subscription you want to remove a source identifier from.
schema:
type: string
- name: SourceIdentifier
in: query
required: true
description: The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- RemoveSourceIdentifierFromSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: RemoveSourceIdentifierFromSubscription
operationId: POST_RemoveSourceIdentifierFromSubscription
description: Removes a source identifier from an existing RDS event notification subscription.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/RemoveSourceIdentifierFromSubscriptionResult"
"480":
description: SubscriptionNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/SubscriptionNotFoundFault"
"481":
description: SourceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/SourceNotFoundFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/RemoveSourceIdentifierFromSubscriptionMessage"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RemoveSourceIdentifierFromSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=RemoveTagsFromResource:
get:
x-aws-operation-name: RemoveTagsFromResource
operationId: GET_RemoveTagsFromResource
description: Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
responses: "200": description: Success "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "482": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "483": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" "484": description: DBProxyTargetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault" "485": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" parameters: - name: ResourceName in: query required: true description: 'The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. ' schema: type: string - name: TagKeys in: query required: true description: The tag key (name) of the tag to be removed. schema: type: array items: $ref: "#/components/schemas/String" - name: Action in: query required: true schema: type: string enum: - RemoveTagsFromResource - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RemoveTagsFromResource operationId: POST_RemoveTagsFromResource description:Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
responses: "200": description: Success "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "482": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "483": description: DBProxyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyNotFoundFault" "484": description: DBProxyTargetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBProxyTargetGroupNotFoundFault" "485": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RemoveTagsFromResourceMessage" parameters: - name: Action in: query required: true schema: type: string enum: - RemoveTagsFromResource - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ResetDBClusterParameterGroup: get: x-aws-operation-name: ResetDBClusterParameterGroup operationId: GET_ResetDBClusterParameterGroup description: 'Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNameMessage" "480": description: InvalidDBParameterGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBParameterGroupStateFault" "481": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" parameters: - name: DBClusterParameterGroupName in: query required: true description: The name of the DB cluster parameter group to reset. schema: type: string - name: ResetAllParameters in: query required: false description: A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for theParameters parameter.
schema:
type: boolean
- name: Parameters
in: query
required: false
description: A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Parameter"
- xml:
name: Parameter
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetDBClusterParameterGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: ResetDBClusterParameterGroup
operationId: POST_ResetDBClusterParameterGroup
description: 'Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNameMessage" "480": description: InvalidDBParameterGroupStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBParameterGroupStateFault" "481": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ResetDBClusterParameterGroupMessage" parameters: - name: Action in: query required: true schema: type: string enum: - ResetDBClusterParameterGroup - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=ResetDBParameterGroup: get: x-aws-operation-name: ResetDBParameterGroup operationId: GET_ResetDBParameterGroup description: "Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request."
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNameMessage"
"480":
description: InvalidDBParameterGroupStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBParameterGroupStateFault"
"481":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
parameters:
- name: DBParameterGroupName
in: query
required: true
description: The name of the DB parameter group.
Constraints:
Must match the name of an existing DBParameterGroup.
To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
MariaDB
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request."
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNameMessage"
"480":
description: InvalidDBParameterGroupStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBParameterGroupStateFault"
"481":
description: DBParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBParameterGroupNotFoundFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/ResetDBParameterGroupMessage"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetDBParameterGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=RestoreDBClusterFromS3:
get:
x-aws-operation-name: RestoreDBClusterFromS3
operationId: GET_RestoreDBClusterFromS3
description: Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The name of the database engine to be used for this DB cluster.
Valid Values: aurora-mysql (for Aurora MySQL)
The version number of the database engine to use.
To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Examples: 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
schema: type: string - name: PreferredBackupWindow in: query required: false description:The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
' schema: type: string - name: Tags in: query required: false description: "" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: StorageEncrypted in: query required: false description: A value that indicates whether the restored DB cluster is encrypted. schema: type: boolean - name: KmsKeyId in: query required: false description:The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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.
schema: type: boolean - name: SourceEngine in: query required: true description: "The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40, 5.7.28
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
schema: type: array items: $ref: "#/components/schemas/String" - name: DeletionProtection in: query required: false description: 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. schema: type: boolean - name: CopyTagsToSnapshot in: query required: false description: A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. schema: type: boolean - name: Domain in: query required: false description:Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
schema: type: string - name: DomainIAMRoleName in: query required: false description: Specify the name of the IAM role to be used when making API calls to the Directory Service. schema: type: string - name: ServerlessV2ScalingConfiguration in: query required: false description: "" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. MaxCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. description:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- name: NetworkType in: query required: false description:The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
schema: type: string - name: ManageMasterUserPassword in: query required: false description: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 MasterUserPassword is specified.
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 the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
schema: type: string - name: Action in: query required: true schema: type: string enum: - RestoreDBClusterFromS3 - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RestoreDBClusterFromS3 operationId: POST_RestoreDBClusterFromS3 description:Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RestoreDBClusterFromSnapshotResult" "480": description: DBClusterAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterAlreadyExistsFault" "481": description: DBClusterQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterQuotaExceededFault" "482": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "483": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "484": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "485": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" "486": description: InsufficientDBClusterCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientDBClusterCapacityFault" "487": description: InsufficientStorageClusterCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientStorageClusterCapacityFault" "488": description: InvalidDBSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSnapshotStateFault" "489": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" "490": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "491": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "492": description: InvalidRestoreFault content: text/xml: schema: $ref: "#/components/schemas/InvalidRestoreFault" "493": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "494": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "495": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "496": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "497": description: DomainNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DomainNotFoundFault" "498": description: DBClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNotFoundFault" "499": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" parameters: - name: AvailabilityZones in: query required: false description: "Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: AvailabilityZone - name: DBClusterIdentifier in: query required: true description: "The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: SnapshotIdentifier in: query required: true description: "The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: Engine in: query required: true description: "The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: EngineVersion in: query required: false description: "The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"
Aurora MySQL
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: Port in: query required: false description: "The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: integer - name: DBSubnetGroupName in: query required: false description: "The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: DatabaseName in: query required: false description: "The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: OptionGroupName in: query required: false description:The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
schema: type: string - name: VpcSecurityGroupIds in: query required: false description: "A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: Tags in: query required: false description: "The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: KmsKeyId in: query required: false description: "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: EnableIAMDatabaseAuthentication in: query required: false description: "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
" schema: type: boolean - name: BacktrackWindow in: query required: false description: "The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
" schema: type: integer - name: EnableCloudwatchLogsExports in: query required: false description: 'The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
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
' schema: type: array items: $ref: "#/components/schemas/String" - name: EngineMode in: query required: false description: 'The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
' schema: type: string - name: ScalingConfiguration in: query required: false description: "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction: allOf: - $ref: "#/components/schemas/String" - description:The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
SecondsBeforeTimeout: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
description:Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
- name: DBClusterParameterGroupName in: query required: false description: "The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: DeletionProtection in: query required: false description: "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
" schema: type: boolean - name: CopyTagsToSnapshot in: query required: false description: "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: boolean - name: Domain in: query required: false description: 'Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
' schema: type: string - name: DomainIAMRoleName in: query required: false description: "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
" schema: type: string - name: DBClusterInstanceClass in: query required: false description: 'The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
' schema: type: string - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: Iops in: query required: false description: 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' schema: type: integer - name: PubliclyAccessible in: query required: false description: "A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: boolean - name: ServerlessV2ScalingConfiguration in: query required: false description: "" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. MaxCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. description:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- name: NetworkType in: query required: false description: 'The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' schema: type: string - name: Action in: query required: true schema: type: string enum: - RestoreDBClusterFromSnapshot - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RestoreDBClusterFromSnapshot operationId: POST_RestoreDBClusterFromSnapshot description:Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RestoreDBClusterFromSnapshotResult" "480": description: DBClusterAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterAlreadyExistsFault" "481": description: DBClusterQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterQuotaExceededFault" "482": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "483": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "484": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "485": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" "486": description: InsufficientDBClusterCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientDBClusterCapacityFault" "487": description: InsufficientStorageClusterCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientStorageClusterCapacityFault" "488": description: InvalidDBSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSnapshotStateFault" "489": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" "490": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "491": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "492": description: InvalidRestoreFault content: text/xml: schema: $ref: "#/components/schemas/InvalidRestoreFault" "493": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "494": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "495": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "496": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "497": description: DomainNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DomainNotFoundFault" "498": description: DBClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNotFoundFault" "499": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RestoreDBClusterFromSnapshotMessage" parameters: - name: Action in: query required: true schema: type: string enum: - RestoreDBClusterFromSnapshot - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=RestoreDBClusterToPointInTime: get: x-aws-operation-name: RestoreDBClusterToPointInTime operationId: GET_RestoreDBClusterToPointInTime description:Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RestoreDBClusterToPointInTimeResult" "480": description: DBClusterAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterAlreadyExistsFault" "481": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "482": description: DBClusterQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterQuotaExceededFault" "483": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" "484": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "485": description: InsufficientDBClusterCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientDBClusterCapacityFault" "486": description: InsufficientStorageClusterCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientStorageClusterCapacityFault" "487": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" "488": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "489": description: InvalidDBSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSnapshotStateFault" "490": description: InvalidRestoreFault content: text/xml: schema: $ref: "#/components/schemas/InvalidRestoreFault" "491": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "492": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "493": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "494": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "495": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "496": description: DomainNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DomainNotFoundFault" "497": description: DBClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNotFoundFault" parameters: - name: DBClusterIdentifier in: query required: true description: "The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: RestoreType in: query required: false description: "The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: SourceDBClusterIdentifier in: query required: true description: "The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: RestoreToTime in: query required: false description: "The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string format: date-time - name: UseLatestRestorableTime in: query required: false description: "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: boolean - name: Port in: query required: false description: "The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535.
Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: integer - name: DBSubnetGroupName in: query required: false description: "The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: OptionGroupName in: query required: false description:The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
schema: type: string - name: VpcSecurityGroupIds in: query required: false description: "A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: Tags in: query required: false description: "" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: KmsKeyId in: query required: false description: "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: EnableIAMDatabaseAuthentication in: query required: false description: "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
" schema: type: boolean - name: BacktrackWindow in: query required: false description: "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
" schema: type: integer - name: EnableCloudwatchLogsExports in: query required: false description: 'The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
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
' schema: type: array items: $ref: "#/components/schemas/String" - name: DBClusterParameterGroupName in: query required: false description: "The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: string - name: DeletionProtection in: query required: false description: "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
" schema: type: boolean - name: CopyTagsToSnapshot in: query required: false description: "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" schema: type: boolean - name: Domain in: query required: false description: 'Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' schema: type: string - name: DomainIAMRoleName in: query required: false description: "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
" schema: type: string - name: ScalingConfiguration in: query required: false description: "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction: allOf: - $ref: "#/components/schemas/String" - description:The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
SecondsBeforeTimeout: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
description:Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
- name: EngineMode in: query required: false description: "The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
" schema: type: string - name: DBClusterInstanceClass in: query required: false description: 'The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
' schema: type: string - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
" schema: type: string - name: PubliclyAccessible in: query required: false description: "A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
" schema: type: boolean - name: Iops in: query required: false description: 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
' schema: type: integer - name: ServerlessV2ScalingConfiguration in: query required: false description: "" schema: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. MaxCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. description:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- name: NetworkType in: query required: false description: 'The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' schema: type: string - name: Action in: query required: true schema: type: string enum: - RestoreDBClusterToPointInTime - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RestoreDBClusterToPointInTime operationId: POST_RestoreDBClusterToPointInTime description:Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RestoreDBClusterToPointInTimeResult" "480": description: DBClusterAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterAlreadyExistsFault" "481": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "482": description: DBClusterQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterQuotaExceededFault" "483": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" "484": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "485": description: InsufficientDBClusterCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientDBClusterCapacityFault" "486": description: InsufficientStorageClusterCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientStorageClusterCapacityFault" "487": description: InvalidDBClusterSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterSnapshotStateFault" "488": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "489": description: InvalidDBSnapshotStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBSnapshotStateFault" "490": description: InvalidRestoreFault content: text/xml: schema: $ref: "#/components/schemas/InvalidRestoreFault" "491": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "492": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "493": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "494": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "495": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "496": description: DomainNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DomainNotFoundFault" "497": description: DBClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterParameterGroupNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RestoreDBClusterToPointInTimeMessage" parameters: - name: Action in: query required: true schema: type: string enum: - RestoreDBClusterToPointInTime - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=RestoreDBInstanceFromDBSnapshot: get: x-aws-operation-name: RestoreDBInstanceFromDBSnapshot operationId: GET_RestoreDBInstanceFromDBSnapshot description:Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
Can't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
' schema: type: string - name: Port in: query required: false description: "The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
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.
For more information, see CreateDBInstance.
schema: type: boolean - name: AutoMinorVersionUpgrade in: query required: false description:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
schema: type: boolean - name: LicenseModel in: query required: false description: "License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
schema: type: string - name: Engine in: query required: false description: "The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
" schema: type: integer - name: OptionGroupName in: query required: false description:The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
schema: type: string - name: Tags in: query required: false description: "" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
schema: type: string - name: TdeCredentialPassword in: query required: false description:The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
schema: type: string - name: VpcSecurityGroupIds in: query required: false description: "A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: Domain in: query required: false description:Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
schema: type: string - name: CopyTagsToSnapshot in: query required: false description:A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
schema: type: boolean - name: DomainIAMRoleName in: query required: false description: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.
schema: type: string - name: EnableIAMDatabaseAuthentication in: query required: false description:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
schema: type: boolean - name: EnableCloudwatchLogsExports in: query required: false description:The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
schema: type: array items: $ref: "#/components/schemas/String" - name: ProcessorFeatures in: query required: false description: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.
schema: type: array items: allOf: - $ref: "#/components/schemas/ProcessorFeature" - xml: name: ProcessorFeature - name: UseDefaultProcessorFeatures in: query required: false description: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.
schema: type: boolean - name: DBParameterGroupName in: query required: false description:The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
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.
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.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
schema: type: boolean - name: CustomIamInstanceProfile in: query required: false description: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.
schema: type: string - name: BackupTarget in: query required: false description:Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
schema: type: string - name: NetworkType in: query required: false description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
schema: type: string - name: StorageThroughput in: query required: false description:Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
schema: type: integer - name: DBClusterSnapshotIdentifier in: query required: false description:The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RestoreDBInstanceFromS3Result" "480": description: DBInstanceAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAlreadyExistsFault" "481": description: InsufficientDBInstanceCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientDBInstanceCapacityFault" "482": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "483": description: DBSecurityGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSecurityGroupNotFoundFault" "484": description: InstanceQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/InstanceQuotaExceededFault" "485": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "486": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "487": description: DBSubnetGroupDoesNotCoverEnoughAZs content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupDoesNotCoverEnoughAZs" "488": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "489": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "490": description: InvalidS3BucketFault content: text/xml: schema: $ref: "#/components/schemas/InvalidS3BucketFault" "491": description: ProvisionedIopsNotAvailableInAZFault content: text/xml: schema: $ref: "#/components/schemas/ProvisionedIopsNotAvailableInAZFault" "492": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "493": description: StorageTypeNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/StorageTypeNotSupportedFault" "494": description: AuthorizationNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/AuthorizationNotFoundFault" "495": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "496": description: BackupPolicyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BackupPolicyNotFoundFault" "497": description: NetworkTypeNotSupported content: text/xml: schema: $ref: "#/components/schemas/NetworkTypeNotSupported" parameters: - name: DBName in: query required: false description: The name of the database to create when the DB instance is created. Follow the naming rules specified inCreateDBInstance.
schema:
type: string
- name: DBInstanceIdentifier
in: query
required: true
description: "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
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
schema: type: string - name: Engine in: query required: true description: "The name of the database engine to be used for this instance.
Valid Values: mysql
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints: Can't be specified if ManageMasterUserPassword is 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.
" schema: type: string - name: DBSecurityGroups in: query required: false description: "A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: DBSecurityGroupName - name: VpcSecurityGroupIds in: query required: false description: A list of VPC security groups to associate with this DB instance. schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: AvailabilityZone in: query required: false description: "The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
CreateDBInstance.
schema:
type: integer
- name: PreferredBackupWindow
in: query
required: false
description: The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
AvailabilityZone parameter.
schema:
type: boolean
- name: EngineVersion
in: query
required: false
description: The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
schema:
type: string
- name: AutoMinorVersionUpgrade
in: query
required: false
description: 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 not applied automatically.
schema:
type: boolean
- name: LicenseModel
in: query
required: false
description: The license model for this DB instance. Use general-public-license.
schema:
type: string
- name: Iops
in: query
required: false
description: 'The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide. '
schema:
type: integer
- name: OptionGroupName
in: query
required: false
description: The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
schema:
type: string
- name: PubliclyAccessible
in: query
required: false
description: 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.
For more information, see CreateDBInstance.
schema: type: boolean - name: Tags in: query required: false description: 'A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
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.
schema: type: boolean - name: SourceEngine in: query required: true description: "The name of the engine of your source database.
Valid Values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
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.
schema: type: boolean - name: PerformanceInsightsKMSKeyId in: query required: false description: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.
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.
schema: type: integer - name: EnableCloudwatchLogsExports in: query required: false description: The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. schema: type: array items: $ref: "#/components/schemas/String" - name: ProcessorFeatures in: query required: false description: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. schema: type: array items: allOf: - $ref: "#/components/schemas/ProcessorFeature" - xml: name: ProcessorFeature - name: UseDefaultProcessorFeatures in: query required: false description: A value that indicates whether the DB instance class of the DB instance uses its default processor features. schema: type: boolean - name: DeletionProtection in: query required: false description: 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. schema: type: boolean - name: MaxAllocatedStorage in: query required: false description: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.
schema: type: integer - name: NetworkType in: query required: false description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
schema: type: string - name: StorageThroughput in: query required: false description:Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
schema: type: integer - name: ManageMasterUserPassword in: query required: false description: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 MasterUserPassword is specified.
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 the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
schema: type: string - name: Action in: query required: true schema: type: string enum: - RestoreDBInstanceFromS3 - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RestoreDBInstanceFromS3 operationId: POST_RestoreDBInstanceFromS3 description:Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RestoreDBInstanceFromS3Result" "480": description: DBInstanceAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAlreadyExistsFault" "481": description: InsufficientDBInstanceCapacityFault content: text/xml: schema: $ref: "#/components/schemas/InsufficientDBInstanceCapacityFault" "482": description: DBParameterGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBParameterGroupNotFoundFault" "483": description: DBSecurityGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSecurityGroupNotFoundFault" "484": description: InstanceQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/InstanceQuotaExceededFault" "485": description: StorageQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "486": description: DBSubnetGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupNotFoundFault" "487": description: DBSubnetGroupDoesNotCoverEnoughAZs content: text/xml: schema: $ref: "#/components/schemas/DBSubnetGroupDoesNotCoverEnoughAZs" "488": description: InvalidSubnet content: text/xml: schema: $ref: "#/components/schemas/InvalidSubnet" "489": description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidVPCNetworkStateFault" "490": description: InvalidS3BucketFault content: text/xml: schema: $ref: "#/components/schemas/InvalidS3BucketFault" "491": description: ProvisionedIopsNotAvailableInAZFault content: text/xml: schema: $ref: "#/components/schemas/ProvisionedIopsNotAvailableInAZFault" "492": description: OptionGroupNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/OptionGroupNotFoundFault" "493": description: StorageTypeNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/StorageTypeNotSupportedFault" "494": description: AuthorizationNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/AuthorizationNotFoundFault" "495": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "496": description: BackupPolicyNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BackupPolicyNotFoundFault" "497": description: NetworkTypeNotSupported content: text/xml: schema: $ref: "#/components/schemas/NetworkTypeNotSupported" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RestoreDBInstanceFromS3Message" parameters: - name: Action in: query required: true schema: type: string enum: - RestoreDBInstanceFromS3 - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=RestoreDBInstanceToPointInTime: get: x-aws-operation-name: RestoreDBInstanceToPointInTime operationId: GET_RestoreDBInstanceToPointInTime description:Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime parameter is provided.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
' schema: type: string - name: Port in: query required: false description: "The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
" schema: type: integer - name: AvailabilityZone in: query required: false description: "The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
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.
schema: type: boolean - name: AutoMinorVersionUpgrade in: query required: false description:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
schema: type: boolean - name: LicenseModel in: query required: false description: "License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
" schema: type: integer - name: OptionGroupName in: query required: false description:The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
schema: type: string - name: CopyTagsToSnapshot in: query required: false description: A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied. schema: type: boolean - name: Tags in: query required: false description: "" schema: type: array description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' items: allOf: - $ref: "#/components/schemas/Tag" - xml: name: Tag - name: StorageType in: query required: false description: "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
schema: type: string - name: TdeCredentialPassword in: query required: false description:The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
schema: type: string - name: VpcSecurityGroupIds in: query required: false description: "A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
" schema: type: array items: allOf: - $ref: "#/components/schemas/String" - xml: name: VpcSecurityGroupId - name: Domain in: query required: false description:Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
schema: type: string - name: DomainIAMRoleName in: query required: false description: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.
schema: type: string - name: EnableIAMDatabaseAuthentication in: query required: false description: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.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
schema: type: boolean - name: EnableCloudwatchLogsExports in: query required: false description:The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
schema: type: array items: $ref: "#/components/schemas/String" - name: ProcessorFeatures in: query required: false description: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.
schema: type: array items: allOf: - $ref: "#/components/schemas/ProcessorFeature" - xml: name: ProcessorFeature - name: UseDefaultProcessorFeatures in: query required: false description: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.
schema: type: boolean - name: DBParameterGroupName in: query required: false description:The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
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.
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.
schema: type: integer - name: SourceDBInstanceAutomatedBackupsArn in: query required: false description:The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
schema: type: string - name: EnableCustomerOwnedIp in: query required: false description: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.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
schema: type: boolean - name: CustomIamInstanceProfile in: query required: false description: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.
schema: type: string - name: BackupTarget in: query required: false description:Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
schema: type: string - name: NetworkType in: query required: false description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
schema: type: string - name: StorageThroughput in: query required: false description:Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
schema: type: integer - name: AllocatedStorage in: query required: false description:The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here's How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.
schema:
type: string
- name: EC2SecurityGroupName
in: query
required: false
description: The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
schema:
type: string
- name: EC2SecurityGroupId
in: query
required: false
description: The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
schema:
type: string
- name: EC2SecurityGroupOwnerId
in: query
required: false
description: The Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- RevokeDBSecurityGroupIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: RevokeDBSecurityGroupIngress
operationId: POST_RevokeDBSecurityGroupIngress
description: Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here's How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
schema:
type: string
- name: Mode
in: query
required: true
description: Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
schema:
type: string
enum:
- sync
- async
- name: KmsKeyId
in: query
required: true
description: The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
schema:
type: string
- name: ApplyImmediately
in: query
required: false
description: Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
schema:
type: boolean
- name: EngineNativeAuditFieldsIncluded
in: query
required: false
description: Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartActivityStream
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: StartActivityStream
operationId: POST_StartActivityStream
description: Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/StartActivityStreamResponse"
"480":
description: InvalidDBInstanceStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBInstanceStateFault"
"481":
description: InvalidDBClusterStateFault
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidDBClusterStateFault"
"482":
description: ResourceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceNotFoundFault"
"483":
description: DBClusterNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBClusterNotFoundFault"
"484":
description: DBInstanceNotFoundFault
content:
text/xml:
schema:
$ref: "#/components/schemas/DBInstanceNotFoundFault"
"485":
description: KMSKeyNotAccessibleFault
content:
text/xml:
schema:
$ref: "#/components/schemas/KMSKeyNotAccessibleFault"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/StartActivityStreamRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartActivityStream
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
/#Action=StartDBCluster:
get:
x-aws-operation-name: StartDBCluster
operationId: GET_StartDBCluster
description: 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.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
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.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/StartDBInstanceAutomatedBackupsReplicationResult" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "482": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "483": description: DBInstanceAutomatedBackupQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAutomatedBackupQuotaExceededFault" "484": description: StorageTypeNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/StorageTypeNotSupportedFault" parameters: - name: SourceDBInstanceArn in: query required: true description: The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example,arn:aws:rds:us-west-2:123456789012:db:mydatabase.
schema:
type: string
- name: BackupRetentionPeriod
in: query
required: false
description: The retention period for the replicated automated backups.
schema:
type: integer
- name: KmsKeyId
in: query
required: false
description: The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
schema:
type: string
- name: PreSignedUrl
in: query
required: false
description: "In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/StartDBInstanceAutomatedBackupsReplicationResult" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "482": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "483": description: DBInstanceAutomatedBackupQuotaExceededFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceAutomatedBackupQuotaExceededFault" "484": description: StorageTypeNotSupportedFault content: text/xml: schema: $ref: "#/components/schemas/StorageTypeNotSupportedFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/StartDBInstanceAutomatedBackupsReplicationMessage" parameters: - name: Action in: query required: true schema: type: string enum: - StartDBInstanceAutomatedBackupsReplication - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=StartExportTask: get: x-aws-operation-name: StartExportTask operationId: GET_StartExportTask description:Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can't export snapshot data from RDS Custom DB instances.
You can't export cluster data from Multi-AZ DB clusters.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ExportTask" "480": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "481": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" "482": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "483": description: ExportTaskAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/ExportTaskAlreadyExistsFault" "484": description: InvalidS3BucketFault content: text/xml: schema: $ref: "#/components/schemas/InvalidS3BucketFault" "485": description: IamRoleNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/IamRoleNotFoundFault" "486": description: IamRoleMissingPermissionsFault content: text/xml: schema: $ref: "#/components/schemas/IamRoleMissingPermissionsFault" "487": description: InvalidExportOnlyFault content: text/xml: schema: $ref: "#/components/schemas/InvalidExportOnlyFault" "488": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "489": description: InvalidExportSourceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidExportSourceStateFault" parameters: - name: ExportTaskIdentifier in: query required: true description: A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported. schema: type: string - name: SourceArn in: query required: true description: The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3. schema: type: string - name: S3BucketName in: query required: true description: The name of the Amazon S3 bucket to export the snapshot or cluster data to. schema: type: string - name: IamRoleArn in: query required: true description:The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
s3:PutObject*
s3:GetObject*
s3:ListBucket
s3:DeleteObject*
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
arn:aws:s3:::your-s3-bucket
arn:aws:s3:::your-s3-bucket/*
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant
The data to be exported from the snapshot or cluster. If this parameter is not provided, all of the data is exported. Valid values are the following:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can't export snapshot data from RDS Custom DB instances.
You can't export cluster data from Multi-AZ DB clusters.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ExportTask" "480": description: DBSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBSnapshotNotFoundFault" "481": description: DBClusterSnapshotNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterSnapshotNotFoundFault" "482": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "483": description: ExportTaskAlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/ExportTaskAlreadyExistsFault" "484": description: InvalidS3BucketFault content: text/xml: schema: $ref: "#/components/schemas/InvalidS3BucketFault" "485": description: IamRoleNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/IamRoleNotFoundFault" "486": description: IamRoleMissingPermissionsFault content: text/xml: schema: $ref: "#/components/schemas/IamRoleMissingPermissionsFault" "487": description: InvalidExportOnlyFault content: text/xml: schema: $ref: "#/components/schemas/InvalidExportOnlyFault" "488": description: KMSKeyNotAccessibleFault content: text/xml: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "489": description: InvalidExportSourceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidExportSourceStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/StartExportTaskMessage" parameters: - name: Action in: query required: true schema: type: string enum: - StartExportTask - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=StopActivityStream: get: x-aws-operation-name: StopActivityStream operationId: GET_StopActivityStream description:Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.
For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/StopActivityStreamResponse" "480": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: ResourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "483": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "484": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" parameters: - name: ResourceArn in: query required: true description: The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example,arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
schema:
type: string
- name: ApplyImmediately
in: query
required: false
description: Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- StopActivityStream
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: StopActivityStream
operationId: POST_StopActivityStream
description: Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.
For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/StopActivityStreamResponse" "480": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" "481": description: InvalidDBClusterStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBClusterStateFault" "482": description: ResourceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "483": description: DBClusterNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBClusterNotFoundFault" "484": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/StopActivityStreamRequest" parameters: - name: Action in: query required: true schema: type: string enum: - StopActivityStream - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=StopDBCluster: get: x-aws-operation-name: StopDBCluster operationId: GET_StopDBCluster description:Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/StopDBInstanceAutomatedBackupsReplicationResult" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" parameters: - name: SourceDBInstanceArn in: query required: true description: The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automate backups, for example,arn:aws:rds:us-west-2:123456789012:db:mydatabase.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- StopDBInstanceAutomatedBackupsReplication
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2014-10-31
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: StopDBInstanceAutomatedBackupsReplication
operationId: POST_StopDBInstanceAutomatedBackupsReplication
description: Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/StopDBInstanceAutomatedBackupsReplicationResult" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/StopDBInstanceAutomatedBackupsReplicationMessage" parameters: - name: Action in: query required: true schema: type: string enum: - StopDBInstanceAutomatedBackupsReplication - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=SwitchoverBlueGreenDeployment: get: x-aws-operation-name: SwitchoverBlueGreenDeployment operationId: GET_SwitchoverBlueGreenDeployment description:Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/SwitchoverBlueGreenDeploymentResponse" "480": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" "481": description: InvalidBlueGreenDeploymentStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidBlueGreenDeploymentStateFault" parameters: - name: BlueGreenDeploymentIdentifier in: query required: true description:The blue/green deployment identifier.
Constraints:
Must match an existing blue/green deployment identifier.
The amount of time, in seconds, for the switchover to complete. The default is 300.
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.
schema: type: integer minimum: 30 - name: Action in: query required: true schema: type: string enum: - SwitchoverBlueGreenDeployment - name: Version in: query required: true schema: type: string enum: - 2014-10-31 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: SwitchoverBlueGreenDeployment operationId: POST_SwitchoverBlueGreenDeployment description:Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/SwitchoverBlueGreenDeploymentResponse" "480": description: BlueGreenDeploymentNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/BlueGreenDeploymentNotFoundFault" "481": description: InvalidBlueGreenDeploymentStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidBlueGreenDeploymentStateFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/SwitchoverBlueGreenDeploymentRequest" parameters: - name: Action in: query required: true schema: type: string enum: - SwitchoverBlueGreenDeployment - name: Version in: query required: true schema: type: string enum: - 2014-10-31 /#Action=SwitchoverReadReplica: get: x-aws-operation-name: SwitchoverReadReplica operationId: GET_SwitchoverReadReplica description: Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/SwitchoverReadReplicaResult" "480": description: DBInstanceNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/DBInstanceNotFoundFault" "481": description: InvalidDBInstanceStateFault content: text/xml: schema: $ref: "#/components/schemas/InvalidDBInstanceStateFault" parameters: - name: DBInstanceIdentifier in: query required: true description:The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
Must match the identiï¬er of an existing Oracle read replica DB instance.
aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\")."
Value:
allOf:
- $ref: "#/components/schemas/String"
- description: "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\")."
description: Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
DBSnapshotNotFoundFault: {} DBProxyNotFoundFault: {} DBProxyTargetGroupNotFoundFault: {} BlueGreenDeploymentNotFoundFault: {} ApplyPendingMaintenanceActionResult: type: object properties: ResourcePendingMaintenanceActions: $ref: "#/components/schemas/ResourcePendingMaintenanceActions" ResourceNotFoundFault: {} AuthorizeDBSecurityGroupIngressResult: type: object properties: DBSecurityGroup: $ref: "#/components/schemas/DBSecurityGroup" DBSecurityGroupNotFoundFault: {} InvalidDBSecurityGroupStateFault: {} AuthorizationAlreadyExistsFault: {} AuthorizationQuotaExceededFault: {} DBClusterBacktrack: type: object properties: DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. BacktrackIdentifier: allOf: - $ref: "#/components/schemas/String" - description: Contains the backtrack identifier. BacktrackTo: allOf: - $ref: "#/components/schemas/TStamp" - description: The timestamp of the time to which the DB cluster was backtracked. BacktrackedFrom: allOf: - $ref: "#/components/schemas/TStamp" - description: The timestamp of the time from which the DB cluster was backtracked. BacktrackRequestCreationTime: allOf: - $ref: "#/components/schemas/TStamp" - description: The timestamp of the time at which the backtrack was requested. Status: allOf: - $ref: "#/components/schemas/String" - description: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.
DescribeDBClusterBacktracks action.
ExportTask:
type: object
properties:
ExportTaskIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
SourceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
ExportOnly:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The data exported from the snapshot or cluster. Valid values are the following:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks action.
CharacterSetName parameter of the CreateDBInstance API isn't specified.
Image:
allOf:
- $ref: "#/components/schemas/CustomDBEngineVersionAMI"
- description: The EC2 image
DBEngineMediaType:
allOf:
- $ref: "#/components/schemas/String"
- description: A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SupportedCharacterSets:
allOf:
- $ref: "#/components/schemas/SupportedCharacterSetsList"
- description: A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
SupportedNcharCharacterSets:
allOf:
- $ref: "#/components/schemas/SupportedCharacterSetsList"
- description: A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
ValidUpgradeTarget:
allOf:
- $ref: "#/components/schemas/ValidUpgradeTargetList"
- description: A list of engine versions that this database engine version can be upgraded to.
SupportedTimezones:
allOf:
- $ref: "#/components/schemas/SupportedTimezonesList"
- description: A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
ExportableLogTypes:
allOf:
- $ref: "#/components/schemas/LogTypeList"
- description: The types of logs that the database engine has available for export to CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
SupportsReadReplica:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether the database engine version supports read replicas.
SupportedEngineModes:
allOf:
- $ref: "#/components/schemas/EngineModeList"
- description: A list of the supported DB engine modes.
SupportedFeatureNames:
allOf:
- $ref: "#/components/schemas/FeatureNameList"
- description: A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
available or deprecated.
SupportsParallelQuery:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The ARN of the custom engine version.
KMSKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The creation time of the DB engine version.
TagList:
$ref: "#/components/schemas/TagList"
SupportsBabelfish:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
CustomDBEngineVersionManifest:
allOf:
- $ref: "#/components/schemas/CustomDBEngineVersionManifest"
- description: "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. "
SupportsCertificateRotationWithoutRestart:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SupportedCACertificateIdentifiers:
allOf:
- $ref: "#/components/schemas/CACertificateIdentifiersList"
- description: 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.
description: This data type is used as a response element in the actionDescribeDBEngineVersions.
CustomDBEngineVersionAlreadyExistsFault: {}
CustomDBEngineVersionQuotaExceededFault: {}
Ec2ImagePropertiesNotSupportedFault: {}
CreateCustomDBEngineVersionFault: {}
CreateDBClusterResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
String:
type: string
IntegerOptional:
type: integer
BooleanOptional:
type: boolean
DoubleOptional:
type: number
format: double
DBClusterAlreadyExistsFault: {}
InsufficientStorageClusterCapacityFault: {}
StorageQuotaExceededFault: {}
DBSubnetGroupNotFoundFault: {}
InvalidVPCNetworkStateFault: {}
InvalidDBSubnetGroupStateFault: {}
InvalidSubnet: {}
DBSubnetGroupDoesNotCoverEnoughAZs: {}
GlobalClusterNotFoundFault: {}
InvalidGlobalClusterStateFault: {}
DomainNotFoundFault: {}
DBClusterEndpoint:
type: object
properties:
DBClusterEndpointIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterEndpointResourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
Endpoint:
allOf:
- $ref: "#/components/schemas/String"
- description: The DNS address of the endpoint.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: "The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database."
EndpointType:
allOf:
- $ref: "#/components/schemas/String"
- description: "The type of the endpoint. One of: READER, WRITER, CUSTOM."
CustomEndpointType:
allOf:
- $ref: "#/components/schemas/String"
- description: "The type associated with a custom endpoint. One of: READER, WRITER, ANY."
StaticMembers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: List of DB instance identifiers that are part of the custom endpoint group.
ExcludedMembers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: 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.
DBClusterEndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the endpoint.
description: This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
coreCount and threadsPerCore.
Value:
allOf:
- $ref: "#/components/schemas/String"
- description: The value of a processor feature name.
description: Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
DBInstanceAlreadyExistsFault: {} InsufficientDBInstanceCapacityFault: {} ProvisionedIopsNotAvailableInAZFault: {} StorageTypeNotSupportedFault: {} AuthorizationNotFoundFault: {} BackupPolicyNotFoundFault: {} NetworkTypeNotSupported: {} CertificateNotFoundFault: {} CreateDBInstanceReadReplicaResult: type: object properties: DBInstance: $ref: "#/components/schemas/DBInstance" DBSubnetGroupNotAllowedFault: {} InvalidDBSubnetGroupFault: {} CreateDBParameterGroupResult: type: object properties: DBParameterGroup: $ref: "#/components/schemas/DBParameterGroup" CreateDBProxyResponse: type: object properties: DBProxy: allOf: - $ref: "#/components/schemas/DBProxy" - description: TheDBProxy structure corresponding to the new proxy.
UserAuthConfig:
type: object
properties:
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A user-specified description about the authentication used by a proxy to log in as a specific database user.
UserName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the database user to which the proxy connects.
AuthScheme:
allOf:
- $ref: "#/components/schemas/AuthScheme"
- description: The type of authentication that the proxy uses for connections from the proxy to the underlying database.
SecretArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
IAMAuth:
allOf:
- $ref: "#/components/schemas/IAMAuthMode"
- description: Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
ClientPasswordAuthType:
allOf:
- $ref: "#/components/schemas/ClientPasswordAuthType"
- description: The type of authentication the proxy uses for connections from clients.
description: Specifies the details of authentication used by a proxy to log in as a specific database user.
DBProxyAlreadyExistsFault: {}
DBProxyQuotaExceededFault: {}
CreateDBProxyEndpointResponse:
type: object
properties:
DBProxyEndpoint:
allOf:
- $ref: "#/components/schemas/DBProxyEndpoint"
- description: The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.
DBProxyEndpointAlreadyExistsFault: {}
DBProxyEndpointQuotaExceededFault: {}
InvalidDBProxyStateFault: {}
CreateDBSecurityGroupResult:
type: object
properties:
DBSecurityGroup:
$ref: "#/components/schemas/DBSecurityGroup"
DBSecurityGroupAlreadyExistsFault: {}
DBSecurityGroupQuotaExceededFault: {}
DBSecurityGroupNotSupportedFault: {}
CreateDBSnapshotResult:
type: object
properties:
DBSnapshot:
$ref: "#/components/schemas/DBSnapshot"
CreateDBSubnetGroupResult:
type: object
properties:
DBSubnetGroup:
$ref: "#/components/schemas/DBSubnetGroup"
DBSubnetGroupAlreadyExistsFault: {}
DBSubnetGroupQuotaExceededFault: {}
DBSubnetQuotaExceededFault: {}
CreateEventSubscriptionResult:
type: object
properties:
EventSubscription:
$ref: "#/components/schemas/EventSubscription"
EventSubscriptionQuotaExceededFault: {}
SubscriptionAlreadyExistFault: {}
SNSInvalidTopicFault: {}
SNSNoAuthorizationFault: {}
SNSTopicArnNotFoundFault: {}
SubscriptionCategoryNotFoundFault: {}
CreateGlobalClusterResult:
type: object
properties:
GlobalCluster:
$ref: "#/components/schemas/GlobalCluster"
GlobalClusterAlreadyExistsFault: {}
GlobalClusterQuotaExceededFault: {}
CreateOptionGroupResult:
type: object
properties:
OptionGroup:
$ref: "#/components/schemas/OptionGroup"
DeleteBlueGreenDeploymentResponse:
type: object
properties:
BlueGreenDeployment:
$ref: "#/components/schemas/BlueGreenDeployment"
InvalidBlueGreenDeploymentStateFault: {}
CustomDBEngineVersionNotFoundFault: {}
InvalidCustomDBEngineVersionStateFault: {}
DeleteDBClusterResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
InvalidDBClusterEndpointStateFault: {}
DBClusterEndpointNotFoundFault: {}
InvalidDBParameterGroupStateFault: {}
DeleteDBClusterSnapshotResult:
type: object
properties:
DBClusterSnapshot:
$ref: "#/components/schemas/DBClusterSnapshot"
DeleteDBInstanceResult:
type: object
properties:
DBInstance:
$ref: "#/components/schemas/DBInstance"
DBInstanceAutomatedBackupQuotaExceededFault: {}
DeleteDBInstanceAutomatedBackupResult:
type: object
properties:
DBInstanceAutomatedBackup:
$ref: "#/components/schemas/DBInstanceAutomatedBackup"
InvalidDBInstanceAutomatedBackupStateFault: {}
DBInstanceAutomatedBackupNotFoundFault: {}
DeleteDBProxyResponse:
type: object
properties:
DBProxy:
allOf:
- $ref: "#/components/schemas/DBProxy"
- description: The data structure representing the details of the DB proxy that you delete.
DeleteDBProxyEndpointResponse:
type: object
properties:
DBProxyEndpoint:
allOf:
- $ref: "#/components/schemas/DBProxyEndpoint"
- description: The data structure representing the details of the DB proxy endpoint that you delete.
DBProxyEndpointNotFoundFault: {}
InvalidDBProxyEndpointStateFault: {}
DeleteDBSnapshotResult:
type: object
properties:
DBSnapshot:
$ref: "#/components/schemas/DBSnapshot"
InvalidDBSubnetStateFault: {}
DeleteEventSubscriptionResult:
type: object
properties:
EventSubscription:
$ref: "#/components/schemas/EventSubscription"
InvalidEventSubscriptionStateFault: {}
DeleteGlobalClusterResult:
type: object
properties:
GlobalCluster:
$ref: "#/components/schemas/GlobalCluster"
InvalidOptionGroupStateFault: {}
DeregisterDBProxyTargetsResponse:
type: object
properties: {}
DBProxyTargetNotFoundFault: {}
AccountAttributesMessage:
type: object
properties:
AccountQuotas:
allOf:
- $ref: "#/components/schemas/AccountQuotaList"
- description: A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
description: Data returned by the DescribeAccountAttributes action.
DescribeBlueGreenDeploymentsResponse:
type: object
properties:
BlueGreenDeployments:
allOf:
- $ref: "#/components/schemas/BlueGreenDeploymentList"
- description: Contains a list of blue/green deployments for the user.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token that can be used in a later DescribeBlueGreenDeployments request.
Filter:
type: object
required:
- Name
- Values
properties:
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the filter. Filter names are case-sensitive.
Values:
allOf:
- $ref: "#/components/schemas/FilterValueList"
- description: One or more filter values. Filter values are case-sensitive.
description: A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
Certificate objects for the Amazon Web Services account.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
description: Data returned by the DescribeCertificates action.
DBClusterBacktrackMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token that can be used in a later DescribeDBClusterBacktracks request.
DBClusterBacktracks:
allOf:
- $ref: "#/components/schemas/DBClusterBacktrackList"
- description: Contains a list of backtracks for the user.
description: Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
DBClusterBacktrackNotFoundFault: {}
DBClusterEndpointMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBClusterEndpoints:
allOf:
- $ref: "#/components/schemas/DBClusterEndpointList"
- description: Contains the details of the endpoints associated with the cluster and matching any filter conditions.
DBClusterParameterGroupsMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBClusterParameterGroups:
allOf:
- $ref: "#/components/schemas/DBClusterParameterGroupList"
- description: A list of DB cluster parameter groups.
description:
DBClusterParameterGroupDetails:
type: object
properties:
Parameters:
allOf:
- $ref: "#/components/schemas/ParametersList"
- description: Provides a list of parameters for the DB cluster parameter group.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description: Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
DescribeDBClusterSnapshotAttributesResult:
type: object
properties:
DBClusterSnapshotAttributesResult:
$ref: "#/components/schemas/DBClusterSnapshotAttributesResult"
DBClusterSnapshotMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBClusterSnapshots:
allOf:
- $ref: "#/components/schemas/DBClusterSnapshotList"
- description: Provides a list of DB cluster snapshots for the user.
description: Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
DBClusterMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token that can be used in a later DescribeDBClusters request.
DBClusters:
allOf:
- $ref: "#/components/schemas/DBClusterList"
- description: Contains a list of DB clusters for the user.
description: Contains the result of a successful invocation of the DescribeDBClusters action.
DBEngineVersionMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DBEngineVersions:
allOf:
- $ref: "#/components/schemas/DBEngineVersionList"
- description: A list of DBEngineVersion elements.
description: Contains the result of a successful invocation of the DescribeDBEngineVersions action.
DBInstanceAutomatedBackupMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DBInstanceAutomatedBackups:
allOf:
- $ref: "#/components/schemas/DBInstanceAutomatedBackupList"
- description: A list of DBInstanceAutomatedBackup instances.
description: Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
DBInstanceMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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 .
DBInstances:
allOf:
- $ref: "#/components/schemas/DBInstanceList"
- description: A list of DBInstance instances.
description: Contains the result of a successful invocation of the DescribeDBInstances action.
DescribeDBLogFilesResponse:
type: object
properties:
DescribeDBLogFiles:
allOf:
- $ref: "#/components/schemas/DescribeDBLogFilesList"
- description: The DB log files returned.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token that can be used in a later DescribeDBLogFiles request.
description: The response from a call to DescribeDBLogFiles.
DBParameterGroupsMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DBParameterGroups:
allOf:
- $ref: "#/components/schemas/DBParameterGroupList"
- description: A list of DBParameterGroup instances.
description: Contains the result of a successful invocation of the DescribeDBParameterGroups action.
DBParameterGroupDetails:
type: object
properties:
Parameters:
allOf:
- $ref: "#/components/schemas/ParametersList"
- description: A list of Parameter values.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
description: Contains the result of a successful invocation of the DescribeDBParameters action.
DescribeDBProxiesResponse:
type: object
properties:
DBProxies:
allOf:
- $ref: "#/components/schemas/DBProxyList"
- description: A return value representing an arbitrary number of DBProxy data structures.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DescribeDBProxyEndpointsResponse:
type: object
properties:
DBProxyEndpoints:
allOf:
- $ref: "#/components/schemas/DBProxyEndpointList"
- description: The list of ProxyEndpoint objects returned by the API operation.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DescribeDBProxyTargetGroupsResponse:
type: object
properties:
TargetGroups:
allOf:
- $ref: "#/components/schemas/TargetGroupList"
- description: An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DescribeDBProxyTargetsResponse:
type: object
properties:
Targets:
allOf:
- $ref: "#/components/schemas/TargetList"
- description: An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DBSecurityGroupMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DBSecurityGroups:
allOf:
- $ref: "#/components/schemas/DBSecurityGroups"
- description: A list of DBSecurityGroup instances.
description: Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
DescribeDBSnapshotAttributesResult:
type: object
properties:
DBSnapshotAttributesResult:
$ref: "#/components/schemas/DBSnapshotAttributesResult"
DBSnapshotMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DBSnapshots:
allOf:
- $ref: "#/components/schemas/DBSnapshotList"
- description: A list of DBSnapshot instances.
description: Contains the result of a successful invocation of the DescribeDBSnapshots action.
DBSubnetGroupMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DBSubnetGroups:
allOf:
- $ref: "#/components/schemas/DBSubnetGroups"
- description: A list of DBSubnetGroup instances.
description: Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
DescribeEngineDefaultClusterParametersResult:
type: object
properties:
EngineDefaults:
$ref: "#/components/schemas/EngineDefaults"
DescribeEngineDefaultParametersResult:
type: object
properties:
EngineDefaults:
$ref: "#/components/schemas/EngineDefaults"
EventCategoriesMessage:
type: object
properties:
EventCategoriesMapList:
allOf:
- $ref: "#/components/schemas/EventCategoriesMapList"
- description: A list of EventCategoriesMap data types.
description: Data returned from the DescribeEventCategories operation.
EventSubscriptionsMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
EventSubscriptionsList:
allOf:
- $ref: "#/components/schemas/EventSubscriptionsList"
- description: A list of EventSubscriptions data types.
description: Data returned by the DescribeEventSubscriptions action.
EventsMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
Events:
allOf:
- $ref: "#/components/schemas/EventList"
- description: A list of Event instances.
description: Contains the result of a successful invocation of the DescribeEvents action.
ExportTasksMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.
ExportTasks:
allOf:
- $ref: "#/components/schemas/ExportTasksList"
- description: Information about an export of a snapshot or cluster to Amazon S3.
GlobalClustersMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
GlobalClusters:
allOf:
- $ref: "#/components/schemas/GlobalClusterList"
- description: The list of global clusters returned by this request.
OptionGroupOptionsMessage:
type: object
properties:
OptionGroupOptions:
$ref: "#/components/schemas/OptionGroupOptionsList"
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
description:
OptionGroups:
type: object
properties:
OptionGroupsList:
allOf:
- $ref: "#/components/schemas/OptionGroupsList"
- description: List of option groups.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
description: List of option groups.
OrderableDBInstanceOptionsMessage:
type: object
properties:
OrderableDBInstanceOptions:
allOf:
- $ref: "#/components/schemas/OrderableDBInstanceOptionsList"
- description: An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description: Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
PendingMaintenanceActionsMessage:
type: object
properties:
PendingMaintenanceActions:
allOf:
- $ref: "#/components/schemas/PendingMaintenanceActions"
- description: A list of the pending maintenance actions for the resource.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
description: Data returned from the DescribePendingMaintenanceActions action.
ReservedDBInstanceMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
ReservedDBInstances:
allOf:
- $ref: "#/components/schemas/ReservedDBInstanceList"
- description: A list of reserved DB instances.
description: Contains the result of a successful invocation of the DescribeReservedDBInstances action.
ReservedDBInstanceNotFoundFault: {}
ReservedDBInstancesOfferingMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
ReservedDBInstancesOfferings:
allOf:
- $ref: "#/components/schemas/ReservedDBInstancesOfferingList"
- description: A list of reserved DB instance offerings.
description: Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
ReservedDBInstancesOfferingNotFoundFault: {}
SourceRegionMessage:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
SourceRegions:
allOf:
- $ref: "#/components/schemas/SourceRegionList"
- description: A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
description: Contains the result of a successful invocation of the DescribeSourceRegions action.
DescribeValidDBInstanceModificationsResult:
type: object
properties:
ValidDBInstanceModificationsMessage:
$ref: "#/components/schemas/ValidDBInstanceModificationsMessage"
DownloadDBLogFilePortionDetails:
type: object
properties:
LogFileData:
allOf:
- $ref: "#/components/schemas/String"
- description: Entries from the specified log file.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token that can be used in a later DownloadDBLogFilePortion request.
AdditionalDataPending:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Boolean value that if true, indicates there is more data to be downloaded.
description: This data type is used as a response element to DownloadDBLogFilePortion.
DBLogFileNotFoundFault: {}
FailoverDBClusterResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
FailoverGlobalClusterResult:
type: object
properties:
GlobalCluster:
$ref: "#/components/schemas/GlobalCluster"
TagListMessage:
type: object
properties:
TagList:
allOf:
- $ref: "#/components/schemas/TagList"
- description: List of tags returned by the ListTagsForResource operation.
description:
ModifyActivityStreamResponse:
type: object
properties:
KmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
KinesisStreamName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Amazon Kinesis data stream to be used for the database activity stream.
Status:
allOf:
- $ref: "#/components/schemas/ActivityStreamStatus"
- description: The status of the modification to the database activity stream.
Mode:
allOf:
- $ref: "#/components/schemas/ActivityStreamMode"
- description: The mode of the database activity stream.
EngineNativeAuditFieldsIncluded:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Indicates whether engine-native audit fields are included in the database activity stream.
PolicyStatus:
allOf:
- $ref: "#/components/schemas/ActivityStreamPolicyStatus"
- description: The status of the modification to the policy state of the database activity stream.
ModifyCertificatesResult:
type: object
properties:
Certificate:
$ref: "#/components/schemas/Certificate"
DBClusterCapacityInfo:
type: object
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
PendingCapacity:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: A value that specifies the capacity that the DB cluster scales to next.
CurrentCapacity:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The current capacity of the DB cluster.
SecondsBeforeTimeout:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
TimeoutAction:
allOf:
- $ref: "#/components/schemas/String"
- description: The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
InvalidDBClusterCapacityFault: {}
ModifyDBClusterResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
LogTypeList:
type: array
items:
$ref: "#/components/schemas/String"
DBClusterParameterGroupNameMessage:
type: object
properties:
DBClusterParameterGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The earliest engine version to which the parameter can apply.
ApplyMethod:
allOf:
- $ref: "#/components/schemas/ApplyMethod"
- description: Indicates when to apply parameter updates.
SupportedEngineModes:
allOf:
- $ref: "#/components/schemas/EngineModeList"
- description: The valid DB engine modes.
description: This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ModifyDBParameterGroup or ResetDBParameterGroup action.
ModifyDBProxyResponse:
type: object
properties:
DBProxy:
allOf:
- $ref: "#/components/schemas/DBProxy"
- description: The DBProxy object representing the new settings for the proxy.
ModifyDBProxyEndpointResponse:
type: object
properties:
DBProxyEndpoint:
allOf:
- $ref: "#/components/schemas/DBProxyEndpoint"
- description: The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.
ModifyDBProxyTargetGroupResponse:
type: object
properties:
DBProxyTargetGroup:
allOf:
- $ref: "#/components/schemas/DBProxyTargetGroup"
- description: The settings of the modified DBProxyTarget.
StringList:
type: array
items:
$ref: "#/components/schemas/String"
ModifyDBSnapshotResult:
type: object
properties:
DBSnapshot:
$ref: "#/components/schemas/DBSnapshot"
ModifyDBSnapshotAttributeResult:
type: object
properties:
DBSnapshotAttributesResult:
$ref: "#/components/schemas/DBSnapshotAttributesResult"
ModifyDBSubnetGroupResult:
type: object
properties:
DBSubnetGroup:
$ref: "#/components/schemas/DBSubnetGroup"
SubnetAlreadyInUse: {}
ModifyEventSubscriptionResult:
type: object
properties:
EventSubscription:
$ref: "#/components/schemas/EventSubscription"
ModifyGlobalClusterResult:
type: object
properties:
GlobalCluster:
$ref: "#/components/schemas/GlobalCluster"
ModifyOptionGroupResult:
type: object
properties:
OptionGroup:
$ref: "#/components/schemas/OptionGroup"
OptionConfiguration:
type: object
required:
- OptionName
properties:
OptionName:
allOf:
- $ref: "#/components/schemas/String"
- description: The configuration of options to include in a group.
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The optional port for the option.
OptionVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The version for the option.
DBSecurityGroupMemberships:
allOf:
- $ref: "#/components/schemas/DBSecurityGroupNameList"
- description: A list of DBSecurityGroupMembership name strings used for this option.
VpcSecurityGroupMemberships:
allOf:
- $ref: "#/components/schemas/VpcSecurityGroupIdList"
- description: A list of VpcSecurityGroupMembership name strings used for this option.
OptionSettings:
allOf:
- $ref: "#/components/schemas/OptionSettingsList"
- description: The option settings to include in an option group.
description: A list of all available options
PromoteReadReplicaResult:
type: object
properties:
DBInstance:
$ref: "#/components/schemas/DBInstance"
PromoteReadReplicaDBClusterResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
PurchaseReservedDBInstancesOfferingResult:
type: object
properties:
ReservedDBInstance:
$ref: "#/components/schemas/ReservedDBInstance"
ReservedDBInstanceAlreadyExistsFault: {}
ReservedDBInstanceQuotaExceededFault: {}
RebootDBClusterResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
RebootDBInstanceResult:
type: object
properties:
DBInstance:
$ref: "#/components/schemas/DBInstance"
RegisterDBProxyTargetsResponse:
type: object
properties:
DBProxyTargets:
allOf:
- $ref: "#/components/schemas/TargetList"
- description: One or more DBProxyTarget objects that are created when you register targets with a target group.
DBProxyTargetAlreadyRegisteredFault: {}
InsufficientAvailableIPsInSubnetFault: {}
RemoveFromGlobalClusterResult:
type: object
properties:
GlobalCluster:
$ref: "#/components/schemas/GlobalCluster"
DBClusterRoleNotFoundFault: {}
DBInstanceRoleNotFoundFault: {}
RemoveSourceIdentifierFromSubscriptionResult:
type: object
properties:
EventSubscription:
$ref: "#/components/schemas/EventSubscription"
RestoreDBClusterFromS3Result:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
InvalidS3BucketFault: {}
RestoreDBClusterFromSnapshotResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
InsufficientDBClusterCapacityFault: {}
InvalidRestoreFault: {}
RestoreDBClusterToPointInTimeResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
RestoreDBInstanceFromDBSnapshotResult:
type: object
properties:
DBInstance:
$ref: "#/components/schemas/DBInstance"
RestoreDBInstanceFromS3Result:
type: object
properties:
DBInstance:
$ref: "#/components/schemas/DBInstance"
RestoreDBInstanceToPointInTimeResult:
type: object
properties:
DBInstance:
$ref: "#/components/schemas/DBInstance"
PointInTimeRestoreNotEnabledFault: {}
RevokeDBSecurityGroupIngressResult:
type: object
properties:
DBSecurityGroup:
$ref: "#/components/schemas/DBSecurityGroup"
StartActivityStreamResponse:
type: object
properties:
KmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
KinesisStreamName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Amazon Kinesis data stream to be used for the database activity stream.
Status:
allOf:
- $ref: "#/components/schemas/ActivityStreamStatus"
- description: The status of the database activity stream.
Mode:
allOf:
- $ref: "#/components/schemas/ActivityStreamMode"
- description: The mode of the database activity stream.
ApplyImmediately:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
EngineNativeAuditFieldsIncluded:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Indicates whether engine-native audit fields are included in the database activity stream.
StartDBClusterResult:
type: object
properties:
DBCluster:
$ref: "#/components/schemas/DBCluster"
StartDBInstanceResult:
type: object
properties:
DBInstance:
$ref: "#/components/schemas/DBInstance"
StartDBInstanceAutomatedBackupsReplicationResult:
type: object
properties:
DBInstanceAutomatedBackup:
$ref: "#/components/schemas/DBInstanceAutomatedBackup"
ExportTaskAlreadyExistsFault: {}
IamRoleNotFoundFault: {}
IamRoleMissingPermissionsFault: {}
InvalidExportOnlyFault: {}
InvalidExportSourceStateFault: {}
StopActivityStreamResponse:
type: object
properties:
KmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
KinesisStreamName: allOf: - $ref: "#/components/schemas/String" - description: The name of the Amazon Kinesis data stream used for the database activity stream. Status: allOf: - $ref: "#/components/schemas/ActivityStreamStatus" - description: The status of the database activity stream. StopDBClusterResult: type: object properties: DBCluster: $ref: "#/components/schemas/DBCluster" StopDBInstanceResult: type: object properties: DBInstance: $ref: "#/components/schemas/DBInstance" StopDBInstanceAutomatedBackupsReplicationResult: type: object properties: DBInstanceAutomatedBackup: $ref: "#/components/schemas/DBInstanceAutomatedBackup" SwitchoverBlueGreenDeploymentResponse: type: object properties: BlueGreenDeployment: $ref: "#/components/schemas/BlueGreenDeployment" SwitchoverReadReplicaResult: type: object properties: DBInstance: $ref: "#/components/schemas/DBInstance" AccountQuotaList: type: array items: allOf: - $ref: "#/components/schemas/AccountQuota" - xml: name: AccountQuota Long: type: integer AccountQuota: type: object properties: AccountQuotaName: allOf: - $ref: "#/components/schemas/String" - description: The name of the Amazon RDS quota for this Amazon Web Services account. Used: allOf: - $ref: "#/components/schemas/Long" - description: The amount currently used toward the quota maximum. Max: allOf: - $ref: "#/components/schemas/Long" - description: The maximum allowed value for the quota. description:Describes a quota for an Amazon Web Services account.
The following are account quotas:
AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.
AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.
CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.
DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.
DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.
DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.
DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.
DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.
Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.
DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.
DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.
DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.
EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.
ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.
ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.
OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.
ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.
ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.
SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.
ActivityStreamMode: type: string enum: - sync - async ActivityStreamModeList: type: array items: $ref: "#/components/schemas/String" ActivityStreamPolicyStatus: type: string enum: - locked - unlocked - locking-policy - unlocking-policy ActivityStreamStatus: type: string enum: - stopped - starting - started - stopping AddRoleToDBClusterMessage: type: object required: - DBClusterIdentifier - RoleArn title: AddRoleToDBClusterMessage properties: DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: The name of the DB cluster to associate the IAM role with. RoleArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for examplearn:aws:iam::123456789012:role/AuroraAccessRole.
FeatureName:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
AddRoleToDBInstanceMessage:
type: object
required:
- DBInstanceIdentifier
- RoleArn
- FeatureName
title: AddRoleToDBInstanceMessage
properties:
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB instance to associate the IAM role with.
RoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
FeatureName:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
AddSourceIdentifierToSubscriptionMessage:
type: object
required:
- SubscriptionName
- SourceIdentifier
title: AddSourceIdentifierToSubscriptionMessage
properties:
SubscriptionName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the RDS event notification subscription you want to add a source identifier to.
SourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
' SubscriptionCreationTime: allOf: - $ref: "#/components/schemas/String" - description: The time the RDS event notification subscription was created. SourceType: allOf: - $ref: "#/components/schemas/String" - description: The source type for the RDS event notification subscription. SourceIdsList: allOf: - $ref: "#/components/schemas/SourceIdsList" - description: A list of source IDs for the RDS event notification subscription. EventCategoriesList: allOf: - $ref: "#/components/schemas/EventCategoriesList" - description: A list of event categories for the RDS event notification subscription. Enabled: allOf: - $ref: "#/components/schemas/Boolean" - description: A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled. EventSubscriptionArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) for the event subscription. description: Contains the results of a successful invocation of theDescribeEventSubscriptions action.
TagList:
type: array
description: 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. '
items:
allOf:
- $ref: "#/components/schemas/Tag"
- xml:
name: Tag
AddTagsToResourceMessage:
type: object
required:
- ResourceName
- Tags
title: AddTagsToResourceMessage
properties:
ResourceName:
allOf:
- $ref: "#/components/schemas/String"
- description: 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:
allOf:
- $ref: "#/components/schemas/TagList"
- description: The tags to be assigned to the Amazon RDS resource.
description:
ApplyMethod:
type: string
enum:
- immediate
- pending-reboot
ApplyPendingMaintenanceActionMessage:
type: object
required:
- ResourceIdentifier
- ApplyAction
- OptInType
title: ApplyPendingMaintenanceActionMessage
properties:
ResourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: 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).
ApplyAction:
allOf:
- $ref: "#/components/schemas/String"
- description: "The pending maintenance action to apply to this resource.
Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.
Valid values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
EC2SecurityGroupId:
allOf:
- $ref: "#/components/schemas/String"
- description: Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
EC2SecurityGroupOwnerId:
allOf:
- $ref: "#/components/schemas/String"
- description: Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
description:
DBSecurityGroup:
type: object
properties:
OwnerId:
allOf:
- $ref: "#/components/schemas/String"
- description: Provides the Amazon Web Services ID of the owner of a specific DB security group.
DBSecurityGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the name of the DB security group.
DBSecurityGroupDescription:
allOf:
- $ref: "#/components/schemas/String"
- description: Provides the description of the DB security group.
VpcId:
allOf:
- $ref: "#/components/schemas/String"
- description: Provides the VpcId of the DB security group.
EC2SecurityGroups:
allOf:
- $ref: "#/components/schemas/EC2SecurityGroupList"
- description: Contains a list of EC2SecurityGroup elements.
IPRanges:
allOf:
- $ref: "#/components/schemas/IPRangeList"
- description: Contains a list of IPRange elements.
DBSecurityGroupArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the DB security group.
description: Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups action.
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
coreCount and threadsPerCore.
DefaultValue:
allOf:
- $ref: "#/components/schemas/String"
- description: The default value for the processor feature of the DB instance class.
AllowedValues:
allOf:
- $ref: "#/components/schemas/String"
- description: The allowed values for the processor feature of the DB instance class.
description: Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
AvailableProcessorFeatureList: type: array items: allOf: - $ref: "#/components/schemas/AvailableProcessorFeature" - xml: name: AvailableProcessorFeature AwsBackupRecoveryPointArn: type: string pattern: ^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\-]+:)?[a-z][a-z0-9\-]{0,255}$ minLength: 43 maxLength: 350 TStamp: type: string format: date-time BacktrackDBClusterMessage: type: object required: - DBClusterIdentifier - BacktrackTo title: BacktrackDBClusterMessage properties: DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "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
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
The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
Target: allOf: - $ref: "#/components/schemas/DatabaseArn" - description:The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
SwitchoverDetails: allOf: - $ref: "#/components/schemas/SwitchoverDetailList" - description: The details about each source and target resource in the blue/green deployment. Tasks: allOf: - $ref: "#/components/schemas/BlueGreenDeploymentTaskList" - description: Either tasks to be performed or tasks that have been completed on the target database before switchover. Status: allOf: - $ref: "#/components/schemas/BlueGreenDeploymentStatus" - description:The status of the blue/green deployment.
Values:
PROVISIONING - Resources are being created in the green environment.
AVAILABLE - Resources are available in the green environment.
SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.
SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.
SWITCHOVER_FAILED - Switchover was attempted but failed.
DELETING - The blue/green deployment is being deleted.
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.
BlueGreenDeploymentList: type: array items: $ref: "#/components/schemas/BlueGreenDeployment" BlueGreenDeploymentTaskName: type: string BlueGreenDeploymentTaskStatus: type: string BlueGreenDeploymentTask: type: object properties: Name: allOf: - $ref: "#/components/schemas/BlueGreenDeploymentTaskName" - description: The name of the blue/green deployment task. Status: allOf: - $ref: "#/components/schemas/BlueGreenDeploymentTaskStatus" - description:The status of the blue/green deployment task.
Values:
PENDING - The resources are being prepared for deployment.
IN_PROGRESS - The resource is being deployed.
COMPLETED - The resource has been deployed.
FAILED - Deployment of the resource failed.
Contains the details about a task for a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Boolean: type: boolean BucketName: type: string pattern: .* minLength: 3 maxLength: 63 CACertificateIdentifiersList: type: array items: $ref: "#/components/schemas/String" CancelExportTaskMessage: type: object required: - ExportTaskIdentifier title: CancelExportTaskMessage properties: ExportTaskIdentifier: allOf: - $ref: "#/components/schemas/String" - description: The identifier of the snapshot or cluster export task to cancel. Certificate: type: object properties: CertificateIdentifier: allOf: - $ref: "#/components/schemas/String" - description: The unique key that identifies a certificate. CertificateType: allOf: - $ref: "#/components/schemas/String" - description: The type of the certificate. Thumbprint: allOf: - $ref: "#/components/schemas/String" - description: The thumbprint of the certificate. ValidFrom: allOf: - $ref: "#/components/schemas/TStamp" - description: The starting date from which the certificate is valid. ValidTill: allOf: - $ref: "#/components/schemas/TStamp" - description: The final date that the certificate continues to be valid. CertificateArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) for the certificate. CustomerOverride: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Whether there is an override for the default certificate identifier. CustomerOverrideValidTill: allOf: - $ref: "#/components/schemas/TStamp" - description: If there is an override for the default certificate identifier, when the override expires. description:A CA certificate for an Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
CertificateDetails: type: object properties: CAIdentifier: allOf: - $ref: "#/components/schemas/String" - description: The CA identifier of the CA certificate used for the DB instance's server certificate. ValidTill: allOf: - $ref: "#/components/schemas/TStamp" - description: The expiration date of the DB instance's server certificate. description:Returns the details of the DB instance's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
CertificateList: type: array items: allOf: - $ref: "#/components/schemas/Certificate" - xml: name: Certificate CharacterSet: type: object properties: CharacterSetName: allOf: - $ref: "#/components/schemas/String" - description: The name of the character set. CharacterSetDescription: allOf: - $ref: "#/components/schemas/String" - description: The description of the character set. description: This data type is used as a response element in the actionDescribeDBEngineVersions.
ClientPasswordAuthType:
type: string
enum:
- MYSQL_NATIVE_PASSWORD
- POSTGRES_SCRAM_SHA_256
- POSTGRES_MD5
- SQL_SERVER_AUTHENTICATION
CloudwatchLogsExportConfiguration:
type: object
properties:
EnableLogTypes:
allOf:
- $ref: "#/components/schemas/LogTypeList"
- description: The list of log types to enable.
DisableLogTypes:
allOf:
- $ref: "#/components/schemas/LogTypeList"
- description: The list of log types to disable.
description: The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
PendingCloudwatchLogsExports: type: object properties: LogTypesToEnable: allOf: - $ref: "#/components/schemas/LogTypeList" - description: Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. LogTypesToDisable: allOf: - $ref: "#/components/schemas/LogTypeList" - description: Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. description: A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. ClusterPendingModifiedValues: type: object properties: PendingCloudwatchLogsExports: $ref: "#/components/schemas/PendingCloudwatchLogsExports" DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: The DBClusterIdentifier value for the DB cluster. MasterUserPassword: allOf: - $ref: "#/components/schemas/String" - description: The master credentials for the DB cluster. IAMDatabaseAuthenticationEnabled: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. EngineVersion: allOf: - $ref: "#/components/schemas/String" - description: The database engine version. BackupRetentionPeriod: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The number of days for which automatic DB snapshots are retained. AllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora,AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
Iops:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
description: This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.
ConnectionPoolConfiguration:
type: object
properties:
MaxConnectionsPercent:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints: Must be between 1 and 100.
" MaxIdleConnectionsPercent: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
Default: 120
Constraints: between 1 and 3600, or 0 representing unlimited
" SessionPinningFilters: allOf: - $ref: "#/components/schemas/StringList" - description: "Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters
" InitQuery: allOf: - $ref: "#/components/schemas/String" - description: "One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
Default: no initialization query
" description: Specifies the settings that control the size and behavior of the connection pool associated with aDBProxyTargetGroup.
Integer:
type: integer
ConnectionPoolConfigurationInfo:
type: object
properties:
MaxConnectionsPercent:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
MaxIdleConnectionsPercent:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
ConnectionBorrowTimeout:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
SessionPinningFilters:
allOf:
- $ref: "#/components/schemas/StringList"
- description: Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
InitQuery:
allOf:
- $ref: "#/components/schemas/String"
- description: One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
description: Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.
CopyDBClusterParameterGroupMessage:
type: object
required:
- SourceDBClusterParameterGroupIdentifier
- TargetDBClusterParameterGroupIdentifier
- TargetDBClusterParameterGroupDescription
title: CopyDBClusterParameterGroupMessage
properties:
SourceDBClusterParameterGroupIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
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
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
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
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
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) for the DB cluster snapshot. SourceDBClusterSnapshotArn: allOf: - $ref: "#/components/schemas/String" - description: If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value. IAMDatabaseAuthenticationEnabled: allOf: - $ref: "#/components/schemas/Boolean" - description: True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. TagList: $ref: "#/components/schemas/TagList" DBSystemId: allOf: - $ref: "#/components/schemas/String" - description: Reserved for future use. description:Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
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.
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
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
Constraints:
Must specify a valid system snapshot in the "available" state.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
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
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.
Tags: $ref: "#/components/schemas/TagList" CopyTags: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: 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. PreSignedUrl: allOf: - $ref: "#/components/schemas/String" - description: "When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
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.
TargetCustomAvailabilityZone: allOf: - $ref: "#/components/schemas/String" - description: "The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv.
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) for the DB snapshot. Timezone: allOf: - $ref: "#/components/schemas/String" - description: The time zone of the DB snapshot. In most cases, theTimezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
ProcessorFeatures:
allOf:
- $ref: "#/components/schemas/ProcessorFeatureList"
- description: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
DbiResourceId:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList:
$ref: "#/components/schemas/TagList"
OriginalSnapshotCreateTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotDatabaseTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
SnapshotTarget: allOf: - $ref: "#/components/schemas/String" - description: "Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region." StorageThroughput: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: Specifies the storage throughput for the DB snapshot. description:Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
The identifier for the source option group.
Constraints:
Must specify a valid option group.
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
true indicates the option group can be applied to both VPC and non-VPC instances.
VpcId:
allOf:
- $ref: "#/components/schemas/String"
- description: If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
OptionGroupArn:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the Amazon Resource Name (ARN) for the option group.
SourceOptionGroup:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the name of the option group from which this option group is copied.
SourceAccountId:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the Amazon Web Services account ID for the option group from which this option group is copied.
CopyTimestamp:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: Indicates when the option group was copied.
description:
TargetEngineVersion:
type: string
pattern: "[0-9A-Za-z-_.]+"
minLength: 1
maxLength: 64
TargetDBParameterGroupName:
type: string
pattern: "[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]"
minLength: 1
maxLength: 255
TargetDBClusterParameterGroupName:
type: string
pattern: "[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]"
minLength: 1
maxLength: 255
CreateBlueGreenDeploymentRequest:
type: object
required:
- BlueGreenDeploymentName
- Source
title: CreateBlueGreenDeploymentRequest
properties:
BlueGreenDeploymentName:
allOf:
- $ref: "#/components/schemas/BlueGreenDeploymentName"
- description: 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.
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.
TargetEngineVersion: allOf: - $ref: "#/components/schemas/TargetEngineVersion" - description:The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
TargetDBParameterGroupName: allOf: - $ref: "#/components/schemas/TargetDBParameterGroupName" - description: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.
TargetDBClusterParameterGroupName: allOf: - $ref: "#/components/schemas/TargetDBClusterParameterGroupName" - description: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.
Tags: allOf: - $ref: "#/components/schemas/TagList" - description: Tags to assign to the blue/green deployment. CustomEngineName: type: string pattern: ^[A-Za-z0-9-]{1,35}$ minLength: 1 maxLength: 35 CustomEngineVersion: type: string pattern: ^[a-z0-9_.-]{1,60}$ minLength: 1 maxLength: 60 String255: type: string pattern: .* minLength: 1 maxLength: 255 KmsKeyIdOrArn: type: string pattern: "[a-zA-Z0-9_:\\-\\/]+" minLength: 1 maxLength: 2048 Description: type: string pattern: .* minLength: 1 maxLength: 1000 CustomDBEngineVersionManifest: type: string pattern: "[\\s\\S]*" minLength: 1 maxLength: 51000 CreateCustomDBEngineVersionMessage: type: object required: - Engine - EngineVersion title: CreateCustomDBEngineVersionMessage properties: Engine: allOf: - $ref: "#/components/schemas/CustomEngineName" - description: The database engine to use for your custom engine version (CEV). The only supported value iscustom-oracle-ee.
EngineVersion:
allOf:
- $ref: "#/components/schemas/CustomEngineVersion"
- description: 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 of Engine and EngineVersion is unique per customer per Region.
DatabaseInstallationFilesS3BucketName:
allOf:
- $ref: "#/components/schemas/BucketName"
- description: 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:
allOf:
- $ref: "#/components/schemas/String255"
- description: 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.
ImageId:
allOf:
- $ref: "#/components/schemas/String255"
- description: The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
KMSKeyId:
allOf:
- $ref: "#/components/schemas/KmsKeyIdOrArn"
- description: 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.
Description: allOf: - $ref: "#/components/schemas/Description" - description: An optional description of your CEV. Manifest: allOf: - $ref: "#/components/schemas/CustomDBEngineVersionManifest" - description: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:
Version of the CEV manifest. The date is in the format YYYY-MM-DD.
Ordered list of installation files for the CEV.
Ordered list of OPatch installers used for the Oracle DB engine.
The PSU and RU patches for this CEV.
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: $ref: "#/components/schemas/TagList" CreateDBClusterEndpointMessage: type: object required: - DBClusterIdentifier - DBClusterEndpointIdentifier - EndpointType title: CreateDBClusterEndpointMessage properties: DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. DBClusterEndpointIdentifier: allOf: - $ref: "#/components/schemas/String" - description: The identifier to use for the new endpoint. This parameter is stored as a lowercase string. EndpointType: allOf: - $ref: "#/components/schemas/String" - description: "The type of the endpoint, one of:READER, WRITER, ANY."
StaticMembers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: List of DB instance identifiers that are part of the custom endpoint group.
ExcludedMembers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: 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.
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: The tags to be assigned to the Amazon RDS resource.
VpcSecurityGroupIdList:
type: array
items:
allOf:
- $ref: "#/components/schemas/String"
- xml:
name: VpcSecurityGroupId
LongOptional:
type: integer
ScalingConfiguration:
type: object
properties:
MinCapacity:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction: allOf: - $ref: "#/components/schemas/String" - description:The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
SecondsBeforeTimeout: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
description:Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
ServerlessV2ScalingConfiguration: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. MaxCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. description:Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
CreateDBClusterMessage: type: object required: - DBClusterIdentifier - Engine title: CreateDBClusterMessage properties: AvailabilityZones: allOf: - $ref: "#/components/schemas/AvailabilityZones" - description: '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
' BackupRetentionPeriod: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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: allOf: - $ref: "#/components/schemas/String" - description: "A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
" DatabaseName: allOf: - $ref: "#/components/schemas/String" - description: "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
" DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "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-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" DBClusterParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: "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
" VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: "A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" DBSubnetGroupName: allOf: - $ref: "#/components/schemas/String" - description: "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: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Engine: allOf: - $ref: "#/components/schemas/String" - description: "The name of the database engine to be used for this DB cluster.
Valid Values:
aurora-mysql
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" EngineVersion: allOf: - $ref: "#/components/schemas/String" - description: 'The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
For information, see Database engine updates for Amazon Aurora MySQL 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 Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' Port: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" MasterUsername: allOf: - $ref: "#/components/schemas/String" - description: "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
" MasterUserPassword: allOf: - $ref: "#/components/schemas/String" - description: "The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description: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.
PreferredBackupWindow: allOf: - $ref: "#/components/schemas/String" - description: 'The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' PreferredMaintenanceWindow: allOf: - $ref: "#/components/schemas/String" - description: 'The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred 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
' ReplicationSourceIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "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 Multi-AZ DB clusters
" Tags: allOf: - $ref: "#/components/schemas/TagList" - description: "Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" StorageEncrypted: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" KmsKeyId: allOf: - $ref: "#/components/schemas/String" - description: "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn'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 KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" PreSignedUrl: allOf: - $ref: "#/components/schemas/String" - description: "When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.
The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
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
" BacktrackWindow: allOf: - $ref: "#/components/schemas/LongOptional" - description: "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
" EnableCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description: '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, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
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
' EngineMode: allOf: - $ref: "#/components/schemas/String" - description: 'The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
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
' ScalingConfiguration: allOf: - $ref: "#/components/schemas/ScalingConfiguration" - description: "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" GlobalClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "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
" EnableHttpEndpoint: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: '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
' CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" Domain: allOf: - $ref: "#/components/schemas/String" - description: '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: allOf: - $ref: "#/components/schemas/String" - description: "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
" EnableGlobalWriteForwarding: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" DBClusterInstanceClass: allOf: - $ref: "#/components/schemas/String" - description: '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
' AllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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
" StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
" Iops: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
' PubliclyAccessible: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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 DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
" AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" MonitoringInterval: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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 MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
" MonitoringRoleArn: allOf: - $ref: "#/components/schemas/String" - description: 'The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
' EnablePerformanceInsights: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: '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
' PerformanceInsightsKMSKeyId: allOf: - $ref: "#/components/schemas/String" - description: "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: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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
" ServerlessV2ScalingConfiguration: $ref: "#/components/schemas/ServerlessV2ScalingConfiguration" NetworkType: allOf: - $ref: "#/components/schemas/String" - description: 'The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' DBSystemId: allOf: - $ref: "#/components/schemas/String" - description: Reserved for future use. ManageMasterUserPassword: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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 MasterUserPassword is specified.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" MasterUserSecretKmsKeyId: allOf: - $ref: "#/components/schemas/String" - description: "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 the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" SourceRegion: allOf: - $ref: "#/components/schemas/String" - description: The ID of the region that contains the source for the read replica. description: CreateDBClusterParameterGroupMessage: type: object required: - DBClusterParameterGroupName - DBParameterGroupFamily - Description title: CreateDBClusterParameterGroupMessage properties: DBClusterParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: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.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora-mysql5.7, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql14
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres12
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mysql
postgres
AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones:
allOf:
- $ref: "#/components/schemas/AvailabilityZones"
- description: Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName:
allOf:
- $ref: "#/components/schemas/String"
- description: If present, specifies the name of the character set that this cluster is associated with.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the current state of this DB cluster.
AutomaticRestartTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The time when a stopped DB cluster is restarted automatically.
PercentProgress:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the progress of the operation as a percentage.
EarliestRestorableTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The earliest time to which a database can be restored with point-in-time restore.
Endpoint:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint:
allOf:
- $ref: "#/components/schemas/String"
- description: The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints: allOf: - $ref: "#/components/schemas/StringList" - description: Identifies all custom endpoints associated with the cluster. MultiAZ: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Specifies whether the DB cluster has instances in multiple Availability Zones. Engine: allOf: - $ref: "#/components/schemas/String" - description: The name of the database engine to be used for this DB cluster. EngineVersion: allOf: - $ref: "#/components/schemas/String" - description: Indicates the database engine version. LatestRestorableTime: allOf: - $ref: "#/components/schemas/TStamp" - description: Specifies the latest time to which a database can be restored with point-in-time restore. Port: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: Specifies the port that the database engine is listening on. MasterUsername: allOf: - $ref: "#/components/schemas/String" - description: Contains the master username for the DB cluster. DBClusterOptionGroupMemberships: allOf: - $ref: "#/components/schemas/DBClusterOptionGroupMemberships" - description: Provides the list of option group memberships for this DB cluster. PreferredBackupWindow: allOf: - $ref: "#/components/schemas/String" - description: Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod.
PreferredMaintenanceWindow:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers:
allOf:
- $ref: "#/components/schemas/ReadReplicaIdentifierList"
- description: Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers:
allOf:
- $ref: "#/components/schemas/DBClusterMemberList"
- description: Provides the list of instances that make up the DB cluster.
VpcSecurityGroups:
allOf:
- $ref: "#/components/schemas/VpcSecurityGroupMembershipList"
- description: Provides a list of VPC security groups that the DB cluster belongs to.
HostedZoneId:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Specifies whether the DB cluster is encrypted.
KmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed. DBClusterArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) for the DB cluster. AssociatedRoles: allOf: - $ref: "#/components/schemas/DBClusterRoles" - description: Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. IAMDatabaseAuthenticationEnabled: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. CloneGroupId: allOf: - $ref: "#/components/schemas/String" - description: Identifies the clone group to which the DB cluster is associated. ClusterCreateTime: allOf: - $ref: "#/components/schemas/TStamp" - description: Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). EarliestBacktrackTime: allOf: - $ref: "#/components/schemas/TStamp" - description: The earliest time to which a DB cluster can be backtracked. BacktrackWindow: allOf: - $ref: "#/components/schemas/LongOptional" - description: The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled. BacktrackConsumedChangeRecords: allOf: - $ref: "#/components/schemas/LongOptional" - description: The number of change records stored for Backtrack. EnabledCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description:A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
EngineMode: allOf: - $ref: "#/components/schemas/String" - description:The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
For more information, see CreateDBCluster.
ScalingConfigurationInfo: $ref: "#/components/schemas/ScalingConfigurationInfo" DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. HttpEndpointEnabled: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
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.
ActivityStreamMode: allOf: - $ref: "#/components/schemas/ActivityStreamMode" - description: The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. ActivityStreamStatus: allOf: - $ref: "#/components/schemas/ActivityStreamStatus" - description: The status of the database activity stream. ActivityStreamKmsKeyId: allOf: - $ref: "#/components/schemas/String" - description:The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName: allOf: - $ref: "#/components/schemas/String" - description: The name of the Amazon Kinesis data stream used for the database activity stream. CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster. CrossAccountClone: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. DomainMemberships: allOf: - $ref: "#/components/schemas/DomainMembershipList" - description: The Active Directory Domain membership records associated with the DB cluster. TagList: $ref: "#/components/schemas/TagList" GlobalWriteForwardingStatus: allOf: - $ref: "#/components/schemas/WriteForwardingStatus" - description: Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it. GlobalWriteForwardingRequested: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value ofGlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues:
allOf:
- $ref: "#/components/schemas/ClusterPendingModifiedValues"
- description: A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBClusterInstanceClass:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType: allOf: - $ref: "#/components/schemas/String" - description:The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/Boolean" - description:A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn: allOf: - $ref: "#/components/schemas/String" - description:The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId: allOf: - $ref: "#/components/schemas/String" - description:The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: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
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration: $ref: "#/components/schemas/ServerlessV2ScalingConfigurationInfo" NetworkType: allOf: - $ref: "#/components/schemas/String" - description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
DBSystemId: allOf: - $ref: "#/components/schemas/String" - description: Reserved for future use. MasterUserSecret: allOf: - $ref: "#/components/schemas/MasterUserSecret" - description:Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
description:Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
CreateDBClusterSnapshotMessage: type: object required: - DBClusterSnapshotIdentifier - DBClusterIdentifier title: CreateDBClusterSnapshotMessage properties: DBClusterSnapshotIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "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
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
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 postgres is 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 value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL
Constraints:
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: ORCL
Constraints:
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 postgres is 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.
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
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.
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-mysql (for Aurora MySQL DB instances)
aurora-postgresql (for Aurora PostgreSQL DB instances)
custom-oracle-ee (for RDS Custom for Oracle DB instances)
custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
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.
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 ManageMasterUserPassword is 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.
" DBSecurityGroups: allOf: - $ref: "#/components/schemas/DBSecurityGroupNameList" - description:A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
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.
" AvailabilityZone: allOf: - $ref: "#/components/schemas/String" - description: "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-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
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
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:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
' DBParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: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.
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
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
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.
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
" MultiAZ: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
EngineVersion: allOf: - $ref: "#/components/schemas/String" - description: 'The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions operation.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
Amazon 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.
' AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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 AutoMinorVersionUpgrade to false.
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
" Iops: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: '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.
' OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description: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.
CharacterSetName: allOf: - $ref: "#/components/schemas/String" - description: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.
The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn't apply to RDS Custom.
PubliclyAccessible: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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 DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
The identifier of the DB cluster that the instance will belong to.
This setting doesn't apply to RDS Custom.
StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
" TdeCredentialArn: allOf: - $ref: "#/components/schemas/String" - description: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: allOf: - $ref: "#/components/schemas/String" - description:The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
StorageEncrypted: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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 true or leave it unset. If you set this parameter to false, RDS reports an error.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
KmsKeyId: allOf: - $ref: "#/components/schemas/String" - description: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 StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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.
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.
CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
MonitoringInterval: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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 MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
DomainIAMRoleName: allOf: - $ref: "#/components/schemas/String" - description: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.
PromotionTier: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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
" Timezone: allOf: - $ref: "#/components/schemas/String" - description: The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server. EnableIAMDatabaseAuthentication: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
PerformanceInsightsKMSKeyId: allOf: - $ref: "#/components/schemas/String" - description: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: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: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.
EnableCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description: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, and slowquery.
Microsoft SQL Server
Possible values are agent and error.
MySQL
Possible values are audit, error, general, and slowquery.
Oracle
Possible values are alert, audit, listener, trace, and oemagent.
PostgreSQL
Possible values are postgresql and upgrade.
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.
DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
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.
EnableCustomerOwnedIp: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
CustomIamInstanceProfile: allOf: - $ref: "#/components/schemas/String" - description: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.
BackupTarget: allOf: - $ref: "#/components/schemas/String" - description:Specifies where automated backups and manual snapshots are stored.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
NetworkType: allOf: - $ref: "#/components/schemas/String" - description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
StorageThroughput: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
ManageMasterUserPassword: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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 MasterUserPassword is specified.
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 the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
CACertificateIdentifier: allOf: - $ref: "#/components/schemas/String" - description: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.
description: ReplicaMode: type: string enum: - open-read-only - mounted CreateDBInstanceReadReplicaMessage: type: object required: - DBInstanceIdentifier title: CreateDBInstanceReadReplicaMessage properties: DBInstanceIdentifier: allOf: - $ref: "#/components/schemas/String" - description: 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. SourceDBInstanceIdentifier: allOf: - $ref: "#/components/schemas/String" - description:The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
Can't be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
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.
' AvailabilityZone: allOf: - $ref: "#/components/schemas/String" - description: "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
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
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 is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom.
AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" Iops: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description:The option group the DB instance is associated with. If omitted, the option group associated with the source instance or cluster is used.
For SQL Server, you must use the option group associated with the source.
This setting doesn't apply to RDS Custom.
DBParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: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 the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for 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
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.
Tags: $ref: "#/components/schemas/TagList" DBSubnetGroupName: allOf: - $ref: "#/components/schemas/String" - description: "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:
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
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.
" StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the read replica.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
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 MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
KmsKeyId: allOf: - $ref: "#/components/schemas/String" - description:The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
PreSignedUrl: allOf: - $ref: "#/components/schemas/String" - description: "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
This setting applies only when replicating from a source DB instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
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: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
PerformanceInsightsKMSKeyId: allOf: - $ref: "#/components/schemas/String" - description: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: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: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.
EnableCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description: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.
ProcessorFeatures: allOf: - $ref: "#/components/schemas/ProcessorFeatureList" - description: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.
UseDefaultProcessorFeatures: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: 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. Domain: allOf: - $ref: "#/components/schemas/String" - description: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: allOf: - $ref: "#/components/schemas/String" - description: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.
ReplicaMode: allOf: - $ref: "#/components/schemas/ReplicaMode" - description: "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.
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.
CustomIamInstanceProfile: allOf: - $ref: "#/components/schemas/String" - description: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.
NetworkType: allOf: - $ref: "#/components/schemas/String" - description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
StorageThroughput: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:Specifies the storage throughput value for the read replica.
This setting doesn't apply to RDS Custom or Amazon Aurora.
EnableCustomerOwnedIp: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
AllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: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.
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
Must be the identifier of an existing Multi-AZ DB cluster.
Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported.
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime: allOf: - $ref: "#/components/schemas/TStamp" - description: The time when a stopped DB instance is restarted automatically. MasterUsername: allOf: - $ref: "#/components/schemas/String" - description: Contains the master username for the DB instance. DBName: allOf: - $ref: "#/components/schemas/String" - description: "The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
" Endpoint: allOf: - $ref: "#/components/schemas/Endpoint" - description:Specifies the connection endpoint.
The endpoint might not be shown for instances whose status is creating.
BackupRetentionPeriod.
BackupRetentionPeriod:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Specifies the number of days for which automatic DB snapshots are retained.
DBSecurityGroups:
allOf:
- $ref: "#/components/schemas/DBSecurityGroupMembershipList"
- description: A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
VpcSecurityGroups:
allOf:
- $ref: "#/components/schemas/VpcSecurityGroupMembershipList"
- description: Provides a list of VPC security group elements that the DB instance belongs to.
DBParameterGroups:
allOf:
- $ref: "#/components/schemas/DBParameterGroupStatusList"
- description: Provides the list of DB parameter groups applied to this DB instance.
AvailabilityZone:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup:
allOf:
- $ref: "#/components/schemas/DBSubnetGroup"
- description: Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
PreferredMaintenanceWindow:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues:
allOf:
- $ref: "#/components/schemas/PendingModifiedValues"
- description: A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
LatestRestorableTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: Indicates the database engine version.
AutoMinorVersionUpgrade:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers:
allOf:
- $ref: "#/components/schemas/ReadReplicaDBInstanceIdentifierList"
- description: Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers:
allOf:
- $ref: "#/components/schemas/ReadReplicaDBClusterIdentifierList"
- description: Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
Specifies the accessibility options for the DB instance.
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.
StatusInfos: allOf: - $ref: "#/components/schemas/DBInstanceStatusInfoList" - description: The status of a read replica. If the instance isn't a read replica, this is blank. StorageType: allOf: - $ref: "#/components/schemas/String" - description: Specifies the storage type associated with the DB instance. TdeCredentialArn: allOf: - $ref: "#/components/schemas/String" - description: The ARN from the key store with which the instance is associated for TDE encryption. DbInstancePort: allOf: - $ref: "#/components/schemas/Integer" - description: Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port. DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. StorageEncrypted: allOf: - $ref: "#/components/schemas/Boolean" - description: Specifies whether the DB instance is encrypted. KmsKeyId: allOf: - $ref: "#/components/schemas/String" - description:If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. CACertificateIdentifier: allOf: - $ref: "#/components/schemas/String" - description:The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
DomainMemberships: allOf: - $ref: "#/components/schemas/DomainMembershipList" - description: The Active Directory Domain membership records associated with the DB instance. CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/Boolean" - description:Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
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. For more information, see DBCluster.
Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines:
For MySQL 5.7, minor version 5.7.16 or higher.
For Amazon Aurora, all versions of Aurora MySQL and Aurora PostgreSQL.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: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
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures: allOf: - $ref: "#/components/schemas/ProcessorFeatureList" - description: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. DeletionProtection: allOf: - $ref: "#/components/schemas/Boolean" - description: Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. AssociatedRoles: allOf: - $ref: "#/components/schemas/DBInstanceRoles" - description: The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. ListenerEndpoint: allOf: - $ref: "#/components/schemas/Endpoint" - description: Specifies the listener connection endpoint for SQL Server Always On. MaxAllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. TagList: $ref: "#/components/schemas/TagList" DBInstanceAutomatedBackupsReplications: allOf: - $ref: "#/components/schemas/DBInstanceAutomatedBackupsReplicationList" - description: The list of replicated automated backups associated with the DB instance. CustomerOwnedIpEnabled: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
AwsBackupRecoveryPointArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. ActivityStreamStatus: allOf: - $ref: "#/components/schemas/ActivityStreamStatus" - description: The status of the database activity stream. ActivityStreamKmsKeyId: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. ActivityStreamKinesisStreamName: allOf: - $ref: "#/components/schemas/String" - description: The name of the Amazon Kinesis data stream used for the database activity stream. ActivityStreamMode: allOf: - $ref: "#/components/schemas/ActivityStreamMode" - description: The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously. ActivityStreamEngineNativeAuditFieldsIncluded: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Indicates whether engine-native audit fields are included in the database activity stream. AutomationMode: allOf: - $ref: "#/components/schemas/AutomationMode" - description: "The automation mode of the RDS Custom DB instance:full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes."
ResumeFullAutomationModeTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
BackupTarget: allOf: - $ref: "#/components/schemas/String" - description: "Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region." NetworkType: allOf: - $ref: "#/components/schemas/String" - description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus: allOf: - $ref: "#/components/schemas/ActivityStreamPolicyStatus" - description: The status of the policy state of the activity stream. StorageThroughput: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:Specifies the storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
CertificateDetails: allOf: - $ref: "#/components/schemas/CertificateDetails" - description: The details of the DB instance's server certificate. ReadReplicaSourceDBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: Contains the identifier of the source DB cluster if this DB instance is a read replica. description:Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
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.
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
Tags:
$ref: "#/components/schemas/TagList"
DBProxyEndpoint:
type: object
properties:
DBProxyEndpointName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
DBProxyEndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the DB proxy endpoint.
DBProxyName:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier for the DB proxy that is associated with this DB proxy endpoint.
Status:
allOf:
- $ref: "#/components/schemas/DBProxyEndpointStatus"
- description: The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
VpcId:
allOf:
- $ref: "#/components/schemas/String"
- description: Provides the VPC ID of the DB proxy endpoint.
VpcSecurityGroupIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: Provides a list of VPC security groups that the DB proxy endpoint belongs to.
VpcSubnetIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The EC2 subnet IDs for the DB proxy endpoint.
Endpoint:
allOf:
- $ref: "#/components/schemas/String"
- description: The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
CreatedDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date and time when the DB proxy endpoint was first created.
TargetRole:
allOf:
- $ref: "#/components/schemas/DBProxyEndpointTargetRole"
- description: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
IsDefault:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
description: The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
This data type is used as a response element in the DescribeDBProxyEndpoints operation.
MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
Auth:
allOf:
- $ref: "#/components/schemas/UserAuthConfigList"
- description: The authorization mechanism that the proxy uses.
RoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
VpcSubnetIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: One or more VPC subnet IDs to associate with the new proxy.
VpcSecurityGroupIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: One or more VPC security group IDs to associate with the new proxy.
RequireTLS:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: 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.
IdleClientTimeout:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: 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.
DebugLogging:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: 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.
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
DBProxy:
type: object
properties:
DBProxyName:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DBProxyArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the proxy.
Status:
allOf:
- $ref: "#/components/schemas/DBProxyStatus"
- description: The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
EngineFamily:
allOf:
- $ref: "#/components/schemas/String"
- description: The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
VpcId:
allOf:
- $ref: "#/components/schemas/String"
- description: Provides the VPC ID of the DB proxy.
VpcSecurityGroupIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: Provides a list of VPC security groups that the proxy belongs to.
VpcSubnetIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The EC2 subnet IDs for the proxy.
Auth:
allOf:
- $ref: "#/components/schemas/UserAuthConfigInfoList"
- description: One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
RoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
Endpoint:
allOf:
- $ref: "#/components/schemas/String"
- description: The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
RequireTLS:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
IdleClientTimeout:
allOf:
- $ref: "#/components/schemas/Integer"
- description: "The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
" DebugLogging: allOf: - $ref: "#/components/schemas/Boolean" - description: 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. CreatedDate: allOf: - $ref: "#/components/schemas/TStamp" - description: The date and time when the proxy was first created. UpdatedDate: allOf: - $ref: "#/components/schemas/TStamp" - description: The date and time when the proxy was last updated. description:The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies action.
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
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
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
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
Subnet elements.
DBSubnetGroupArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The network type of the DB subnet group.
Valid values:
IPV4
DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
description:Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
The name of the subscription.
Constraints: The name must be less than 255 characters.
" SnsTopicArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. SourceType: allOf: - $ref: "#/components/schemas/String" - description: "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, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
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 the DescribeEventCategories operation.
SourceIds:
allOf:
- $ref: "#/components/schemas/SourceIdsList"
- description: The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
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
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
serverless DB engine mode.
MaxCapacity:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The remaining amount of time, in seconds, before the Aurora DB cluster inserverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction:
allOf:
- $ref: "#/components/schemas/String"
- description: The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
TimeoutAction setting.
description: Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
DomainMembershipList: type: array items: allOf: - $ref: "#/components/schemas/DomainMembership" - xml: name: DomainMembership WriteForwardingStatus: type: string enum: - enabled - disabled - enabling - disabling - unknown ServerlessV2ScalingConfigurationInfo: type: object properties: MinCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. MaxCapacity: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. description:Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
MasterUserSecret: type: object properties: SecretArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the secret. SecretStatus: allOf: - $ref: "#/components/schemas/String" - description:The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.
When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
DBClusterBacktrackList: type: array items: allOf: - $ref: "#/components/schemas/DBClusterBacktrack" - xml: name: DBClusterBacktrack DBClusterEndpointList: type: array items: allOf: - $ref: "#/components/schemas/DBClusterEndpoint" - xml: name: DBClusterEndpointList DBClusterIdentifier: type: string pattern: "[A-Za-z][0-9A-Za-z-:._]*" minLength: 1 maxLength: 255 DBClusterList: type: array items: allOf: - $ref: "#/components/schemas/DBCluster" - xml: name: DBCluster DBClusterMember: type: object properties: DBInstanceIdentifier: allOf: - $ref: "#/components/schemas/String" - description: Specifies the instance identifier for this member of the DB cluster. IsClusterWriter: allOf: - $ref: "#/components/schemas/Boolean" - description: Value that istrue if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: 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.
description: Contains information about an instance that is part of a DB cluster.
DBClusterOptionGroupStatus:
type: object
properties:
DBClusterOptionGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the name of the DB cluster option group.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the status of the DB cluster option group.
description: Contains status information for a DB cluster option group.
ParametersList:
type: array
items:
allOf:
- $ref: "#/components/schemas/Parameter"
- xml:
name: Parameter
DBClusterParameterGroupList:
type: array
items:
allOf:
- $ref: "#/components/schemas/DBClusterParameterGroup"
- xml:
name: DBClusterParameterGroup
DBClusterRole:
type: object
properties:
RoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.
The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
CreateDBInstance
DescribeDBInstances
DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
The identifier of the CA certificate for the DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
DBSubnetGroupName: allOf: - $ref: "#/components/schemas/String" - description: The DB subnet group for the DB instance. PendingCloudwatchLogsExports: $ref: "#/components/schemas/PendingCloudwatchLogsExports" ProcessorFeatures: allOf: - $ref: "#/components/schemas/ProcessorFeatureList" - description: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. IAMDatabaseAuthenticationEnabled: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. AutomationMode: allOf: - $ref: "#/components/schemas/AutomationMode" - description: "The automation mode of the RDS Custom DB instance:full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes."
ResumeFullAutomationModeTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
StorageThroughput:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The storage throughput of the DB instance.
description: This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.
ReadReplicaDBInstanceIdentifierList:
type: array
items:
allOf:
- $ref: "#/components/schemas/String"
- xml:
name: ReadReplicaDBInstanceIdentifier
ReadReplicaDBClusterIdentifierList:
type: array
items:
allOf:
- $ref: "#/components/schemas/String"
- xml:
name: ReadReplicaDBClusterIdentifier
OptionGroupMembershipList:
type: array
items:
allOf:
- $ref: "#/components/schemas/OptionGroupMembership"
- xml:
name: OptionGroupMembership
DBInstanceStatusInfoList:
type: array
items:
allOf:
- $ref: "#/components/schemas/DBInstanceStatusInfo"
- xml:
name: DBInstanceStatusInfo
DBInstanceRoles:
type: array
items:
allOf:
- $ref: "#/components/schemas/DBInstanceRole"
- xml:
name: DBInstanceRole
DBInstanceAutomatedBackupsReplicationList:
type: array
items:
allOf:
- $ref: "#/components/schemas/DBInstanceAutomatedBackupsReplication"
- xml:
name: DBInstanceAutomatedBackupsReplication
RestoreWindow:
type: object
properties:
EarliestTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The earliest time you can restore an instance to.
LatestTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The latest time you can restore an instance to.
description: "Earliest and latest time an instance can be restored to:"
DBInstanceAutomatedBackup:
type: object
properties:
DBInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The customer id of the instance that is/was associated with the automated backup.
RestoreWindow:
allOf:
- $ref: "#/components/schemas/RestoreWindow"
- description: Earliest and latest time an instance can be restored to.
AllocatedStorage:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Specifies the allocated storage size in gibibytes (GiB).
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: Provides a list of status information for an automated backup:
active - automated backups for current instances
retained - automated backups for deleted instances
creating - automated backups that are waiting for the first automated snapshot to be available.
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone: allOf: - $ref: "#/components/schemas/String" - description: The time zone of the automated backup. In most cases, theTimezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The retention period for the automated backups.
DBInstanceAutomatedBackupsArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications:
allOf:
- $ref: "#/components/schemas/DBInstanceAutomatedBackupsReplicationList"
- description: The list of replications to different Amazon Web Services Regions associated with the automated backup.
BackupTarget:
allOf:
- $ref: "#/components/schemas/String"
- description: "Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region."
StorageThroughput:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Specifies the storage throughput for the automated backup.
description: An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceAutomatedBackupList:
type: array
items:
allOf:
- $ref: "#/components/schemas/DBInstanceAutomatedBackup"
- xml:
name: DBInstanceAutomatedBackup
DBInstanceAutomatedBackupsReplication:
type: object
properties:
DBInstanceAutomatedBackupsArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replicated automated backups.
description: Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceList:
type: array
items:
allOf:
- $ref: "#/components/schemas/DBInstance"
- xml:
name: DBInstance
DBInstanceRole:
type: object
properties:
RoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering > unavailable > available > unavailable > available
State of the RDS Proxy target.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.
description: Information about the connection health of an RDS Proxy target.
DBProxyTarget:
type: object
properties:
TargetArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
Endpoint:
allOf:
- $ref: "#/components/schemas/String"
- description: The writer endpoint for the RDS DB instance or Aurora DB cluster.
TrackedClusterId:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
RdsResourceId:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
Port:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
Type:
allOf:
- $ref: "#/components/schemas/TargetType"
- description: Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
Role:
allOf:
- $ref: "#/components/schemas/TargetRole"
- description: A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
TargetHealth:
allOf:
- $ref: "#/components/schemas/TargetHealth"
- description: Information about the connection health of the RDS Proxy target.
description: Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
true.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.
ConnectionPoolConfig:
allOf:
- $ref: "#/components/schemas/ConnectionPoolConfigurationInfo"
- description: The settings that determine the size and behavior of the connection pool for the target group.
CreatedDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date and time when the target group was first created.
UpdatedDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date and time when the target group was last updated.
description: Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
This data type is used as a response element in the DescribeDBProxyTargetGroups action.
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
The name of the manual DB snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
The value or values for the manual DB snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.
Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.
Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
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.
SWITCHOVER_COMPLETED.
DeleteCustomDBEngineVersionMessage:
type: object
required:
- Engine
- EngineVersion
title: DeleteCustomDBEngineVersionMessage
properties:
Engine:
allOf:
- $ref: "#/components/schemas/CustomEngineName"
- description: The database engine. The only supported engines are custom-oracle-ee and custom-oracle-ee-cdb.
EngineVersion:
allOf:
- $ref: "#/components/schemas/CustomEngineVersion"
- description: The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
DeleteDBClusterEndpointMessage:
type: object
required:
- DBClusterEndpointIdentifier
title: DeleteDBClusterEndpointMessage
properties:
DBClusterEndpointIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
DeleteDBClusterMessage:
type: object
required:
- DBClusterIdentifier
title: DeleteDBClusterMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
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 FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.
Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter 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
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You can't delete a default DB cluster parameter group.
Can't be associated with any DB clusters.
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
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.
description: Parameter input for theDeleteDBInstanceAutomatedBackup operation.
DeleteDBInstanceMessage:
type: object
required:
- DBInstanceIdentifier
title: DeleteDBInstanceMessage
properties:
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
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 FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-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.
FinalDBSnapshotIdentifier: allOf: - $ref: "#/components/schemas/String" - description:The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn't apply to RDS Custom.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Can't be specified when deleting a read replica.
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Can't be associated with any DB instances
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"
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The name of the option group to be deleted.
You can't delete default option groups.
DBProxy that is associated with the DBProxyTargetGroup.
TargetGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the DBProxyTargetGroup.
DBInstanceIdentifiers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: One or more DB instance identifiers.
DBClusterIdentifiers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: One or more DB cluster identifiers.
DescribeAccountAttributesMessage:
type: object
title: DescribeAccountAttributesMessage
properties: {}
description:
FilterList:
type: array
items:
allOf:
- $ref: "#/components/schemas/Filter"
- xml:
name: Filter
MaxRecords:
type: integer
minimum: 20
maximum: 100
DescribeBlueGreenDeploymentsRequest:
type: object
title: DescribeBlueGreenDeploymentsRequest
properties:
BlueGreenDeploymentIdentifier:
allOf:
- $ref: "#/components/schemas/BlueGreenDeploymentIdentifier"
- description: 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.
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.
DescribeBlueGreenDeployments request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" DescribeCertificatesMessage: type: object title: DescribeCertificatesMessage properties: CertificateIdentifier: allOf: - $ref: "#/components/schemas/String" - description: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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
DescribeDBClusterBacktracksMessage:
type: object
required:
- DBClusterIdentifier
title: DescribeDBClusterBacktracksMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: "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
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
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
DescribeDBClusterEndpointsMessage:
type: object
title: DescribeDBClusterEndpointsMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterEndpointIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying."
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DescribeDBClusterParameterGroupsMessage:
type: object
title: DescribeDBClusterParameterGroupsMessage
properties:
DBClusterParameterGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
DescribeDBClusterParametersMessage:
type: object
required:
- DBClusterParameterGroupName
title: DescribeDBClusterParametersMessage
properties:
DBClusterParameterGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
engine, service, or customer.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: This parameter isn't currently supported.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
DescribeDBClusterSnapshotAttributesMessage:
type: object
required:
- DBClusterSnapshotIdentifier
title: DescribeDBClusterSnapshotAttributesMessage
properties:
DBClusterSnapshotIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier for the DB cluster snapshot to describe the attributes for.
description:
DescribeDBClusterSnapshotsMessage:
type: object
title: DescribeDBClusterSnapshotsMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
IncludeShared:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: 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 ModifyDBClusterSnapshotAttribute API action.
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.
description: DescribeDBClustersMessage: type: object title: DescribeDBClustersMessage properties: DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: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.
A filter that specifies one or more DB clusters to describe.
Supported filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
IncludeShared:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
description:
DescribeDBEngineVersionsMessage:
type: object
title: DescribeDBEngineVersionsMessage
properties:
Engine:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine to return.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
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
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords.
DefaultOnly:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
ListSupportedCharacterSets:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: 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 CharacterSetName parameter for CreateDBInstance, 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 ListSupportedCharacterSets to true, RDS Custom returns no results.
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 TimeZone parameter for CreateDBInstance, 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 ListSupportedTimezones to true, RDS Custom returns no results.
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.
MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
DBInstanceAutomatedBackupsArn:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
description: Parameter input for DescribeDBInstanceAutomatedBackups. DescribeDBInstancesMessage: type: object title: DescribeDBInstancesMessage properties: DBInstanceIdentifier: allOf: - $ref: "#/components/schemas/String" - description: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.
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
DescribeDBLogFilesDetails:
type: object
properties:
LogFileName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the log file for the specified DB instance.
LastWritten:
allOf:
- $ref: "#/components/schemas/Long"
- description: A POSIX timestamp when the last log entry was written.
Size:
allOf:
- $ref: "#/components/schemas/Long"
- description: The size, in bytes, of the log file for the specified DB instance.
description: This data type is used as a response element to DescribeDBLogFiles.
DescribeDBLogFilesList:
type: array
items:
allOf:
- $ref: "#/components/schemas/DescribeDBLogFilesDetails"
- xml:
name: DescribeDBLogFilesDetails
DescribeDBLogFilesMessage:
type: object
required:
- DBInstanceIdentifier
title: DescribeDBLogFilesMessage
properties:
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
DescribeDBParametersMessage:
type: object
required:
- DBParameterGroupName
title: DescribeDBParametersMessage
properties:
DBParameterGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DescribeDBProxiesRequest:
type: object
title: DescribeDBProxiesRequest
properties:
DBProxyName:
allOf:
- $ref: "#/components/schemas/String"
- description: 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:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: This parameter is not currently supported.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
" DescribeDBProxyEndpointsRequest: type: object title: DescribeDBProxyEndpointsRequest properties: DBProxyName: allOf: - $ref: "#/components/schemas/DBProxyName" - description: 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. DBProxyEndpointName: allOf: - $ref: "#/components/schemas/DBProxyEndpointName" - description: 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. Filters: allOf: - $ref: "#/components/schemas/FilterList" - description: This parameter is not currently supported. Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords.
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
" DescribeDBProxyTargetGroupsRequest: type: object required: - DBProxyName title: DescribeDBProxyTargetGroupsRequest properties: DBProxyName: allOf: - $ref: "#/components/schemas/String" - description: The identifier of theDBProxy associated with the target group.
TargetGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the DBProxyTargetGroup to describe.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: This parameter is not currently supported.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
" TargetGroupList: type: array items: $ref: "#/components/schemas/DBProxyTargetGroup" DescribeDBProxyTargetsRequest: type: object required: - DBProxyName title: DescribeDBProxyTargetsRequest properties: DBProxyName: allOf: - $ref: "#/components/schemas/String" - description: The identifier of theDBProxyTarget to describe.
TargetGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the DBProxyTargetGroup to describe.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: This parameter is not currently supported.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
" TargetList: type: array items: $ref: "#/components/schemas/DBProxyTarget" DescribeDBSecurityGroupsMessage: type: object title: DescribeDBSecurityGroupsMessage properties: DBSecurityGroupName: allOf: - $ref: "#/components/schemas/String" - description: The name of the DB security group to return details for. Filters: allOf: - $ref: "#/components/schemas/FilterList" - description: This parameter isn't currently supported. MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
DescribeDBSnapshotAttributesMessage:
type: object
required:
- DBSnapshotIdentifier
title: DescribeDBSnapshotAttributesMessage
properties:
DBSnapshotIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier for the DB snapshot to describe the attributes for.
description:
DescribeDBSnapshotsMessage:
type: object
title: DescribeDBSnapshotsMessage
properties:
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The awsbackup type does not apply to Aurora.
If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
IncludeShared:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: 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 ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
IncludePublic: allOf: - $ref: "#/components/schemas/Boolean" - description: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.
DbiResourceId: allOf: - $ref: "#/components/schemas/String" - description: A specific DB resource ID to describe. description: DescribeDBSubnetGroupsMessage: type: object title: DescribeDBSubnetGroupsMessage properties: DBSubnetGroupName: allOf: - $ref: "#/components/schemas/String" - description: The name of the DB subnet group to return details for. Filters: allOf: - $ref: "#/components/schemas/FilterList" - description: This parameter isn't currently supported. MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords.
description:
DescribeEngineDefaultClusterParametersMessage:
type: object
required:
- DBParameterGroupFamily
title: DescribeEngineDefaultClusterParametersMessage
properties:
DBParameterGroupFamily:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB cluster parameter group family to return engine parameter information for.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: This parameter isn't currently supported.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
EngineDefaults:
type: object
properties:
DBParameterGroupFamily:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the name of the DB parameter group family that the engine default parameters apply to.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Parameters:
allOf:
- $ref: "#/components/schemas/ParametersList"
- description: Contains a list of engine default parameters.
description: Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
DescribeEngineDefaultParametersMessage:
type: object
required:
- DBParameterGroupFamily
title: DescribeEngineDefaultParametersMessage
properties:
DBParameterGroupFamily:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB parameter group family.
Valid Values:
aurora-mysql5.7
aurora-mysql8.0
aurora-postgresql10
aurora-postgresql11
aurora-postgresql12
aurora-postgresql13
aurora-postgresql14
custom-oracle-ee-19
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
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
description:
DescribeEventCategoriesMessage:
type: object
title: DescribeEventCategoriesMessage
properties:
SourceType:
allOf:
- $ref: "#/components/schemas/String"
- description: "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
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords .
description:
SourceType:
type: string
enum:
- db-instance
- db-parameter-group
- db-security-group
- db-snapshot
- db-cluster
- db-cluster-snapshot
- custom-engine-version
- db-proxy
- blue-green-deployment
DescribeEventsMessage:
type: object
title: DescribeEventsMessage
properties:
SourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.
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
' EndTime: allOf: - $ref: "#/components/schemas/TStamp" - description: '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
' Duration: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The number of minutes to retrieve events for.
Default: 60
" EventCategories: allOf: - $ref: "#/components/schemas/EventCategoriesList" - description: A list of event categories that trigger notifications for a event notification subscription. Filters: allOf: - $ref: "#/components/schemas/FilterList" - description: This parameter isn't currently supported. MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords.
description:
ExportSourceType:
type: string
enum:
- SNAPSHOT
- CLUSTER
DescribeExportTasksMessage:
type: object
title: DescribeExportTasksMessage
properties:
ExportTaskIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the snapshot or cluster export task to be described.
SourceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: 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
DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: "The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" SourceType: allOf: - $ref: "#/components/schemas/ExportSourceType" - description: The type of source for the export. DescribeGlobalClustersMessage: type: object title: DescribeGlobalClustersMessage properties: GlobalClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: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.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DescribeOptionGroupOptionsMessage:
type: object
required:
- EngineName
title: DescribeOptionGroupOptionsMessage
properties:
EngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: A required parameter. Options available for the given engine name are described.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords.
description:
DescribeOptionGroupsMessage:
type: object
title: DescribeOptionGroupsMessage
properties:
OptionGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: This parameter isn't currently supported.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" EngineName: allOf: - $ref: "#/components/schemas/String" - description:Filters the list of option groups to only include groups associated with a specific database engine.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name of the engine to retrieve DB instance options for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
RDS Custom supports only the BYOL licensing model.
AvailabilityZoneGroup: allOf: - $ref: "#/components/schemas/String" - description:The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
Vpc: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
Filters: allOf: - $ref: "#/components/schemas/FilterList" - description: This parameter isn't currently supported. MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 10000.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords.
description:
DescribePendingMaintenanceActionsMessage:
type: object
title: DescribePendingMaintenanceActionsMessage
properties:
ResourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The ARN of a resource to return pending maintenance actions for.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" description: DescribeReservedDBInstancesMessage: type: object title: DescribeReservedDBInstancesMessage properties: ReservedDBInstanceId: allOf: - $ref: "#/components/schemas/String" - description: The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. ReservedDBInstancesOfferingId: allOf: - $ref: "#/components/schemas/String" - description: The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. DBInstanceClass: allOf: - $ref: "#/components/schemas/String" - description: The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class. Duration: allOf: - $ref: "#/components/schemas/String" - description: "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords.
description:
DescribeReservedDBInstancesOfferingsMessage:
type: object
title: DescribeReservedDBInstancesOfferingsMessage
properties:
ReservedDBInstancesOfferingId:
allOf:
- $ref: "#/components/schemas/String"
- description: "The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: 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 byMaxRecords.
description:
DescribeSourceRegionsMessage:
type: object
title: DescribeSourceRegionsMessage
properties:
RegionName:
allOf:
- $ref: "#/components/schemas/String"
- description: The source Amazon Web Services Region name. For example, us-east-1.
Constraints:
Must specify a valid Amazon Web Services Region name.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" Marker: allOf: - $ref: "#/components/schemas/String" - description: An optional pagination token provided by a previousDescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: This parameter isn't currently supported.
description:
DescribeValidDBInstanceModificationsMessage:
type: object
required:
- DBInstanceIdentifier
title: DescribeValidDBInstanceModificationsMessage
properties:
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The customer identifier or the ARN of your DB instance.
description:
ValidDBInstanceModificationsMessage:
type: object
properties:
Storage:
allOf:
- $ref: "#/components/schemas/ValidStorageOptionsList"
- description: Valid storage options for your DB instance.
ValidProcessorFeatures:
allOf:
- $ref: "#/components/schemas/AvailableProcessorFeatureList"
- description: Valid processor features for your DB instance.
description: Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.
DomainMembership:
type: object
properties:
Domain:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the Active Directory Domain.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN:
allOf:
- $ref: "#/components/schemas/String"
- description: The fully qualified domain name of the Active Directory Domain.
IAMRoleName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the IAM role to be used when making API calls to the Directory Service.
description: An Active Directory Domain membership record associated with the DB instance or cluster.
Double:
type: number
format: double
DoubleRange:
type: object
properties:
From:
allOf:
- $ref: "#/components/schemas/Double"
- description: The minimum value in the range.
To:
allOf:
- $ref: "#/components/schemas/Double"
- description: The maximum value in the range.
description: A range of double values.
DoubleRangeList:
type: array
items:
allOf:
- $ref: "#/components/schemas/DoubleRange"
- xml:
name: DoubleRange
DownloadDBLogFilePortionMessage:
type: object
required:
- DBInstanceIdentifier
- LogFileName
title: DownloadDBLogFilePortionMessage
properties:
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
EC2SecurityGroupName field.
description: This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngress
DescribeDBSecurityGroups
RevokeDBSecurityGroupIngress
A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
description: GlobalClusterIdentifier: type: string pattern: "[A-Za-z][0-9A-Za-z-:._]*" minLength: 1 maxLength: 255 FailoverGlobalClusterMessage: type: object required: - GlobalClusterIdentifier - TargetDbClusterIdentifier title: FailoverGlobalClusterMessage properties: GlobalClusterIdentifier: allOf: - $ref: "#/components/schemas/GlobalClusterIdentifier" - description:Identifier of the Aurora global database (GlobalCluster) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.
Constraints:
Must match the identifier of an existing GlobalCluster (Aurora global database).
The current status of the Aurora global database (GlobalCluster). Possible values are as follows:
pending A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
failing-over This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
DescribeDBSecurityGroups action.
KeyList:
type: array
items:
$ref: "#/components/schemas/String"
ListTagsForResourceMessage:
type: object
required:
- ResourceName
title: ListTagsForResourceMessage
properties:
ResourceName:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: This parameter isn't currently supported.
description:
MinimumEngineVersionPerAllowedValue:
type: object
properties:
AllowedValue:
allOf:
- $ref: "#/components/schemas/String"
- description: The allowed value for an option setting.
MinimumEngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The minimum DB engine version required for the allowed value.
description: The minimum DB engine version required for each corresponding allowed value for an option setting.
MinimumEngineVersionPerAllowedValueList:
type: array
items:
allOf:
- $ref: "#/components/schemas/MinimumEngineVersionPerAllowedValue"
- xml:
name: MinimumEngineVersionPerAllowedValue
ModifyActivityStreamRequest:
type: object
title: ModifyActivityStreamRequest
properties:
ResourceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.
AuditPolicyState:
allOf:
- $ref: "#/components/schemas/AuditPolicyState"
- description: The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
ModifyCertificatesMessage:
type: object
title: ModifyCertificatesMessage
properties:
CertificateIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The new default certificate identifier to override the current one with.
To determine the valid values, use the describe-certificates CLI command or the DescribeCertificates API operation.
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
TimeoutAction: allOf: - $ref: "#/components/schemas/String" - description:The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
custom-oracle-ee and custom-oracle-ee-cdb.
EngineVersion:
allOf:
- $ref: "#/components/schemas/CustomEngineVersion"
- description: The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
Description:
allOf:
- $ref: "#/components/schemas/Description"
- description: An optional description of your CEV.
Status:
allOf:
- $ref: "#/components/schemas/CustomEngineVersionStatus"
- description: The availability status to be assigned to the CEV. Valid values are as follows:
You can use this CEV to create a new RDS Custom DB instance.
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
READER, WRITER, ANY."
StaticMembers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: List of DB instance identifiers that are part of the custom endpoint group.
ExcludedMembers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: 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.
ModifyDBClusterMessage:
type: object
required:
- DBClusterIdentifier
title: ModifyDBClusterMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: "The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" NewDBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" ApplyImmediately: allOf: - $ref: "#/components/schemas/Boolean" - description: "A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" BackupRetentionPeriod: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The number of days for which automated backups are retained. Specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" DBClusterParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: "The name of the DB cluster parameter group to use for the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: "A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Port: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters only
" MasterUserPassword: allOf: - $ref: "#/components/schemas/String" - description: "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description: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.
PreferredBackupWindow: allOf: - $ref: "#/components/schemas/String" - description: 'The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' PreferredMaintenanceWindow: allOf: - $ref: "#/components/schemas/String" - description: 'The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred 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
' EnableIAMDatabaseAuthentication: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" BacktrackWindow: allOf: - $ref: "#/components/schemas/LongOptional" - description: "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
" CloudwatchLogsExportConfiguration: allOf: - $ref: "#/components/schemas/CloudwatchLogsExportConfiguration" - description: 'The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
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
' EngineVersion: allOf: - $ref: "#/components/schemas/String" - description: "The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" AllowMajorVersionUpgrade: allOf: - $ref: "#/components/schemas/Boolean" - description: "A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
Valid for: Aurora DB clusters only
" DBInstanceParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: "The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
Valid for: Aurora DB clusters only
" Domain: allOf: - $ref: "#/components/schemas/String" - description: 'The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' DomainIAMRoleName: allOf: - $ref: "#/components/schemas/String" - description: "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
" ScalingConfiguration: allOf: - $ref: "#/components/schemas/ScalingConfiguration" - description: "The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for: Aurora DB clusters only
" DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" EnableHttpEndpoint: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: '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
' CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" EnableGlobalWriteForwarding: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" DBClusterInstanceClass: allOf: - $ref: "#/components/schemas/String" - description: 'The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
' AllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
" StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
" Iops: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
' AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" MonitoringInterval: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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 MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
" MonitoringRoleArn: allOf: - $ref: "#/components/schemas/String" - description: 'The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
' EnablePerformanceInsights: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: '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
' PerformanceInsightsKMSKeyId: allOf: - $ref: "#/components/schemas/String" - description: "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: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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
" ServerlessV2ScalingConfiguration: $ref: "#/components/schemas/ServerlessV2ScalingConfiguration" NetworkType: allOf: - $ref: "#/components/schemas/String" - description: 'The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' ManageMasterUserPassword: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" RotateMasterUserPassword: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: 'A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' MasterUserSecretKmsKeyId: allOf: - $ref: "#/components/schemas/String" - description: "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" EngineMode: allOf: - $ref: "#/components/schemas/String" - description: 'The DB engine mode of the DB cluster, either provisioned or serverless.
The DB engine mode can be modified only from serverless to provisioned.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
' AllowEngineModeChange: allOf: - $ref: "#/components/schemas/Boolean" - description: "A value that indicates whether engine mode changes from serverless to provisioned are allowed.
Constraints: You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.
Valid for: Aurora Serverless v1 DB clusters only
" description: ModifyDBClusterParameterGroupMessage: type: object required: - DBClusterParameterGroupName - Parameters title: ModifyDBClusterParameterGroupMessage properties: DBClusterParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: The name of the DB cluster parameter group to modify. Parameters: allOf: - $ref: "#/components/schemas/ParametersList" - description: "A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see CreateDBInstance.
The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.
Default: Uses existing setting
' DBSubnetGroupName: allOf: - $ref: "#/components/schemas/String" - description: "The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match existing DBSecurityGroups.
A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints: Can't be specified if ManageMasterUserPassword is 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.
Amazon RDS API operations never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
" BackupRetentionPeriod: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
" MultiAZ: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
EngineVersion: allOf: - $ref: "#/components/schemas/String" - description:The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or later than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
" AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. Otherwise, the operation returns an error.
The license model for the DB instance.
This setting doesn't apply to RDS Custom.
Valid values: license-included | bring-your-own-license | general-public-license
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
" OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description:A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
NewDBInstanceIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid values: gp2 | gp3 | io1 | standard
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
TdeCredentialPassword: allOf: - $ref: "#/components/schemas/String" - description:The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
CACertificateIdentifier: allOf: - $ref: "#/components/schemas/String" - description: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.
Domain: allOf: - $ref: "#/components/schemas/String" - description:The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to copy all 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. For more information, see ModifyDBCluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
MySQL
Default: 3306
Valid values: 1150-65535
MariaDB
Default: 3306
Valid values: 1150-65535
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
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.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
DomainIAMRoleName: allOf: - $ref: "#/components/schemas/String" - description:The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
PromotionTier: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "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
" EnableIAMDatabaseAuthentication: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
EnablePerformanceInsights: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
PerformanceInsightsKMSKeyId: allOf: - $ref: "#/components/schemas/String" - description: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: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: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.
CloudwatchLogsExportConfiguration: allOf: - $ref: "#/components/schemas/CloudwatchLogsExportConfiguration" - description:The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
ProcessorFeatures: allOf: - $ref: "#/components/schemas/ProcessorFeatureList" - description: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.
UseDefaultProcessorFeatures: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: 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. MaxAllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: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.
CertificateRotationRestart: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
ReplicaMode: allOf: - $ref: "#/components/schemas/ReplicaMode" - description:A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
EnableCustomerOwnedIp: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
AwsBackupRecoveryPointArn: allOf: - $ref: "#/components/schemas/AwsBackupRecoveryPointArn" - description:The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
AutomationMode: allOf: - $ref: "#/components/schemas/AutomationMode" - description: "The automation mode of the RDS Custom DB instance:full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes."
ResumeFullAutomationModeMinutes:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
NetworkType:
allOf:
- $ref: "#/components/schemas/String"
- description: The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
StorageThroughput: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
ManageMasterUserPassword: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
description: ModifyDBParameterGroupMessage: type: object required: - DBParameterGroupName - Parameters title: ModifyDBParameterGroupMessage properties: DBParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description:The name of the DB parameter group.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.
You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.
For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
" description: ModifyDBProxyEndpointRequest: type: object required: - DBProxyEndpointName title: ModifyDBProxyEndpointRequest properties: DBProxyEndpointName: allOf: - $ref: "#/components/schemas/DBProxyEndpointName" - description: The name of the DB proxy sociated with the DB proxy endpoint that you want to modify. NewDBProxyEndpointName: allOf: - $ref: "#/components/schemas/DBProxyEndpointName" - description: The new identifier for theDBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
VpcSecurityGroupIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
ModifyDBProxyRequest:
type: object
required:
- DBProxyName
title: ModifyDBProxyRequest
properties:
DBProxyName:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier for the DBProxy to modify.
NewDBProxyName:
allOf:
- $ref: "#/components/schemas/String"
- description: The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
Auth:
allOf:
- $ref: "#/components/schemas/UserAuthConfigList"
- description: The new authentication settings for the DBProxy.
RequireTLS:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
IdleClientTimeout:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: 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.
DebugLogging:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: 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.
RoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
SecurityGroups:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The new list of security groups for the DBProxy.
ModifyDBProxyTargetGroupRequest:
type: object
required:
- TargetGroupName
- DBProxyName
title: ModifyDBProxyTargetGroupRequest
properties:
TargetGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the target group to modify.
DBProxyName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the proxy.
ConnectionPoolConfig:
allOf:
- $ref: "#/components/schemas/ConnectionPoolConfiguration"
- description: The settings that determine the size and behavior of the connection pool for the target group.
NewName:
allOf:
- $ref: "#/components/schemas/String"
- description: The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
ModifyDBSnapshotAttributeMessage:
type: object
required:
- DBSnapshotIdentifier
- AttributeName
title: ModifyDBSnapshotAttributeMessage
properties:
DBSnapshotIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier for the DB snapshot to modify the attributes for.
AttributeName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
A list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.
The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
5.5.46 (supported for 5.1 DB snapshots)
Oracle
12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description:The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
ModifyDBSubnetGroupMessage: type: object required: - DBSubnetGroupName - SubnetIds title: ModifyDBSubnetGroupMessage properties: DBSubnetGroupName: allOf: - $ref: "#/components/schemas/String" - description: "The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
Enabled:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that indicates whether to activate the subscription.
description:
ModifyGlobalClusterMessage:
type: object
title: ModifyGlobalClusterMessage
properties:
GlobalClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
" OptionConfigurationList: type: array items: allOf: - $ref: "#/components/schemas/OptionConfiguration" - xml: name: OptionConfiguration OptionNamesList: type: array items: $ref: "#/components/schemas/String" ModifyOptionGroupMessage: type: object required: - OptionGroupName title: ModifyOptionGroupMessage properties: OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description:The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
OptionsToInclude: allOf: - $ref: "#/components/schemas/OptionConfigurationList" - description: Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration. OptionsToRemove: allOf: - $ref: "#/components/schemas/OptionNamesList" - description: Options in this list are removed from the option group. ApplyImmediately: allOf: - $ref: "#/components/schemas/Boolean" - description: A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group. description: OptionSettingConfigurationList: type: array items: allOf: - $ref: "#/components/schemas/OptionSetting" - xml: name: OptionSetting Option: type: object properties: OptionName: allOf: - $ref: "#/components/schemas/String" - description: The name of the option. OptionDescription: allOf: - $ref: "#/components/schemas/String" - description: The description of the option. Persistent: allOf: - $ref: "#/components/schemas/Boolean" - description: Indicate if this option is persistent. Permanent: allOf: - $ref: "#/components/schemas/Boolean" - description: Indicate if this option is permanent. Port: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: If required, the port configured for this option to use. OptionVersion: allOf: - $ref: "#/components/schemas/String" - description: The version of the option. OptionSettings: allOf: - $ref: "#/components/schemas/OptionSettingConfigurationList" - description: The option settings for this option. DBSecurityGroupMemberships: allOf: - $ref: "#/components/schemas/DBSecurityGroupMembershipList" - description: If the option requires access to a port, then this DB security group allows access to the port. VpcSecurityGroupMemberships: allOf: - $ref: "#/components/schemas/VpcSecurityGroupMembershipList" - description: If the option requires access to a port, then this VPC security group allows access to the port. description: Option details. OptionSettingsList: type: array items: allOf: - $ref: "#/components/schemas/OptionSetting" - xml: name: OptionSetting OptionsList: type: array items: allOf: - $ref: "#/components/schemas/Option" - xml: name: Option OptionGroupMembership: type: object properties: OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description: The name of the option group that the instance belongs to. Status: allOf: - $ref: "#/components/schemas/String" - description: "The status of the DB instance's option group membership. Valid values are:in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed."
description: Provides information on the option groups the DB instance is a member of.
OptionsDependedOn:
type: array
items:
allOf:
- $ref: "#/components/schemas/String"
- xml:
name: OptionName
OptionsConflictsWith:
type: array
items:
allOf:
- $ref: "#/components/schemas/String"
- xml:
name: OptionConflictName
OptionGroupOptionSettingsList:
type: array
items:
allOf:
- $ref: "#/components/schemas/OptionGroupOptionSetting"
- xml:
name: OptionGroupOptionSetting
OptionGroupOptionVersionsList:
type: array
items:
allOf:
- $ref: "#/components/schemas/OptionVersion"
- xml:
name: OptionVersion
OptionGroupOption:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the option.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: The description of the option.
EngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the engine that this option can be applied to.
MajorEngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: Indicates the major engine version that the option is available for.
MinimumRequiredMinorEngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The minimum required engine version for the option to be applied.
PortRequired:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Specifies whether the option requires a port.
DefaultPort:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: If the option requires a port, specifies the default port for the option.
OptionsDependedOn:
allOf:
- $ref: "#/components/schemas/OptionsDependedOn"
- description: The options that are prerequisites for this option.
OptionsConflictsWith:
allOf:
- $ref: "#/components/schemas/OptionsConflictsWith"
- description: The options that conflict with this option.
Persistent:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
Permanent:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
RequiresAutoMinorEngineVersionUpgrade:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
VpcOnly:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: If true, you can only use this option with a DB instance that is in a VPC.
SupportsOptionVersionDowngrade:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
OptionGroupOptionSettings:
allOf:
- $ref: "#/components/schemas/OptionGroupOptionSettingsList"
- description: The option settings that are available (and the default value) for each option in an option group.
OptionGroupOptionVersions:
allOf:
- $ref: "#/components/schemas/OptionGroupOptionVersionsList"
- description: The versions that are available for the option.
CopyableCrossAccount:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Specifies whether the option can be copied across Amazon Web Services accounts.
description: Available option.
OptionGroupOptionSetting:
type: object
properties:
SettingName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the option group option.
SettingDescription:
allOf:
- $ref: "#/components/schemas/String"
- description: The description of the option group option.
DefaultValue:
allOf:
- $ref: "#/components/schemas/String"
- description: The default value for the option group option.
ApplyType:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB engine specific parameter type for the option group option.
AllowedValues:
allOf:
- $ref: "#/components/schemas/String"
- description: Indicates the acceptable values for the option group option.
IsModifiable:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Boolean value where true indicates that this option group option can be changed from the default value.
IsRequired:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Boolean value where true indicates that a value must be specified for this option setting of the option group option.
MinimumEngineVersionPerAllowedValue:
allOf:
- $ref: "#/components/schemas/MinimumEngineVersionPerAllowedValueList"
- description: The minimum DB engine version required for the corresponding allowed value for this option setting.
description: Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
OptionVersion:
type: object
properties:
Version:
allOf:
- $ref: "#/components/schemas/String"
- description: The version of the option.
IsDefault:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: True if the version is the default version of the option, and otherwise false.
description: The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.
OptionGroupOptionsList:
type: array
description: List of available option group options.
items:
allOf:
- $ref: "#/components/schemas/OptionGroupOption"
- xml:
name: OptionGroupOption
OptionGroupsList:
type: array
items:
allOf:
- $ref: "#/components/schemas/OptionGroup"
- xml:
name: OptionGroup
OptionSetting:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the option that has settings that you can set.
Value:
allOf:
- $ref: "#/components/schemas/String"
- description: The current value of the option setting.
DefaultValue:
allOf:
- $ref: "#/components/schemas/String"
- description: The default value of the option setting.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: The description of the option setting.
ApplyType:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB engine specific parameter type.
DataType:
allOf:
- $ref: "#/components/schemas/String"
- description: The data type of the option setting.
AllowedValues:
allOf:
- $ref: "#/components/schemas/String"
- description: The allowed values of the option setting.
IsModifiable:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A Boolean value that, when true, indicates the option setting can be modified from the default.
IsCollection:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates if the option setting is part of a collection.
description: Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
OrderableDBInstanceOption:
type: object
properties:
Engine:
allOf:
- $ref: "#/components/schemas/String"
- description: The engine type of a DB instance.
EngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The engine version of a DB instance.
DBInstanceClass:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB instance class for a DB instance.
LicenseModel:
allOf:
- $ref: "#/components/schemas/String"
- description: The license model for a DB instance.
AvailabilityZoneGroup:
allOf:
- $ref: "#/components/schemas/String"
- description: The Availability Zone group for a DB instance.
AvailabilityZones:
allOf:
- $ref: "#/components/schemas/AvailabilityZoneList"
- description: A list of Availability Zones for a DB instance.
MultiAZCapable:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether a DB instance is Multi-AZ capable.
ReadReplicaCapable:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether a DB instance can have a read replica.
Vpc:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether a DB instance is in a VPC.
SupportsStorageEncryption:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether a DB instance supports encrypted storage.
StorageType:
allOf:
- $ref: "#/components/schemas/String"
- description: Indicates the storage type for a DB instance.
SupportsIops:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether a DB instance supports provisioned IOPS.
SupportsEnhancedMonitoring:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
SupportsIAMDatabaseAuthentication:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether a DB instance supports IAM database authentication.
SupportsPerformanceInsights:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: True if a DB instance supports Performance Insights, otherwise false.
MinStorageSize:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Minimum storage size for a DB instance.
MaxStorageSize:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Maximum storage size for a DB instance.
MinIopsPerDbInstance:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Minimum total provisioned IOPS for a DB instance.
MaxIopsPerDbInstance:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Maximum total provisioned IOPS for a DB instance.
MinIopsPerGib:
allOf:
- $ref: "#/components/schemas/DoubleOptional"
- description: Minimum provisioned IOPS per GiB for a DB instance.
MaxIopsPerGib:
allOf:
- $ref: "#/components/schemas/DoubleOptional"
- description: Maximum provisioned IOPS per GiB for a DB instance.
AvailableProcessorFeatures:
allOf:
- $ref: "#/components/schemas/AvailableProcessorFeatureList"
- description: A list of the available processor features for the DB instance class of a DB instance.
SupportedEngineModes:
allOf:
- $ref: "#/components/schemas/EngineModeList"
- description: A list of the supported DB engine modes.
SupportsStorageAutoscaling:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
SupportsKerberosAuthentication:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Whether a DB instance supports Kerberos Authentication.
OutpostCapable:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
SupportedActivityStreamModes: allOf: - $ref: "#/components/schemas/ActivityStreamModeList" - description: The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value[sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.
SupportsGlobalDatabases:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
SupportsClusters:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
SupportedNetworkTypes: allOf: - $ref: "#/components/schemas/StringList" - description:The network types supported by the DB instance (IPV4 or DUAL).
A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
SupportsStorageThroughput: allOf: - $ref: "#/components/schemas/Boolean" - description: Indicates whether a DB instance supports storage throughput. MinStorageThroughputPerDbInstance: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: Minimum storage throughput for a DB instance. MaxStorageThroughputPerDbInstance: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: Maximum storage throughput for a DB instance. MinStorageThroughputPerIops: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: Minimum storage throughput to provisioned IOPS ratio for a DB instance. MaxStorageThroughputPerIops: allOf: - $ref: "#/components/schemas/DoubleOptional" - description: Maximum storage throughput to provisioned IOPS ratio for a DB instance. description:Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
A data type that represents an Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
PendingMaintenanceAction: type: object properties: Action: allOf: - $ref: "#/components/schemas/String" - description: The type of pending maintenance action that is available for the resource. Valid actions aresystem-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.
AutoAppliedAfterDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
ForcedApplyDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
OptInStatus: allOf: - $ref: "#/components/schemas/String" - description: Indicates the type of opt-in request that has been received for the resource. CurrentApplyDate: allOf: - $ref: "#/components/schemas/TStamp" - description: The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from theApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A description providing more detail about the maintenance action.
description: Provides information about a pending maintenance action for a resource.
PendingMaintenanceActionDetails:
type: array
items:
allOf:
- $ref: "#/components/schemas/PendingMaintenanceAction"
- xml:
name: PendingMaintenanceAction
PendingMaintenanceActions:
type: array
items:
allOf:
- $ref: "#/components/schemas/ResourcePendingMaintenanceActions"
- xml:
name: ResourcePendingMaintenanceActions
PromoteReadReplicaDBClusterMessage:
type: object
required:
- DBClusterIdentifier
title: PromoteReadReplicaDBClusterMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: "The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster read replica.
Example: my-cluster-replica1
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing read replica DB instance.
Example: mydbinstance
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
" ReservedDBInstanceId: allOf: - $ref: "#/components/schemas/String" - description: "Customer-specified identifier to track this reservation.
Example: myreservationID
" DBInstanceCount: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The number of instances to reserve.
Default: 1
The unique identifier for the lease associated with the reserved DB instance.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
Range:
type: object
properties:
From:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The minimum value in the range.
To:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The maximum value in the range.
Step:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
description: A range of integer values.
RangeList:
type: array
items:
allOf:
- $ref: "#/components/schemas/Range"
- xml:
name: Range
RebootDBClusterMessage:
type: object
required:
- DBClusterIdentifier
title: RebootDBClusterMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBCluster.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
" description: RecurringCharge: type: object properties: RecurringChargeAmount: allOf: - $ref: "#/components/schemas/Double" - description: The amount of the recurring charge. RecurringChargeFrequency: allOf: - $ref: "#/components/schemas/String" - description: The frequency of the recurring charge. description: This data type is used as a response element in theDescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
RecurringChargeList:
type: array
items:
allOf:
- $ref: "#/components/schemas/RecurringCharge"
- xml:
name: RecurringCharge
RegisterDBProxyTargetsRequest:
type: object
required:
- DBProxyName
title: RegisterDBProxyTargetsRequest
properties:
DBProxyName:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
TargetGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the DBProxyTargetGroup.
DBInstanceIdentifiers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: One or more DB instance identifiers.
DBClusterIdentifiers:
allOf:
- $ref: "#/components/schemas/StringList"
- description: One or more DB cluster identifiers.
RemoveFromGlobalClusterMessage:
type: object
title: RemoveFromGlobalClusterMessage
properties:
GlobalClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The cluster identifier to detach from the Aurora global database cluster.
DbClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
RemoveRoleFromDBClusterMessage:
type: object
required:
- DBClusterIdentifier
- RoleArn
title: RemoveRoleFromDBClusterMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB cluster to disassociate the IAM role from.
RoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
FeatureName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
RemoveRoleFromDBInstanceMessage:
type: object
required:
- DBInstanceIdentifier
- RoleArn
- FeatureName
title: RemoveRoleFromDBInstanceMessage
properties:
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB instance to disassociate the IAM role from.
RoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, arn:aws:iam::123456789012:role/AccessRole.
FeatureName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
RemoveSourceIdentifierFromSubscriptionMessage:
type: object
required:
- SubscriptionName
- SourceIdentifier
title: RemoveSourceIdentifierFromSubscriptionMessage
properties:
SubscriptionName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the RDS event notification subscription you want to remove a source identifier from.
SourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
description:
RemoveTagsFromResourceMessage:
type: object
required:
- ResourceName
- TagKeys
title: RemoveTagsFromResourceMessage
properties:
ResourceName:
allOf:
- $ref: "#/components/schemas/String"
- description: 'The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. '
TagKeys:
allOf:
- $ref: "#/components/schemas/KeyList"
- description: The tag key (name) of the tag to be removed.
description:
ReservedDBInstanceList:
type: array
items:
allOf:
- $ref: "#/components/schemas/ReservedDBInstance"
- xml:
name: ReservedDBInstance
ReservedDBInstancesOffering:
type: object
properties:
ReservedDBInstancesOfferingId:
allOf:
- $ref: "#/components/schemas/String"
- description: The offering identifier.
DBInstanceClass:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB instance class for the reserved DB instance.
Duration:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The duration of the offering in seconds.
FixedPrice:
allOf:
- $ref: "#/components/schemas/Double"
- description: The fixed price charged for this offering.
UsagePrice:
allOf:
- $ref: "#/components/schemas/Double"
- description: The hourly price charged for this offering.
CurrencyCode:
allOf:
- $ref: "#/components/schemas/String"
- description: The currency code for the reserved DB instance offering.
ProductDescription:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine used by the offering.
OfferingType:
allOf:
- $ref: "#/components/schemas/String"
- description: The offering type.
MultiAZ:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates if the offering applies to Multi-AZ deployments.
RecurringCharges:
allOf:
- $ref: "#/components/schemas/RecurringChargeList"
- description: The recurring price charged to run this reserved DB instance.
description: This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
ReservedDBInstancesOfferingList:
type: array
items:
allOf:
- $ref: "#/components/schemas/ReservedDBInstancesOffering"
- xml:
name: ReservedDBInstancesOffering
ResetDBClusterParameterGroupMessage:
type: object
required:
- DBClusterParameterGroupName
title: ResetDBClusterParameterGroupMessage
properties:
DBClusterParameterGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB cluster parameter group to reset.
ResetAllParameters:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
Parameters:
allOf:
- $ref: "#/components/schemas/ParametersList"
- description: A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.
description:
ResetDBParameterGroupMessage:
type: object
required:
- DBParameterGroupName
title: ResetDBParameterGroupMessage
properties:
DBParameterGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DB parameter group.
Constraints:
Must match the name of an existing DBParameterGroup.
To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
MariaDB
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The name of the database engine to be used for this DB cluster.
Valid Values: aurora-mysql (for Aurora MySQL)
The version number of the database engine to use.
To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Examples: 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
PreferredBackupWindow: allOf: - $ref: "#/components/schemas/String" - description:The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
' Tags: $ref: "#/components/schemas/TagList" StorageEncrypted: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: A value that indicates whether the restored DB cluster is encrypted. KmsKeyId: allOf: - $ref: "#/components/schemas/String" - description:The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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.
SourceEngine: allOf: - $ref: "#/components/schemas/String" - description: "The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40, 5.7.28
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: 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. CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Domain: allOf: - $ref: "#/components/schemas/String" - description:Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
DomainIAMRoleName: allOf: - $ref: "#/components/schemas/String" - description: Specify the name of the IAM role to be used when making API calls to the Directory Service. ServerlessV2ScalingConfiguration: $ref: "#/components/schemas/ServerlessV2ScalingConfiguration" NetworkType: allOf: - $ref: "#/components/schemas/String" - description:The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ManageMasterUserPassword: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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 MasterUserPassword is specified.
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 the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
RestoreDBClusterFromSnapshotMessage: type: object required: - DBClusterIdentifier - SnapshotIdentifier - Engine title: RestoreDBClusterFromSnapshotMessage properties: AvailabilityZones: allOf: - $ref: "#/components/schemas/AvailabilityZones" - description: "Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
" DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" SnapshotIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Engine: allOf: - $ref: "#/components/schemas/String" - description: "The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" EngineVersion: allOf: - $ref: "#/components/schemas/String" - description: "The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"
Aurora MySQL
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Port: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" DBSubnetGroupName: allOf: - $ref: "#/components/schemas/String" - description: "The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" DatabaseName: allOf: - $ref: "#/components/schemas/String" - description: "The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description:The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: "A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Tags: allOf: - $ref: "#/components/schemas/TagList" - description: "The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" KmsKeyId: allOf: - $ref: "#/components/schemas/String" - description: "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" EnableIAMDatabaseAuthentication: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" BacktrackWindow: allOf: - $ref: "#/components/schemas/LongOptional" - description: "The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
" EnableCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description: 'The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
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
' EngineMode: allOf: - $ref: "#/components/schemas/String" - description: 'The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
' ScalingConfiguration: allOf: - $ref: "#/components/schemas/ScalingConfiguration" - description: "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" DBClusterParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: "The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Domain: allOf: - $ref: "#/components/schemas/String" - description: 'Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
' DomainIAMRoleName: allOf: - $ref: "#/components/schemas/String" - description: "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
" DBClusterInstanceClass: allOf: - $ref: "#/components/schemas/String" - description: 'The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
' StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Iops: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
' PubliclyAccessible: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" ServerlessV2ScalingConfiguration: $ref: "#/components/schemas/ServerlessV2ScalingConfiguration" NetworkType: allOf: - $ref: "#/components/schemas/String" - description: 'The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' description: RestoreDBClusterToPointInTimeMessage: type: object required: - DBClusterIdentifier - SourceDBClusterIdentifier title: RestoreDBClusterToPointInTimeMessage properties: DBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" RestoreType: allOf: - $ref: "#/components/schemas/String" - description: "The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" SourceDBClusterIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" RestoreToTime: allOf: - $ref: "#/components/schemas/TStamp" - description: "The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" UseLatestRestorableTime: allOf: - $ref: "#/components/schemas/Boolean" - description: "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Port: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535.
Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" DBSubnetGroupName: allOf: - $ref: "#/components/schemas/String" - description: "The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description:The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: "A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Tags: $ref: "#/components/schemas/TagList" KmsKeyId: allOf: - $ref: "#/components/schemas/String" - description: "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" EnableIAMDatabaseAuthentication: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" BacktrackWindow: allOf: - $ref: "#/components/schemas/LongOptional" - description: "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
" EnableCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description: 'The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
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
' DBClusterParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description: "The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "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
" CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" Domain: allOf: - $ref: "#/components/schemas/String" - description: 'Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' DomainIAMRoleName: allOf: - $ref: "#/components/schemas/String" - description: "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
" ScalingConfiguration: allOf: - $ref: "#/components/schemas/ScalingConfiguration" - description: "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" EngineMode: allOf: - $ref: "#/components/schemas/String" - description: "The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
" DBClusterInstanceClass: allOf: - $ref: "#/components/schemas/String" - description: 'The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
' StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
" PubliclyAccessible: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
" Iops: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
' ServerlessV2ScalingConfiguration: $ref: "#/components/schemas/ServerlessV2ScalingConfiguration" NetworkType: allOf: - $ref: "#/components/schemas/String" - description: 'The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
' description: RestoreDBInstanceFromDBSnapshotMessage: type: object required: - DBInstanceIdentifier title: RestoreDBInstanceFromDBSnapshotMessage properties: DBInstanceIdentifier: allOf: - $ref: "#/components/schemas/String" - description: "Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
Can't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
' Port: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
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.
For more information, see CreateDBInstance.
AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
LicenseModel: allOf: - $ref: "#/components/schemas/String" - description: "License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
Engine: allOf: - $ref: "#/components/schemas/String" - description: "The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
" OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description:The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
Tags: $ref: "#/components/schemas/TagList" StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
TdeCredentialPassword: allOf: - $ref: "#/components/schemas/String" - description:The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: "A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
" Domain: allOf: - $ref: "#/components/schemas/String" - description:Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
DomainIAMRoleName: allOf: - $ref: "#/components/schemas/String" - description: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.
EnableIAMDatabaseAuthentication: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
EnableCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description:The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
ProcessorFeatures: allOf: - $ref: "#/components/schemas/ProcessorFeatureList" - description: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.
UseDefaultProcessorFeatures: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
DBParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description:The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
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.
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.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
CustomIamInstanceProfile: allOf: - $ref: "#/components/schemas/String" - description: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.
BackupTarget: allOf: - $ref: "#/components/schemas/String" - description:Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
NetworkType: allOf: - $ref: "#/components/schemas/String" - description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
StorageThroughput: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
DBClusterSnapshotIdentifier: allOf: - $ref: "#/components/schemas/String" - description:The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
CreateDBInstance.
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: "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
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
Engine: allOf: - $ref: "#/components/schemas/String" - description: "The name of the database engine to be used for this instance.
Valid Values: mysql
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints: Can't be specified if ManageMasterUserPassword is 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.
" DBSecurityGroups: allOf: - $ref: "#/components/schemas/DBSecurityGroupNameList" - description: "A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
" VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: A list of VPC security groups to associate with this DB instance. AvailabilityZone: allOf: - $ref: "#/components/schemas/String" - description: "The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
CreateDBInstance.
PreferredBackupWindow:
allOf:
- $ref: "#/components/schemas/String"
- description: The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
AvailabilityZone parameter.
EngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
AutoMinorVersionUpgrade:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: 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 not applied automatically.
LicenseModel:
allOf:
- $ref: "#/components/schemas/String"
- description: The license model for this DB instance. Use general-public-license.
Iops:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: 'The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide. '
OptionGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
PubliclyAccessible:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: 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.
For more information, see CreateDBInstance.
Tags: allOf: - $ref: "#/components/schemas/TagList" - description: 'A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. ' StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
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.
SourceEngine: allOf: - $ref: "#/components/schemas/String" - description: "The name of the engine of your source database.
Valid Values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
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.
PerformanceInsightsKMSKeyId: allOf: - $ref: "#/components/schemas/String" - description: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.
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.
EnableCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description: The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. ProcessorFeatures: allOf: - $ref: "#/components/schemas/ProcessorFeatureList" - description: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. UseDefaultProcessorFeatures: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: A value that indicates whether the DB instance class of the DB instance uses its default processor features. DeletionProtection: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: 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. MaxAllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: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.
NetworkType: allOf: - $ref: "#/components/schemas/String" - description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
StorageThroughput: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
ManageMasterUserPassword: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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 MasterUserPassword is specified.
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 the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
RestoreDBInstanceToPointInTimeMessage: type: object required: - TargetDBInstanceIdentifier title: RestoreDBInstanceToPointInTimeMessage properties: SourceDBInstanceIdentifier: allOf: - $ref: "#/components/schemas/String" - description:The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime parameter is provided.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
' Port: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: "The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
" AvailabilityZone: allOf: - $ref: "#/components/schemas/String" - description: "The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
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.
AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
LicenseModel: allOf: - $ref: "#/components/schemas/String" - description: "License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
" OptionGroupName: allOf: - $ref: "#/components/schemas/String" - description:The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
CopyTagsToSnapshot: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied. Tags: $ref: "#/components/schemas/TagList" StorageType: allOf: - $ref: "#/components/schemas/String" - description: "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
TdeCredentialPassword: allOf: - $ref: "#/components/schemas/String" - description:The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: "A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
" Domain: allOf: - $ref: "#/components/schemas/String" - description:Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
DomainIAMRoleName: allOf: - $ref: "#/components/schemas/String" - description: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.
EnableIAMDatabaseAuthentication: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
EnableCloudwatchLogsExports: allOf: - $ref: "#/components/schemas/LogTypeList" - description:The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
ProcessorFeatures: allOf: - $ref: "#/components/schemas/ProcessorFeatureList" - description: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.
UseDefaultProcessorFeatures: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
DBParameterGroupName: allOf: - $ref: "#/components/schemas/String" - description:The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
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.
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.
SourceDBInstanceAutomatedBackupsArn: allOf: - $ref: "#/components/schemas/String" - description:The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
EnableCustomerOwnedIp: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: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.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
CustomIamInstanceProfile: allOf: - $ref: "#/components/schemas/String" - description: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.
BackupTarget: allOf: - $ref: "#/components/schemas/String" - description:Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
NetworkType: allOf: - $ref: "#/components/schemas/String" - description:The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
StorageThroughput: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
AllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.
EC2SecurityGroupName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
EC2SecurityGroupId:
allOf:
- $ref: "#/components/schemas/String"
- description: The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
EC2SecurityGroupOwnerId:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
description:
SourceRegion:
type: object
properties:
RegionName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the source Amazon Web Services Region.
Endpoint:
allOf:
- $ref: "#/components/schemas/String"
- description: The endpoint for the source Amazon Web Services Region endpoint.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: The status of the source Amazon Web Services Region.
SupportsDBInstanceAutomatedBackupsReplication:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
description: Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.
SourceRegionList:
type: array
items:
allOf:
- $ref: "#/components/schemas/SourceRegion"
- xml:
name: SourceRegion
StartActivityStreamRequest:
type: object
required:
- ResourceArn
- Mode
- KmsKeyId
title: StartActivityStreamRequest
properties:
ResourceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
Mode:
allOf:
- $ref: "#/components/schemas/ActivityStreamMode"
- description: Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
KmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ApplyImmediately:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
EngineNativeAuditFieldsIncluded:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
StartDBClusterMessage:
type: object
required:
- DBClusterIdentifier
title: StartDBClusterMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
StartDBInstanceAutomatedBackupsReplicationMessage:
type: object
required:
- SourceDBInstanceArn
title: StartDBInstanceAutomatedBackupsReplicationMessage
properties:
SourceDBInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
BackupRetentionPeriod:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The retention period for the replicated automated backups.
KmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
PreSignedUrl:
allOf:
- $ref: "#/components/schemas/String"
- description: "In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
s3:PutObject*
s3:GetObject*
s3:ListBucket
s3:DeleteObject*
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
arn:aws:s3:::your-s3-bucket
arn:aws:s3:::your-s3-bucket/*
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant
The data to be exported from the snapshot or cluster. If this parameter is not provided, all of the data is exported. Valid values are the following:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
ApplyImmediately:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
StopDBClusterMessage:
type: object
required:
- DBClusterIdentifier
title: StopDBClusterMessage
properties:
DBClusterIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
StopDBInstanceAutomatedBackupsReplicationMessage:
type: object
required:
- SourceDBInstanceArn
title: StopDBInstanceAutomatedBackupsReplicationMessage
properties:
SourceDBInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automate backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
StopDBInstanceMessage:
type: object
required:
- DBInstanceIdentifier
title: StopDBInstanceMessage
properties:
DBInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The user-supplied instance identifier.
DBSnapshotIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
Subnet:
type: object
properties:
SubnetIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the subnet.
SubnetAvailabilityZone:
$ref: "#/components/schemas/AvailabilityZone"
SubnetOutpost:
allOf:
- $ref: "#/components/schemas/Outpost"
- description: If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
SubnetStatus: allOf: - $ref: "#/components/schemas/String" - description: The status of the subnet. description: This data type is used as a response element for theDescribeDBSubnetGroups operation.
Timezone:
type: object
properties:
TimezoneName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the time zone.
description: A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.
SwitchoverTimeout:
type: integer
minimum: 30
SwitchoverBlueGreenDeploymentRequest:
type: object
required:
- BlueGreenDeploymentIdentifier
title: SwitchoverBlueGreenDeploymentRequest
properties:
BlueGreenDeploymentIdentifier:
allOf:
- $ref: "#/components/schemas/BlueGreenDeploymentIdentifier"
- description: The blue/green deployment identifier.
Constraints:
Must match an existing blue/green deployment identifier.
The amount of time, in seconds, for the switchover to complete. The default is 300.
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.
SwitchoverDetailStatus: type: string SwitchoverDetail: type: object properties: SourceMember: allOf: - $ref: "#/components/schemas/DatabaseArn" - description: The Amazon Resource Name (ARN) of a resource in the blue environment. TargetMember: allOf: - $ref: "#/components/schemas/DatabaseArn" - description: The Amazon Resource Name (ARN) of a resource in the green environment. Status: allOf: - $ref: "#/components/schemas/SwitchoverDetailStatus" - description:The switchover status of a resource in a blue/green deployment.
Values:
PROVISIONING - The resource is being prepared to switch over.
AVAILABLE - The resource is ready to switch over.
SWITCHOVER_IN_PROGRESS - The resource is being switched over.
SWITCHOVER_COMPLETED - The resource has been switched over.
SWITCHOVER_FAILED - The resource attempted to switch over but failed.
MISSING_SOURCE - The source resource has been deleted.
MISSING_TARGET - The target resource has been deleted.
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.
SwitchoverReadReplicaMessage: type: object required: - DBInstanceIdentifier title: SwitchoverReadReplicaMessage properties: DBInstanceIdentifier: allOf: - $ref: "#/components/schemas/String" - description:The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
Must match the identiï¬er of an existing Oracle read replica DB instance.
AutoMinorVersionUpgrade set to true.
IsMajorVersionUpgrade:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes:
allOf:
- $ref: "#/components/schemas/EngineModeList"
- description: A list of the supported DB engine modes for the target engine version.
SupportsParallelQuery:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
description: The version of the database engine that a DB instance can be upgraded to.
UserAuthConfigInfo:
type: object
properties:
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A user-specified description about the authentication used by a proxy to log in as a specific database user.
UserName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the database user to which the proxy connects.
AuthScheme:
allOf:
- $ref: "#/components/schemas/AuthScheme"
- description: The type of authentication that the proxy uses for connections from the proxy to the underlying database.
SecretArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
IAMAuth:
allOf:
- $ref: "#/components/schemas/IAMAuthMode"
- description: Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
ClientPasswordAuthType:
allOf:
- $ref: "#/components/schemas/ClientPasswordAuthType"
- description: The type of authentication the proxy uses for connections from clients.
description: Returns the details of authentication used by a proxy to log in as a specific database user.
ValidStorageOptionsList:
type: array
items:
allOf:
- $ref: "#/components/schemas/ValidStorageOptions"
- xml:
name: ValidStorageOptions
ValidStorageOptions:
type: object
properties:
StorageType:
allOf:
- $ref: "#/components/schemas/String"
- description: "The valid storage types for your DB instance. For example: gp2, gp3, io1."
StorageSize:
allOf:
- $ref: "#/components/schemas/RangeList"
- description: The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.
ProvisionedIops:
allOf:
- $ref: "#/components/schemas/RangeList"
- description: The valid range of provisioned IOPS. For example, 1000-256,000.
IopsToStorageRatio:
allOf:
- $ref: "#/components/schemas/DoubleRangeList"
- description: The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
SupportsStorageAutoscaling:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
ProvisionedStorageThroughput:
allOf:
- $ref: "#/components/schemas/RangeList"
- description: The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).
StorageThroughputToIopsRatio:
allOf:
- $ref: "#/components/schemas/DoubleRangeList"
- description: The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.
description: Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.
VpcSecurityGroupMembership:
type: object
properties:
VpcSecurityGroupId:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the VPC security group.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: The membership status of the VPC security group.
Currently, the only valid status is active.