Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/rds.ts?docs=full";

§Classes

RDS

§Interfaces

AccountAttributesMessage

Data returned by the DescribeAccountAttributes action.

AccountQuota

Describes a quota for an Amazon Web Services account.

AddRoleToDBClusterMessage
AddRoleToDBInstanceMessage
AddSourceIdentifierToSubscriptionMessage
AddSourceIdentifierToSubscriptionResult
AddTagsToResourceMessage
ApplyPendingMaintenanceActionMessage
ApplyPendingMaintenanceActionResult
AuthorizeDBSecurityGroupIngressMessage
AuthorizeDBSecurityGroupIngressResult
AvailabilityZone

Contains Availability Zone information.

AvailableProcessorFeature

Contains the available processor feature information for the DB instance class of a DB instance.

BacktrackDBClusterMessage
BlueGreenDeployment

Contains the details about a blue/green deployment.

BlueGreenDeploymentTask

Contains the details about a task for a blue/green deployment.

CancelExportTaskMessage
Certificate

A CA certificate for an Amazon Web Services account.

CertificateDetails

Returns the details of the DB instance’s server certificate.

CertificateMessage

Data returned by the DescribeCertificates action.

CharacterSet

This data type is used as a response element in the action DescribeDBEngineVersions.

CloudwatchLogsExportConfiguration

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

ClusterPendingModifiedValues

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

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

ConnectionPoolConfigurationInfo

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

CopyDBClusterParameterGroupMessage
CopyDBClusterParameterGroupResult
CopyDBClusterSnapshotMessage
CopyDBClusterSnapshotResult
CopyDBParameterGroupMessage
CopyDBParameterGroupResult
CopyDBSnapshotMessage
CopyDBSnapshotResult
CopyOptionGroupMessage
CopyOptionGroupResult
CreateBlueGreenDeploymentRequest
CreateBlueGreenDeploymentResponse
CreateCustomDBEngineVersionMessage
CreateDBClusterEndpointMessage
CreateDBClusterMessage
CreateDBClusterParameterGroupMessage
CreateDBClusterParameterGroupResult
CreateDBClusterResult
CreateDBClusterSnapshotMessage
CreateDBClusterSnapshotResult
CreateDBInstanceMessage
CreateDBInstanceReadReplicaMessage
CreateDBInstanceReadReplicaResult
CreateDBInstanceResult
CreateDBParameterGroupMessage
CreateDBParameterGroupResult
CreateDBProxyEndpointRequest
CreateDBProxyEndpointResponse
CreateDBProxyRequest
CreateDBProxyResponse
CreateDBSecurityGroupMessage
CreateDBSecurityGroupResult
CreateDBSnapshotMessage
CreateDBSnapshotResult
CreateDBSubnetGroupMessage
CreateDBSubnetGroupResult
CreateEventSubscriptionMessage
CreateEventSubscriptionResult
CreateGlobalClusterMessage
CreateGlobalClusterResult
CreateOptionGroupMessage
CreateOptionGroupResult
CustomDBEngineVersionAMI

A value that indicates the AMI information.

DBCluster

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

DBClusterBacktrack

This data type is used as a response element in the DescribeDBClusterBacktracks action.

DBClusterBacktrackMessage

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

DBClusterCapacityInfo
DBClusterEndpoint

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:

DBClusterEndpointMessage
DBClusterMember

Contains information about an instance that is part of a DB cluster.

DBClusterMessage

Contains the result of a successful invocation of the DescribeDBClusters action.

DBClusterOptionGroupStatus

Contains status information for a DB cluster option group.

DBClusterParameterGroup

Contains the details of an Amazon RDS DB cluster parameter group.

DBClusterParameterGroupDetails

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

DBClusterParameterGroupNameMessage
DBClusterParameterGroupsMessage
DBClusterRole

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

DBClusterSnapshot

Contains the details for an Amazon RDS DB cluster snapshot

DBClusterSnapshotAttribute

Contains the name and values of a manual DB cluster snapshot attribute.

DBClusterSnapshotAttributesResult

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

DBClusterSnapshotMessage

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

DBEngineVersion

This data type is used as a response element in the action DescribeDBEngineVersions.

DBEngineVersionMessage

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

DBInstance

Contains the details of an Amazon RDS DB instance.

DBInstanceAutomatedBackup

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.

