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-bqtgftz736ft.deno.dev/v0.5/services/docdbelastic.ts?docs=full";
class DocDBElastic {
constructor(apiFactory: client.ApiFactory);
async copyClusterSnapshot(params: CopyClusterSnapshotInput, opts?: client.RequestOptions): Promise<CopyClusterSnapshotOutput>;
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 startCluster(params: StartClusterInput, opts?: client.RequestOptions): Promise<StartClusterOutput>;
async stopCluster(params: StopClusterInput, opts?: client.RequestOptions): Promise<StopClusterOutput>;
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

§
copyClusterSnapshot(params: CopyClusterSnapshotInput, opts?: client.RequestOptions): Promise<CopyClusterSnapshotOutput>
[src]

Copies a snapshot of an elastic cluster.

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

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

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

Creates a snapshot of an elastic cluster.

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

Delete an elastic cluster.

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

Delete an elastic cluster snapshot.

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

Returns information about a specific elastic cluster.

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

Returns information about a specific elastic cluster snapshot

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

Returns information about provisioned Amazon DocumentDB elastic clusters.

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

Returns information about snapshots for a specified elastic cluster.

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

Lists all tags on a elastic cluster resource

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

Restores an elastic cluster from a snapshot.

§
startCluster(params: StartClusterInput, opts?: client.RequestOptions): Promise<StartClusterOutput>
[src]

Restarts the stopped elastic cluster that is specified by clusterARN.

§
stopCluster(params: StopClusterInput, opts?: client.RequestOptions): Promise<StopClusterOutput>
[src]

Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.

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

Adds metadata tags to an elastic cluster resource

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

Removes metadata tags from an elastic cluster resource

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

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

§Static Properties