docdbelastic/aws.sdk.kotlin.services.docdbelastic

Package-level declarations

Types

DocDbElasticClient

interface DocDbElasticClient : SdkClient

The new Amazon Elastic DocumentDB service endpoint.

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Functions

inline suspend fun DocDbElasticClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse

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

createClusterSnapshot

inline suspend fun DocDbElasticClient.createClusterSnapshot(crossinline block: CreateClusterSnapshotRequest.Builder.() -> Unit): CreateClusterSnapshotResponse

Creates a snapshot of a cluster.

inline suspend fun DocDbElasticClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse

Delete a Elastic DocumentDB cluster.

deleteClusterSnapshot

inline suspend fun DocDbElasticClient.deleteClusterSnapshot(crossinline block: DeleteClusterSnapshotRequest.Builder.() -> Unit): DeleteClusterSnapshotResponse

Delete a Elastic DocumentDB snapshot.

inline suspend fun DocDbElasticClient.getCluster(crossinline block: GetClusterRequest.Builder.() -> Unit): GetClusterResponse

Returns information about a specific Elastic DocumentDB cluster.

getClusterSnapshot

inline suspend fun DocDbElasticClient.getClusterSnapshot(crossinline block: GetClusterSnapshotRequest.Builder.() -> Unit): GetClusterSnapshotResponse

Returns information about a specific Elastic DocumentDB snapshot

inline suspend fun DocDbElasticClient.listClusters(crossinline block: ListClustersRequest.Builder.() -> Unit): ListClustersResponse

Returns information about provisioned Elastic DocumentDB clusters.

listClusterSnapshots

inline suspend fun DocDbElasticClient.listClusterSnapshots(crossinline block: ListClusterSnapshotsRequest.Builder.() -> Unit): ListClusterSnapshotsResponse

Returns information about Elastic DocumentDB snapshots for a specified cluster.

listTagsForResource

inline suspend fun DocDbElasticClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags on a Elastic DocumentDB resource

restoreClusterFromSnapshot

inline suspend fun DocDbElasticClient.restoreClusterFromSnapshot(crossinline block: RestoreClusterFromSnapshotRequest.Builder.() -> Unit): RestoreClusterFromSnapshotResponse

Restores a Elastic DocumentDB cluster from a snapshot.

inline suspend fun DocDbElasticClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds metadata tags to a Elastic DocumentDB resource

inline suspend fun DocDbElasticClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes metadata tags to a Elastic DocumentDB resource

inline suspend fun DocDbElasticClient.updateCluster(crossinline block: UpdateClusterRequest.Builder.() -> Unit): UpdateClusterResponse

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

fun DocDbElasticClient.withConfig(block: DocDbElasticClient.Config.Builder.() -> Unit): DocDbElasticClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.