DBInstanceAutomatedBackupMessage

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

DBInstanceAutomatedBackupsReplication

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

DBInstanceMessage

Contains the result of a successful invocation of the DescribeDBInstances action.

DBInstanceRole

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

DBInstanceStatusInfo

Provides a list of status information for a DB instance.

DBParameterGroup

Contains the details of an Amazon RDS DB parameter group.

DBParameterGroupDetails

Contains the result of a successful invocation of the DescribeDBParameters action.

DBParameterGroupNameMessage

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

DBParameterGroupsMessage

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

DBParameterGroupStatus

The status of the DB parameter group.

DBProxy

The data structure representing a proxy managed by the RDS Proxy.

DBProxyEndpoint

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.

DBProxyTarget

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.

DBProxyTargetGroup

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.

DBSecurityGroup

Contains the details for an Amazon RDS DB security group.

DBSecurityGroupMembership

This data type is used as a response element in the following actions:

DBSecurityGroupMessage

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

DBSnapshot

Contains the details of an Amazon RDS DB snapshot.

DBSnapshotAttribute

Contains the name and values of a manual DB snapshot attribute

DBSnapshotAttributesResult

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

DBSnapshotMessage

Contains the result of a successful invocation of the DescribeDBSnapshots action.

DBSubnetGroup

Contains the details of an Amazon RDS DB subnet group.

DBSubnetGroupMessage

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

DeleteBlueGreenDeploymentRequest
DeleteBlueGreenDeploymentResponse
DeleteCustomDBEngineVersionMessage
DeleteDBClusterEndpointMessage
DeleteDBClusterMessage
DeleteDBClusterParameterGroupMessage
DeleteDBClusterResult
DeleteDBClusterSnapshotMessage
DeleteDBClusterSnapshotResult
DeleteDBInstanceAutomatedBackupMessage

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

DeleteDBInstanceAutomatedBackupResult
DeleteDBInstanceMessage
DeleteDBInstanceResult
DeleteDBParameterGroupMessage
DeleteDBProxyEndpointRequest
DeleteDBProxyEndpointResponse
DeleteDBProxyRequest
DeleteDBProxyResponse
DeleteDBSecurityGroupMessage
DeleteDBSnapshotMessage
DeleteDBSnapshotResult
DeleteDBSubnetGroupMessage
DeleteEventSubscriptionMessage
DeleteEventSubscriptionResult
DeleteGlobalClusterMessage
DeleteGlobalClusterResult
DeleteOptionGroupMessage
DeregisterDBProxyTargetsRequest
DescribeBlueGreenDeploymentsRequest
DescribeBlueGreenDeploymentsResponse
DescribeCertificatesMessage
DescribeDBClusterBacktracksMessage
DescribeDBClusterEndpointsMessage
DescribeDBClusterParameterGroupsMessage
DescribeDBClusterParametersMessage
DescribeDBClustersMessage
DescribeDBClusterSnapshotAttributesMessage
DescribeDBClusterSnapshotAttributesResult
DescribeDBClusterSnapshotsMessage
DescribeDBEngineVersionsMessage
DescribeDBInstanceAutomatedBackupsMessage

Parameter input for DescribeDBInstanceAutomatedBackups.

DescribeDBInstancesMessage
DescribeDBLogFilesDetails

This data type is used as a response element to DescribeDBLogFiles.

DescribeDBLogFilesMessage
DescribeDBLogFilesResponse

The response from a call to DescribeDBLogFiles.

DescribeDBParameterGroupsMessage
DescribeDBParametersMessage
DescribeDBProxiesRequest
DescribeDBProxiesResponse
DescribeDBProxyEndpointsRequest
DescribeDBProxyEndpointsResponse
DescribeDBProxyTargetGroupsRequest
DescribeDBProxyTargetGroupsResponse
DescribeDBProxyTargetsRequest
DescribeDBProxyTargetsResponse
DescribeDBSecurityGroupsMessage
DescribeDBSnapshotAttributesMessage
DescribeDBSnapshotAttributesResult
DescribeDBSnapshotsMessage
DescribeDBSubnetGroupsMessage
DescribeEngineDefaultClusterParametersMessage
DescribeEngineDefaultClusterParametersResult
DescribeEngineDefaultParametersMessage
DescribeEngineDefaultParametersResult
DescribeEventCategoriesMessage
DescribeEventsMessage
DescribeEventSubscriptionsMessage
DescribeExportTasksMessage
DescribeGlobalClustersMessage
DescribeOptionGroupOptionsMessage
DescribeOptionGroupsMessage
DescribeOrderableDBInstanceOptionsMessage
DescribePendingMaintenanceActionsMessage
DescribeReservedDBInstancesMessage
DescribeReservedDBInstancesOfferingsMessage
DescribeSourceRegionsMessage
DescribeValidDBInstanceModificationsMessage
DescribeValidDBInstanceModificationsResult
DomainMembership

