timestreaminfluxdb/aws.sdk.kotlin.services.timestreaminfluxdb/TimestreamInfluxDbClient

TimestreamInfluxDbClient

interface TimestreamInfluxDbClient : SdkClient

Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on Amazon Web Services for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: TimestreamInfluxDbClient.Config

TimestreamInfluxDbClient's configuration

Functions

createDbCluster

abstract suspend fun createDbCluster(input: CreateDbClusterRequest): CreateDbClusterResponse

Creates a new Timestream for InfluxDB cluster.

createDbInstance

abstract suspend fun createDbInstance(input: CreateDbInstanceRequest): CreateDbInstanceResponse

Creates a new Timestream for InfluxDB DB instance.

createDbParameterGroup

abstract suspend fun createDbParameterGroup(input: CreateDbParameterGroupRequest): CreateDbParameterGroupResponse

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

deleteDbCluster

abstract suspend fun deleteDbCluster(input: DeleteDbClusterRequest): DeleteDbClusterResponse

Deletes a Timestream for InfluxDB cluster.

deleteDbInstance

abstract suspend fun deleteDbInstance(input: DeleteDbInstanceRequest): DeleteDbInstanceResponse

Deletes a Timestream for InfluxDB DB instance.

getDbCluster

abstract suspend fun getDbCluster(input: GetDbClusterRequest): GetDbClusterResponse

Retrieves information about a Timestream for InfluxDB cluster.

getDbInstance

abstract suspend fun getDbInstance(input: GetDbInstanceRequest): GetDbInstanceResponse

Returns a Timestream for InfluxDB DB instance.

getDbParameterGroup

abstract suspend fun getDbParameterGroup(input: GetDbParameterGroupRequest): GetDbParameterGroupResponse

Returns a Timestream for InfluxDB DB parameter group.

listDbClusters

abstract suspend fun listDbClusters(input: ListDbClustersRequest = ListDbClustersRequest { }): ListDbClustersResponse

Returns a list of Timestream for InfluxDB DB clusters.

listDbInstances

abstract suspend fun listDbInstances(input: ListDbInstancesRequest = ListDbInstancesRequest { }): ListDbInstancesResponse

Returns a list of Timestream for InfluxDB DB instances.

listDbInstancesForCluster

abstract suspend fun listDbInstancesForCluster(input: ListDbInstancesForClusterRequest): ListDbInstancesForClusterResponse

Returns a list of Timestream for InfluxDB clusters.

listDbParameterGroups

abstract suspend fun listDbParameterGroups(input: ListDbParameterGroupsRequest = ListDbParameterGroupsRequest { }): ListDbParameterGroupsResponse

Returns a list of Timestream for InfluxDB DB parameter groups.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

A list of tags applied to the resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the tag from the specified resource.

updateDbCluster

abstract suspend fun updateDbCluster(input: UpdateDbClusterRequest): UpdateDbClusterResponse

Updates a Timestream for InfluxDB cluster.

updateDbInstance

abstract suspend fun updateDbInstance(input: UpdateDbInstanceRequest): UpdateDbInstanceResponse

Updates a Timestream for InfluxDB DB instance.

Inherited functions

expect abstract fun close()

createDbCluster

inline suspend fun TimestreamInfluxDbClient.createDbCluster(crossinline block: CreateDbClusterRequest.Builder.() -> Unit): CreateDbClusterResponse

Creates a new Timestream for InfluxDB cluster.

createDbInstance

inline suspend fun TimestreamInfluxDbClient.createDbInstance(crossinline block: CreateDbInstanceRequest.Builder.() -> Unit): CreateDbInstanceResponse

Creates a new Timestream for InfluxDB DB instance.

createDbParameterGroup

inline suspend fun TimestreamInfluxDbClient.createDbParameterGroup(crossinline block: CreateDbParameterGroupRequest.Builder.() -> Unit): CreateDbParameterGroupResponse

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

deleteDbCluster

inline suspend fun TimestreamInfluxDbClient.deleteDbCluster(crossinline block: DeleteDbClusterRequest.Builder.() -> Unit): DeleteDbClusterResponse

Deletes a Timestream for InfluxDB cluster.

deleteDbInstance

inline suspend fun TimestreamInfluxDbClient.deleteDbInstance(crossinline block: DeleteDbInstanceRequest.Builder.() -> Unit): DeleteDbInstanceResponse

Deletes a Timestream for InfluxDB DB instance.

