docdbelastic/aws.sdk.kotlin.services.docdbelastic

Package-level declarations

Types

interface DocDbElasticClient : SdkClient

Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

applyPendingMaintenanceAction

inline suspend fun DocDbElasticClient.applyPendingMaintenanceAction(crossinline block: ApplyPendingMaintenanceActionRequest.Builder.() -> Unit): ApplyPendingMaintenanceActionResponse

The type of pending maintenance action to be applied to the resource.

copyClusterSnapshot

inline suspend fun DocDbElasticClient.copyClusterSnapshot(crossinline block: CopyClusterSnapshotRequest.Builder.() -> Unit): CopyClusterSnapshotResponse

Copies a snapshot of an elastic cluster.

createCluster

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

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

createClusterSnapshot

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

Creates a snapshot of an elastic cluster.

deleteCluster

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

Delete an elastic cluster.

deleteClusterSnapshot

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

Delete an elastic cluster snapshot.

getCluster

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

Returns information about a specific elastic cluster.

getClusterSnapshot

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

Returns information about a specific elastic cluster snapshot

getPendingMaintenanceAction

inline suspend fun DocDbElasticClient.getPendingMaintenanceAction(crossinline block: GetPendingMaintenanceActionRequest.Builder.() -> Unit): GetPendingMaintenanceActionResponse

Retrieves all maintenance actions that are pending.

listClusters

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

Returns information about provisioned Amazon DocumentDB elastic clusters.

listClusterSnapshots

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

Returns information about snapshots for a specified elastic cluster.

listPendingMaintenanceActions

inline suspend fun DocDbElasticClient.listPendingMaintenanceActions(crossinline block: ListPendingMaintenanceActionsRequest.Builder.() -> Unit): ListPendingMaintenanceActionsResponse

Retrieves a list of all maintenance actions that are pending.

listTagsForResource

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

Lists all tags on a elastic cluster resource

restoreClusterFromSnapshot

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

Restores an elastic cluster from a snapshot.

startCluster

inline suspend fun DocDbElasticClient.startCluster(crossinline block: StartClusterRequest.Builder.() -> Unit): StartClusterResponse

Restarts the stopped elastic cluster that is specified by clusterARN.

stopCluster

inline suspend fun DocDbElasticClient.stopCluster(crossinline block: StopClusterRequest.Builder.() -> Unit): StopClusterResponse

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

tagResource

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

Adds metadata tags to an elastic cluster resource

untagResource

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

Removes metadata tags from an elastic cluster resource

updateCluster

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

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

withConfig

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.