An Active Directory Domain membership record associated with the DB instance or cluster.

DoubleRange

A range of double values.

DownloadDBLogFilePortionDetails

This data type is used as a response element to DownloadDBLogFilePortion.

DownloadDBLogFilePortionMessage
EC2SecurityGroup

This data type is used as a response element in the following actions:

Endpoint

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:

EngineDefaults

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

Event

This data type is used as a response element in the DescribeEvents action.

EventCategoriesMap

Contains the results of a successful invocation of the DescribeEventCategories operation.

EventCategoriesMessage

Data returned from the DescribeEventCategories operation.

EventsMessage

Contains the result of a successful invocation of the DescribeEvents action.

EventSubscription

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

EventSubscriptionsMessage

Data returned by the DescribeEventSubscriptions action.

ExportTask

Contains the details of a snapshot or cluster export to Amazon S3.

ExportTasksMessage
FailoverDBClusterMessage
FailoverDBClusterResult
FailoverGlobalClusterMessage
FailoverGlobalClusterResult
FailoverState

Contains the state of scheduled or in-process failover operations on an Aurora global database ("GlobalCluster"). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.

Filter

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.

GlobalCluster

A data type representing an Aurora global database.

GlobalClusterMember

A data structure with information about any primary and secondary clusters associated with an Aurora global database.

GlobalClustersMessage
IPRange

This data type is used as a response element in the DescribeDBSecurityGroups action.

ListTagsForResourceMessage
MasterUserSecret

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

MinimumEngineVersionPerAllowedValue

The minimum DB engine version required for each corresponding allowed value for an option setting.

ModifyActivityStreamRequest
ModifyActivityStreamResponse
ModifyCertificatesMessage
ModifyCertificatesResult
ModifyCurrentDBClusterCapacityMessage
ModifyCustomDBEngineVersionMessage
ModifyDBClusterEndpointMessage
ModifyDBClusterMessage
ModifyDBClusterParameterGroupMessage
ModifyDBClusterResult
ModifyDBClusterSnapshotAttributeMessage
ModifyDBClusterSnapshotAttributeResult
ModifyDBInstanceMessage
ModifyDBInstanceResult
ModifyDBParameterGroupMessage
ModifyDBProxyEndpointRequest
ModifyDBProxyEndpointResponse
ModifyDBProxyRequest
ModifyDBProxyResponse
ModifyDBProxyTargetGroupRequest
ModifyDBProxyTargetGroupResponse
ModifyDBSnapshotAttributeMessage
ModifyDBSnapshotAttributeResult
ModifyDBSnapshotMessage
ModifyDBSnapshotResult
ModifyDBSubnetGroupMessage
ModifyDBSubnetGroupResult
ModifyEventSubscriptionMessage
ModifyEventSubscriptionResult
ModifyGlobalClusterMessage
ModifyGlobalClusterResult
ModifyOptionGroupMessage
ModifyOptionGroupResult
Option

Option details.

OptionConfiguration

A list of all available options

OptionGroup
OptionGroupMembership

Provides information on the option groups the DB instance is a member of.

OptionGroupOption

Available option.

OptionGroupOptionSetting

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.

OptionGroupOptionsMessage
OptionGroups

List of option groups.

OptionSetting

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.

OptionVersion

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

OrderableDBInstanceOption

Contains a list of available options for a DB instance.

OrderableDBInstanceOptionsMessage

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

Outpost

A data type that represents an Outpost.

Parameter

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

PendingCloudwatchLogsExports

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.

PendingMaintenanceAction

Provides information about a pending maintenance action for a resource.

PendingMaintenanceActionsMessage

Data returned from the DescribePendingMaintenanceActions action.