getDbCluster

inline suspend fun TimestreamInfluxDbClient.getDbCluster(crossinline block: GetDbClusterRequest.Builder.() -> Unit): GetDbClusterResponse

Retrieves information about a Timestream for InfluxDB cluster.

getDbInstance

inline suspend fun TimestreamInfluxDbClient.getDbInstance(crossinline block: GetDbInstanceRequest.Builder.() -> Unit): GetDbInstanceResponse

Returns a Timestream for InfluxDB DB instance.

getDbParameterGroup

inline suspend fun TimestreamInfluxDbClient.getDbParameterGroup(crossinline block: GetDbParameterGroupRequest.Builder.() -> Unit): GetDbParameterGroupResponse

Returns a Timestream for InfluxDB DB parameter group.

listDbClusters

inline suspend fun TimestreamInfluxDbClient.listDbClusters(crossinline block: ListDbClustersRequest.Builder.() -> Unit): ListDbClustersResponse

Returns a list of Timestream for InfluxDB DB clusters.

listDbClustersPaginated

fun TimestreamInfluxDbClient.listDbClustersPaginated(initialRequest: ListDbClustersRequest = ListDbClustersRequest { }): Flow<ListDbClustersResponse>

fun TimestreamInfluxDbClient.listDbClustersPaginated(block: ListDbClustersRequest.Builder.() -> Unit): Flow<ListDbClustersResponse>

Paginate over ListDbClustersResponse results.

listDbInstances

inline suspend fun TimestreamInfluxDbClient.listDbInstances(crossinline block: ListDbInstancesRequest.Builder.() -> Unit): ListDbInstancesResponse

Returns a list of Timestream for InfluxDB DB instances.

listDbInstancesForCluster

inline suspend fun TimestreamInfluxDbClient.listDbInstancesForCluster(crossinline block: ListDbInstancesForClusterRequest.Builder.() -> Unit): ListDbInstancesForClusterResponse

Returns a list of Timestream for InfluxDB clusters.

listDbInstancesForClusterPaginated

fun TimestreamInfluxDbClient.listDbInstancesForClusterPaginated(initialRequest: ListDbInstancesForClusterRequest): Flow<ListDbInstancesForClusterResponse>

fun TimestreamInfluxDbClient.listDbInstancesForClusterPaginated(block: ListDbInstancesForClusterRequest.Builder.() -> Unit): Flow<ListDbInstancesForClusterResponse>

Paginate over ListDbInstancesForClusterResponse results.

listDbInstancesPaginated

fun TimestreamInfluxDbClient.listDbInstancesPaginated(initialRequest: ListDbInstancesRequest = ListDbInstancesRequest { }): Flow<ListDbInstancesResponse>

fun TimestreamInfluxDbClient.listDbInstancesPaginated(block: ListDbInstancesRequest.Builder.() -> Unit): Flow<ListDbInstancesResponse>

Paginate over ListDbInstancesResponse results.

listDbParameterGroups

inline suspend fun TimestreamInfluxDbClient.listDbParameterGroups(crossinline block: ListDbParameterGroupsRequest.Builder.() -> Unit): ListDbParameterGroupsResponse

Returns a list of Timestream for InfluxDB DB parameter groups.

listDbParameterGroupsPaginated

fun TimestreamInfluxDbClient.listDbParameterGroupsPaginated(initialRequest: ListDbParameterGroupsRequest = ListDbParameterGroupsRequest { }): Flow<ListDbParameterGroupsResponse>

fun TimestreamInfluxDbClient.listDbParameterGroupsPaginated(block: ListDbParameterGroupsRequest.Builder.() -> Unit): Flow<ListDbParameterGroupsResponse>

Paginate over ListDbParameterGroupsResponse results.

listTagsForResource

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

A list of tags applied to the resource.

tagResource

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

Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.

untagResource

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

Removes the tag from the specified resource.

updateDbCluster

inline suspend fun TimestreamInfluxDbClient.updateDbCluster(crossinline block: UpdateDbClusterRequest.Builder.() -> Unit): UpdateDbClusterResponse

Updates a Timestream for InfluxDB cluster.

updateDbInstance

inline suspend fun TimestreamInfluxDbClient.updateDbInstance(crossinline block: UpdateDbInstanceRequest.Builder.() -> Unit): UpdateDbInstanceResponse

Updates a Timestream for InfluxDB DB instance.

withConfig

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

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.