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

DocDBElastic

import { DocDBElastic } from "https://aws-api.deno.dev/v0.4/services/docdbelastic.ts?docs=full";
class DocDBElastic {
constructor(apiFactory: client.ApiFactory);
async createCluster(params: CreateClusterInput, opts?: client.RequestOptions): Promise<CreateClusterOutput>;
async createClusterSnapshot(params: CreateClusterSnapshotInput, opts?: client.RequestOptions): Promise<CreateClusterSnapshotOutput>;
async deleteCluster(params: DeleteClusterInput, opts?: client.RequestOptions): Promise<DeleteClusterOutput>;
async deleteClusterSnapshot(params: DeleteClusterSnapshotInput, opts?: client.RequestOptions): Promise<DeleteClusterSnapshotOutput>;
async getCluster(params: GetClusterInput, opts?: client.RequestOptions): Promise<GetClusterOutput>;
async getClusterSnapshot(params: GetClusterSnapshotInput, opts?: client.RequestOptions): Promise<GetClusterSnapshotOutput>;
async listClusters(params?: ListClustersInput, opts?: client.RequestOptions): Promise<ListClustersOutput>;
async listClusterSnapshots(params?: ListClusterSnapshotsInput, opts?: client.RequestOptions): Promise<ListClusterSnapshotsOutput>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async restoreClusterFromSnapshot(params: RestoreClusterFromSnapshotInput, opts?: client.RequestOptions): Promise<RestoreClusterFromSnapshotOutput>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateCluster(params: UpdateClusterInput, opts?: client.RequestOptions): Promise<UpdateClusterOutput>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

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

§Methods

§
createCluster(params: CreateClusterInput, opts?: client.RequestOptions): Promise<CreateClusterOutput>
[src]

Creates a new Elastic DocumentDB cluster and returns its Cluster structure.

§
createClusterSnapshot(params: CreateClusterSnapshotInput, opts?: client.RequestOptions): Promise<CreateClusterSnapshotOutput>
[src]

Creates a snapshot of a cluster.

§
deleteCluster(params: DeleteClusterInput, opts?: client.RequestOptions): Promise<DeleteClusterOutput>
[src]

Delete a Elastic DocumentDB cluster.

§
deleteClusterSnapshot(params: DeleteClusterSnapshotInput, opts?: client.RequestOptions): Promise<DeleteClusterSnapshotOutput>
[src]

Delete a Elastic DocumentDB snapshot.

§
getCluster(params: GetClusterInput, opts?: client.RequestOptions): Promise<GetClusterOutput>
[src]

Returns information about a specific Elastic DocumentDB cluster.

§
getClusterSnapshot(params: GetClusterSnapshotInput, opts?: client.RequestOptions): Promise<GetClusterSnapshotOutput>
[src]

Returns information about a specific Elastic DocumentDB snapshot

§
listClusters(params?: ListClustersInput, opts?: client.RequestOptions): Promise<ListClustersOutput>
[src]

Returns information about provisioned Elastic DocumentDB clusters.

§
listClusterSnapshots(params?: ListClusterSnapshotsInput, opts?: client.RequestOptions): Promise<ListClusterSnapshotsOutput>
[src]

Returns information about Elastic DocumentDB snapshots for a specified cluster.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

Lists all tags on a Elastic DocumentDB resource

§
restoreClusterFromSnapshot(params: RestoreClusterFromSnapshotInput, opts?: client.RequestOptions): Promise<RestoreClusterFromSnapshotOutput>
[src]

Restores a Elastic DocumentDB cluster from a snapshot.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds metadata tags to a Elastic DocumentDB resource

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes metadata tags to a Elastic DocumentDB resource

§
updateCluster(params: UpdateClusterInput, opts?: client.RequestOptions): Promise<UpdateClusterOutput>
[src]

Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window

§Static Properties