PendingModifiedValues

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.

ProcessorFeature

Contains the processor features of a DB instance class.

PromoteReadReplicaDBClusterMessage
PromoteReadReplicaDBClusterResult
PromoteReadReplicaMessage
PromoteReadReplicaResult
PurchaseReservedDBInstancesOfferingMessage
PurchaseReservedDBInstancesOfferingResult
Range

A range of integer values.

RebootDBClusterMessage
RebootDBClusterResult
RebootDBInstanceMessage
RebootDBInstanceResult
RecurringCharge

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

RegisterDBProxyTargetsRequest
RegisterDBProxyTargetsResponse
RemoveFromGlobalClusterMessage
RemoveFromGlobalClusterResult
RemoveRoleFromDBClusterMessage
RemoveRoleFromDBInstanceMessage
RemoveSourceIdentifierFromSubscriptionMessage
RemoveSourceIdentifierFromSubscriptionResult
RemoveTagsFromResourceMessage
ReservedDBInstance

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

ReservedDBInstanceMessage

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

ReservedDBInstancesOffering

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

ReservedDBInstancesOfferingMessage

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

ResetDBClusterParameterGroupMessage
ResetDBParameterGroupMessage
ResourcePendingMaintenanceActions

Describes the pending maintenance actions for a resource.

RestoreDBClusterFromS3Message
RestoreDBClusterFromS3Result
RestoreDBClusterFromSnapshotMessage
RestoreDBClusterFromSnapshotResult
RestoreDBClusterToPointInTimeMessage
RestoreDBClusterToPointInTimeResult
RestoreDBInstanceFromDBSnapshotMessage
RestoreDBInstanceFromDBSnapshotResult
RestoreDBInstanceFromS3Message
RestoreDBInstanceFromS3Result
RestoreDBInstanceToPointInTimeMessage
RestoreDBInstanceToPointInTimeResult
RestoreWindow

Earliest and latest time an instance can be restored to:

RevokeDBSecurityGroupIngressMessage
RevokeDBSecurityGroupIngressResult
ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

ScalingConfigurationInfo

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

ServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

ServerlessV2ScalingConfigurationInfo

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

SourceRegion

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

SourceRegionMessage

Contains the result of a successful invocation of the DescribeSourceRegions action.

StartActivityStreamRequest
StartActivityStreamResponse
StartDBClusterMessage
StartDBClusterResult
StartDBInstanceAutomatedBackupsReplicationMessage
StartDBInstanceAutomatedBackupsReplicationResult
StartDBInstanceMessage
StartDBInstanceResult
StartExportTaskMessage
StopActivityStreamRequest
StopActivityStreamResponse
StopDBClusterMessage
StopDBClusterResult
StopDBInstanceAutomatedBackupsReplicationMessage
StopDBInstanceAutomatedBackupsReplicationResult
StopDBInstanceMessage
StopDBInstanceResult
Subnet

This data type is used as a response element for the DescribeDBSubnetGroups operation.

SwitchoverBlueGreenDeploymentRequest
SwitchoverBlueGreenDeploymentResponse
SwitchoverDetail

Contains the details about a blue/green deployment.

SwitchoverReadReplicaMessage
SwitchoverReadReplicaResult
Tag

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

TagListMessage
TargetHealth

Information about the connection health of an RDS Proxy target.

Timezone

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.

UpgradeTarget

The version of the database engine that a DB instance can be upgraded to.

UserAuthConfig

Specifies the details of authentication used by a proxy to log in as a specific database user.

UserAuthConfigInfo

Returns the details of authentication used by a proxy to log in as a specific database user.

ValidDBInstanceModificationsMessage

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.

ValidStorageOptions

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

VpcSecurityGroupMembership

This data type is used as a response element for queries on VPC security group membership.

§Type Aliases

ActivityStreamMode
ActivityStreamPolicyStatus
ActivityStreamStatus
ApplyMethod
AuditPolicyState
AuthScheme
AutomationMode
ClientPasswordAuthType
CustomEngineVersionStatus
DBProxyEndpointStatus
DBProxyEndpointTargetRole
DBProxyStatus
EngineFamily
ExportSourceType
FailoverStatus
IAMAuthMode
ReplicaMode
SourceType
TargetHealthReason
TargetRole
TargetState
TargetType
WriteForwardingStatus