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

DocDB

import { DocDB } from "https://aws-api-gyr5wj9zj0fg.deno.dev/v0.2/services/docdb.ts";
class DocDB {
constructor(apiFactory: client.ApiFactory);
async addSourceIdentifierToSubscription(params: AddSourceIdentifierToSubscriptionMessage, opts?: client.RequestOptions): Promise<AddSourceIdentifierToSubscriptionResult>;
async addTagsToResource(params: AddTagsToResourceMessage, opts?: client.RequestOptions): Promise<void>;
async applyPendingMaintenanceAction(params: ApplyPendingMaintenanceActionMessage, opts?: client.RequestOptions): Promise<ApplyPendingMaintenanceActionResult>;
async copyDBClusterParameterGroup(params: CopyDBClusterParameterGroupMessage, opts?: client.RequestOptions): Promise<CopyDBClusterParameterGroupResult>;
async copyDBClusterSnapshot(params: CopyDBClusterSnapshotMessage, opts?: client.RequestOptions): Promise<CopyDBClusterSnapshotResult>;
async createDBCluster(params: CreateDBClusterMessage, opts?: client.RequestOptions): Promise<CreateDBClusterResult>;
async createDBClusterParameterGroup(params: CreateDBClusterParameterGroupMessage, opts?: client.RequestOptions): Promise<CreateDBClusterParameterGroupResult>;
async createDBClusterSnapshot(params: CreateDBClusterSnapshotMessage, opts?: client.RequestOptions): Promise<CreateDBClusterSnapshotResult>;
async createDBInstance(params: CreateDBInstanceMessage, opts?: client.RequestOptions): Promise<CreateDBInstanceResult>;
async createDBSubnetGroup(params: CreateDBSubnetGroupMessage, opts?: client.RequestOptions): Promise<CreateDBSubnetGroupResult>;
async createEventSubscription(params: CreateEventSubscriptionMessage, opts?: client.RequestOptions): Promise<CreateEventSubscriptionResult>;
async createGlobalCluster(params: CreateGlobalClusterMessage, opts?: client.RequestOptions): Promise<CreateGlobalClusterResult>;
async deleteDBCluster(params: DeleteDBClusterMessage, opts?: client.RequestOptions): Promise<DeleteDBClusterResult>;
async deleteDBClusterParameterGroup(params: DeleteDBClusterParameterGroupMessage, opts?: client.RequestOptions): Promise<void>;
async deleteDBClusterSnapshot(params: DeleteDBClusterSnapshotMessage, opts?: client.RequestOptions): Promise<DeleteDBClusterSnapshotResult>;
async deleteDBInstance(params: DeleteDBInstanceMessage, opts?: client.RequestOptions): Promise<DeleteDBInstanceResult>;
async deleteDBSubnetGroup(params: DeleteDBSubnetGroupMessage, opts?: client.RequestOptions): Promise<void>;
async deleteEventSubscription(params: DeleteEventSubscriptionMessage, opts?: client.RequestOptions): Promise<DeleteEventSubscriptionResult>;
async deleteGlobalCluster(params: DeleteGlobalClusterMessage, opts?: client.RequestOptions): Promise<DeleteGlobalClusterResult>;
async describeCertificates(params?: DescribeCertificatesMessage, opts?: client.RequestOptions): Promise<CertificateMessage>;
async describeDBClusterParameterGroups(params?: DescribeDBClusterParameterGroupsMessage, opts?: client.RequestOptions): Promise<DBClusterParameterGroupsMessage>;
async describeDBClusterParameters(params: DescribeDBClusterParametersMessage, opts?: client.RequestOptions): Promise<DBClusterParameterGroupDetails>;
async describeDBClusters(params?: DescribeDBClustersMessage, opts?: client.RequestOptions): Promise<DBClusterMessage>;
async describeDBClusterSnapshotAttributes(params: DescribeDBClusterSnapshotAttributesMessage, opts?: client.RequestOptions): Promise<DescribeDBClusterSnapshotAttributesResult>;
async describeDBClusterSnapshots(params?: DescribeDBClusterSnapshotsMessage, opts?: client.RequestOptions): Promise<DBClusterSnapshotMessage>;
async describeDBEngineVersions(params?: DescribeDBEngineVersionsMessage, opts?: client.RequestOptions): Promise<DBEngineVersionMessage>;
async describeDBInstances(params?: DescribeDBInstancesMessage, opts?: client.RequestOptions): Promise<DBInstanceMessage>;
async describeDBSubnetGroups(params?: DescribeDBSubnetGroupsMessage, opts?: client.RequestOptions): Promise<DBSubnetGroupMessage>;
async describeEngineDefaultClusterParameters(params: DescribeEngineDefaultClusterParametersMessage, opts?: client.RequestOptions): Promise<DescribeEngineDefaultClusterParametersResult>;
async describeEventCategories(params?: DescribeEventCategoriesMessage, opts?: client.RequestOptions): Promise<EventCategoriesMessage>;
async describeEvents(params?: DescribeEventsMessage, opts?: client.RequestOptions): Promise<EventsMessage>;
async describeEventSubscriptions(params?: DescribeEventSubscriptionsMessage, opts?: client.RequestOptions): Promise<EventSubscriptionsMessage>;
async describeGlobalClusters(params?: DescribeGlobalClustersMessage, opts?: client.RequestOptions): Promise<GlobalClustersMessage>;
async describeOrderableDBInstanceOptions(params: DescribeOrderableDBInstanceOptionsMessage, opts?: client.RequestOptions): Promise<OrderableDBInstanceOptionsMessage>;
async describePendingMaintenanceActions(params?: DescribePendingMaintenanceActionsMessage, opts?: client.RequestOptions): Promise<PendingMaintenanceActionsMessage>;
async failoverDBCluster(params?: FailoverDBClusterMessage, opts?: client.RequestOptions): Promise<FailoverDBClusterResult>;
async listTagsForResource(params: ListTagsForResourceMessage, opts?: client.RequestOptions): Promise<TagListMessage>;
async modifyDBCluster(params: ModifyDBClusterMessage, opts?: client.RequestOptions): Promise<ModifyDBClusterResult>;
async modifyDBClusterParameterGroup(params: ModifyDBClusterParameterGroupMessage, opts?: client.RequestOptions): Promise<DBClusterParameterGroupNameMessage>;
async modifyDBClusterSnapshotAttribute(params: ModifyDBClusterSnapshotAttributeMessage, opts?: client.RequestOptions): Promise<ModifyDBClusterSnapshotAttributeResult>;
async modifyDBInstance(params: ModifyDBInstanceMessage, opts?: client.RequestOptions): Promise<ModifyDBInstanceResult>;
async modifyDBSubnetGroup(params: ModifyDBSubnetGroupMessage, opts?: client.RequestOptions): Promise<ModifyDBSubnetGroupResult>;
async modifyEventSubscription(params: ModifyEventSubscriptionMessage, opts?: client.RequestOptions): Promise<ModifyEventSubscriptionResult>;
async modifyGlobalCluster(params: ModifyGlobalClusterMessage, opts?: client.RequestOptions): Promise<ModifyGlobalClusterResult>;
async rebootDBInstance(params: RebootDBInstanceMessage, opts?: client.RequestOptions): Promise<RebootDBInstanceResult>;
async removeFromGlobalCluster(params: RemoveFromGlobalClusterMessage, opts?: client.RequestOptions): Promise<RemoveFromGlobalClusterResult>;
async removeSourceIdentifierFromSubscription(params: RemoveSourceIdentifierFromSubscriptionMessage, opts?: client.RequestOptions): Promise<RemoveSourceIdentifierFromSubscriptionResult>;
async removeTagsFromResource(params: RemoveTagsFromResourceMessage, opts?: client.RequestOptions): Promise<void>;
async resetDBClusterParameterGroup(params: ResetDBClusterParameterGroupMessage, opts?: client.RequestOptions): Promise<DBClusterParameterGroupNameMessage>;
async restoreDBClusterFromSnapshot(params: RestoreDBClusterFromSnapshotMessage, opts?: client.RequestOptions): Promise<RestoreDBClusterFromSnapshotResult>;
async restoreDBClusterToPointInTime(params: RestoreDBClusterToPointInTimeMessage, opts?: client.RequestOptions): Promise<RestoreDBClusterToPointInTimeResult>;
async startDBCluster(params: StartDBClusterMessage, opts?: client.RequestOptions): Promise<StartDBClusterResult>;
async stopDBCluster(params: StopDBClusterMessage, opts?: client.RequestOptions): Promise<StopDBClusterResult>;
async waitForDBInstanceAvailable(params: DescribeDBInstancesMessage, opts?: client.RequestOptions): Promise<DBInstanceMessage>;
async waitForDBInstanceDeleted(params: DescribeDBInstancesMessage, opts?: client.RequestOptions): Promise<Error | DBInstanceMessage>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new DocDB(apiFactory: client.ApiFactory)
[src]

§Methods

§
addTagsToResource(params: AddTagsToResourceMessage, opts?: client.RequestOptions): Promise<void>
[src]
§
deleteDBClusterParameterGroup(params: DeleteDBClusterParameterGroupMessage, opts?: client.RequestOptions): Promise<void>
[src]
§
deleteDBSubnetGroup(params: DeleteDBSubnetGroupMessage, opts?: client.RequestOptions): Promise<void>
[src]
§
describeCertificates(params?: DescribeCertificatesMessage, opts?: client.RequestOptions): Promise<CertificateMessage>
[src]
§
describeDBClusters(params?: DescribeDBClustersMessage, opts?: client.RequestOptions): Promise<DBClusterMessage>
[src]
§
describeDBClusterSnapshots(params?: DescribeDBClusterSnapshotsMessage, opts?: client.RequestOptions): Promise<DBClusterSnapshotMessage>
[src]
§
describeDBEngineVersions(params?: DescribeDBEngineVersionsMessage, opts?: client.RequestOptions): Promise<DBEngineVersionMessage>
[src]
§
describeDBInstances(params?: DescribeDBInstancesMessage, opts?: client.RequestOptions): Promise<DBInstanceMessage>
[src]
§
describeDBSubnetGroups(params?: DescribeDBSubnetGroupsMessage, opts?: client.RequestOptions): Promise<DBSubnetGroupMessage>
[src]
§
describeEventCategories(params?: DescribeEventCategoriesMessage, opts?: client.RequestOptions): Promise<EventCategoriesMessage>
[src]
§
describeEvents(params?: DescribeEventsMessage, opts?: client.RequestOptions): Promise<EventsMessage>
[src]
§
describeGlobalClusters(params?: DescribeGlobalClustersMessage, opts?: client.RequestOptions): Promise<GlobalClustersMessage>
[src]
§
listTagsForResource(params: ListTagsForResourceMessage, opts?: client.RequestOptions): Promise<TagListMessage>
[src]
§
removeTagsFromResource(params: RemoveTagsFromResourceMessage, opts?: client.RequestOptions): Promise<void>
[src]
§
waitForDBInstanceAvailable(params: DescribeDBInstancesMessage, opts?: client.RequestOptions): Promise<DBInstanceMessage>
[src]

Checks state up to 60 times, 30 seconds apart (about 30 minutes max wait time).

§
waitForDBInstanceDeleted(params: DescribeDBInstancesMessage, opts?: client.RequestOptions): Promise<Error | DBInstanceMessage>
[src]

Checks state up to 60 times, 30 seconds apart (about 30 minutes max wait time).

§Static Properties