docdbelastic/aws.sdk.kotlin.services.docdbelastic/DocDbElasticClient

DocDbElasticClient

interface DocDbElasticClient : SdkClient

Amazon DocumentDB elastic clusters

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.

Amazon DocumentDB elastic-clusters were created to:

provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.
give customers higher connection limits, and to reduce downtime from patching.
continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.

Types

Builder

class Builder : AbstractSdkClientBuilder<DocDbElasticClient.Config, DocDbElasticClient.Config.Builder, DocDbElasticClient>

Companion

object Companion : AbstractAwsSdkClientFactory<DocDbElasticClient.Config, DocDbElasticClient.Config.Builder, DocDbElasticClient, DocDbElasticClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: DocDbElasticClient.Config

DocDbElasticClient's configuration

Functions

applyPendingMaintenanceAction

abstract suspend fun applyPendingMaintenanceAction(input: ApplyPendingMaintenanceActionRequest): ApplyPendingMaintenanceActionResponse

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

copyClusterSnapshot

abstract suspend fun copyClusterSnapshot(input: CopyClusterSnapshotRequest): CopyClusterSnapshotResponse

Copies a snapshot of an elastic cluster.

createCluster

abstract suspend fun createCluster(input: CreateClusterRequest): CreateClusterResponse

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

createClusterSnapshot

abstract suspend fun createClusterSnapshot(input: CreateClusterSnapshotRequest): CreateClusterSnapshotResponse

Creates a snapshot of an elastic cluster.

deleteCluster

abstract suspend fun deleteCluster(input: DeleteClusterRequest): DeleteClusterResponse

Delete an elastic cluster.

deleteClusterSnapshot

abstract suspend fun deleteClusterSnapshot(input: DeleteClusterSnapshotRequest): DeleteClusterSnapshotResponse

Delete an elastic cluster snapshot.

getCluster

abstract suspend fun getCluster(input: GetClusterRequest): GetClusterResponse

Returns information about a specific elastic cluster.

getClusterSnapshot

abstract suspend fun getClusterSnapshot(input: GetClusterSnapshotRequest): GetClusterSnapshotResponse

Returns information about a specific elastic cluster snapshot

getPendingMaintenanceAction

abstract suspend fun getPendingMaintenanceAction(input: GetPendingMaintenanceActionRequest): GetPendingMaintenanceActionResponse

Retrieves all maintenance actions that are pending.

listClusters

abstract suspend fun listClusters(input: ListClustersRequest = ListClustersRequest { }): ListClustersResponse

Returns information about provisioned Amazon DocumentDB elastic clusters.

listClusterSnapshots

abstract suspend fun listClusterSnapshots(input: ListClusterSnapshotsRequest = ListClusterSnapshotsRequest { }): ListClusterSnapshotsResponse

Returns information about snapshots for a specified elastic cluster.

listPendingMaintenanceActions

abstract suspend fun listPendingMaintenanceActions(input: ListPendingMaintenanceActionsRequest = ListPendingMaintenanceActionsRequest { }): ListPendingMaintenanceActionsResponse

Retrieves a list of all maintenance actions that are pending.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists all tags on a elastic cluster resource

restoreClusterFromSnapshot

abstract suspend fun restoreClusterFromSnapshot(input: RestoreClusterFromSnapshotRequest): RestoreClusterFromSnapshotResponse

Restores an elastic cluster from a snapshot.

startCluster

abstract suspend fun startCluster(input: StartClusterRequest): StartClusterResponse

Restarts the stopped elastic cluster that is specified by clusterARN.

stopCluster

abstract suspend fun stopCluster(input: StopClusterRequest): StopClusterResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds metadata tags to an elastic cluster resource

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes metadata tags from an elastic cluster resource

updateCluster

abstract suspend fun updateCluster(input: UpdateClusterRequest): UpdateClusterResponse

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

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.

expect abstract fun close()

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.

listClusterSnapshotsPaginated

fun DocDbElasticClient.listClusterSnapshotsPaginated(initialRequest: ListClusterSnapshotsRequest = ListClusterSnapshotsRequest { }): Flow<ListClusterSnapshotsResponse>

fun DocDbElasticClient.listClusterSnapshotsPaginated(block: ListClusterSnapshotsRequest.Builder.() -> Unit): Flow<ListClusterSnapshotsResponse>

Paginate over ListClusterSnapshotsResponse results.

listClustersPaginated

fun DocDbElasticClient.listClustersPaginated(initialRequest: ListClustersRequest = ListClustersRequest { }): Flow<ListClustersResponse>

fun DocDbElasticClient.listClustersPaginated(block: ListClustersRequest.Builder.() -> Unit): Flow<ListClustersResponse>

Paginate over ListClustersResponse results.

listPendingMaintenanceActions

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

Retrieves a list of all maintenance actions that are pending.

listPendingMaintenanceActionsPaginated

fun DocDbElasticClient.listPendingMaintenanceActionsPaginated(initialRequest: ListPendingMaintenanceActionsRequest = ListPendingMaintenanceActionsRequest { }): Flow<ListPendingMaintenanceActionsResponse>

fun DocDbElasticClient.listPendingMaintenanceActionsPaginated(block: ListPendingMaintenanceActionsRequest.Builder.() -> Unit): Flow<ListPendingMaintenanceActionsResponse>

Paginate over ListPendingMaintenanceActionsResponse results.

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.