commonMain.aws.sdk.kotlin.services.dsql.DsqlClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dsql-jvm Show documentation
Show all versions of dsql-jvm Show documentation
The AWS SDK for Kotlin client for DSQL
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.dsql
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.dsql.auth.DefaultDsqlAuthSchemeProvider
import aws.sdk.kotlin.services.dsql.auth.DsqlAuthSchemeProvider
import aws.sdk.kotlin.services.dsql.endpoints.DefaultDsqlEndpointProvider
import aws.sdk.kotlin.services.dsql.endpoints.DsqlEndpointParameters
import aws.sdk.kotlin.services.dsql.endpoints.DsqlEndpointProvider
import aws.sdk.kotlin.services.dsql.model.CreateClusterRequest
import aws.sdk.kotlin.services.dsql.model.CreateClusterResponse
import aws.sdk.kotlin.services.dsql.model.CreateMultiRegionClustersRequest
import aws.sdk.kotlin.services.dsql.model.CreateMultiRegionClustersResponse
import aws.sdk.kotlin.services.dsql.model.DeleteClusterRequest
import aws.sdk.kotlin.services.dsql.model.DeleteClusterResponse
import aws.sdk.kotlin.services.dsql.model.DeleteMultiRegionClustersRequest
import aws.sdk.kotlin.services.dsql.model.DeleteMultiRegionClustersResponse
import aws.sdk.kotlin.services.dsql.model.GetClusterRequest
import aws.sdk.kotlin.services.dsql.model.GetClusterResponse
import aws.sdk.kotlin.services.dsql.model.ListClustersRequest
import aws.sdk.kotlin.services.dsql.model.ListClustersResponse
import aws.sdk.kotlin.services.dsql.model.ListTagsForResourceRequest
import aws.sdk.kotlin.services.dsql.model.ListTagsForResourceResponse
import aws.sdk.kotlin.services.dsql.model.TagResourceRequest
import aws.sdk.kotlin.services.dsql.model.TagResourceResponse
import aws.sdk.kotlin.services.dsql.model.UntagResourceRequest
import aws.sdk.kotlin.services.dsql.model.UntagResourceResponse
import aws.sdk.kotlin.services.dsql.model.UpdateClusterRequest
import aws.sdk.kotlin.services.dsql.model.UpdateClusterResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.AbstractSdkClientFactory
import aws.smithy.kotlin.runtime.client.IdempotencyTokenConfig
import aws.smithy.kotlin.runtime.client.IdempotencyTokenProvider
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.url.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic
public const val ServiceId: String = "DSQL"
public const val SdkVersion: String = "1.3.90"
public const val ServiceApiVersion: String = "2018-05-10"
/**
* This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.
*
* Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. Aurora DSQL is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL lets you focus on using your data to acquire new insights for your business and customers.
*/
public interface DsqlClient : SdkClient {
/**
* DsqlClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory()
{
@JvmStatic
override fun builder(): Builder = Builder()
override fun finalizeConfig(builder: Builder) {
super.finalizeConfig(builder)
builder.config.interceptors.add(0, ClockSkewInterceptor())
}
override suspend fun finalizeEnvironmentalConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
super.finalizeEnvironmentalConfig(builder, sharedConfig, activeProfile)
builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
sharedConfig,
"Dsql",
"DSQL",
"dsql",
)
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): DsqlClient = DefaultDsqlClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
override val clientName: String = builder.clientName
override val region: String? = builder.region
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: DsqlEndpointProvider = builder.endpointProvider ?: DefaultDsqlEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val idempotencyTokenProvider: IdempotencyTokenProvider = builder.idempotencyTokenProvider ?: IdempotencyTokenProvider.Default
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
override val applicationId: String? = builder.applicationId
public val authSchemeProvider: DsqlAuthSchemeProvider = builder.authSchemeProvider ?: DefaultDsqlAuthSchemeProvider()
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
idempotencyTokenProvider = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
telemetryProvider = [email protected]
useDualStack = [email protected]
useFips = [email protected]
applicationId = [email protected]
authSchemeProvider = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), IdempotencyTokenConfig.Builder, RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "DSQL"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [AuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: DsqlEndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Override the default idempotency token generator. SDK clients will generate tokens for members
* that represent idempotent tokens when not explicitly set by the caller using this generator.
*/
override var idempotencyTokenProvider: IdempotencyTokenProvider? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The telemetry provider used to instrument the SDK operations with. By default, the global telemetry
* provider will be used.
*/
override var telemetryProvider: TelemetryProvider? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
/**
* An optional application specific identifier.
* When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
* When not explicitly set, the value will be loaded from the following locations:
*
* - JVM System Property: `aws.userAgentAppId`
* - Environment variable: `AWS_SDK_UA_APP_ID`
* - Shared configuration profile attribute: `sdk_ua_app_id`
*
* See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
* reference for more information on environment variables and shared config settings.
*/
override var applicationId: String? = null
/**
* Configure the provider used to resolve the authentication scheme to use for a particular operation.
*/
public var authSchemeProvider: DsqlAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* Creates a cluster in Amazon Aurora DSQL.
*
* @sample aws.sdk.kotlin.services.dsql.samples.CreateCluster.sample
*/
public suspend fun createCluster(input: CreateClusterRequest = CreateClusterRequest { }): CreateClusterResponse
/**
* Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.
*
* @sample aws.sdk.kotlin.services.dsql.samples.CreateMultiRegionClusters.sample
*/
public suspend fun createMultiRegionClusters(input: CreateMultiRegionClustersRequest): CreateMultiRegionClustersResponse
/**
* Deletes a cluster in Amazon Aurora DSQL.
*
* @sample aws.sdk.kotlin.services.dsql.samples.DeleteCluster.sample
*/
public suspend fun deleteCluster(input: DeleteClusterRequest): DeleteClusterResponse
/**
* Deletes a multi-Region cluster in Amazon Aurora DSQL.
*
* @sample aws.sdk.kotlin.services.dsql.samples.DeleteMultiRegionClusters.sample
*/
public suspend fun deleteMultiRegionClusters(input: DeleteMultiRegionClustersRequest): DeleteMultiRegionClustersResponse
/**
* Retrieves information about a cluster.
*
* @sample aws.sdk.kotlin.services.dsql.samples.GetCluster.sample
*/
public suspend fun getCluster(input: GetClusterRequest): GetClusterResponse
/**
* Retrieves information about a list of clusters.
*
* @sample aws.sdk.kotlin.services.dsql.samples.ListClusters.sample
*/
public suspend fun listClusters(input: ListClustersRequest = ListClustersRequest { }): ListClustersResponse
/**
* Lists all of the tags for a resource.
*
* @sample aws.sdk.kotlin.services.dsql.samples.ListTagsForResource.sample
*/
public suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse
/**
* Tags a resource with a map of key and value pairs.
*
* @sample aws.sdk.kotlin.services.dsql.samples.TagResource.sample
*/
public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse
/**
* Removes a tag from a resource.
*
* @sample aws.sdk.kotlin.services.dsql.samples.UntagResource.sample
*/
public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse
/**
* Updates a cluster.
*
* @sample aws.sdk.kotlin.services.dsql.samples.UpdateCluster.sample
*/
public suspend fun updateCluster(input: UpdateClusterRequest): UpdateClusterResponse
}
/**
* 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.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun DsqlClient.withConfig(block: DsqlClient.Config.Builder.() -> Unit): DsqlClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultDsqlClient(newConfig)
}
/**
* Creates a cluster in Amazon Aurora DSQL.
*
* @sample aws.sdk.kotlin.services.dsql.samples.CreateCluster.sample
*/
public suspend inline fun DsqlClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse = createCluster(CreateClusterRequest.Builder().apply(block).build())
/**
* Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.
*
* @sample aws.sdk.kotlin.services.dsql.samples.CreateMultiRegionClusters.sample
*/
public suspend inline fun DsqlClient.createMultiRegionClusters(crossinline block: CreateMultiRegionClustersRequest.Builder.() -> Unit): CreateMultiRegionClustersResponse = createMultiRegionClusters(CreateMultiRegionClustersRequest.Builder().apply(block).build())
/**
* Deletes a cluster in Amazon Aurora DSQL.
*
* @sample aws.sdk.kotlin.services.dsql.samples.DeleteCluster.sample
*/
public suspend inline fun DsqlClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse = deleteCluster(DeleteClusterRequest.Builder().apply(block).build())
/**
* Deletes a multi-Region cluster in Amazon Aurora DSQL.
*
* @sample aws.sdk.kotlin.services.dsql.samples.DeleteMultiRegionClusters.sample
*/
public suspend inline fun DsqlClient.deleteMultiRegionClusters(crossinline block: DeleteMultiRegionClustersRequest.Builder.() -> Unit): DeleteMultiRegionClustersResponse = deleteMultiRegionClusters(DeleteMultiRegionClustersRequest.Builder().apply(block).build())
/**
* Retrieves information about a cluster.
*
* @sample aws.sdk.kotlin.services.dsql.samples.GetCluster.sample
*/
public suspend inline fun DsqlClient.getCluster(crossinline block: GetClusterRequest.Builder.() -> Unit): GetClusterResponse = getCluster(GetClusterRequest.Builder().apply(block).build())
/**
* Retrieves information about a list of clusters.
*
* @sample aws.sdk.kotlin.services.dsql.samples.ListClusters.sample
*/
public suspend inline fun DsqlClient.listClusters(crossinline block: ListClustersRequest.Builder.() -> Unit): ListClustersResponse = listClusters(ListClustersRequest.Builder().apply(block).build())
/**
* Lists all of the tags for a resource.
*
* @sample aws.sdk.kotlin.services.dsql.samples.ListTagsForResource.sample
*/
public suspend inline fun DsqlClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse = listTagsForResource(ListTagsForResourceRequest.Builder().apply(block).build())
/**
* Tags a resource with a map of key and value pairs.
*
* @sample aws.sdk.kotlin.services.dsql.samples.TagResource.sample
*/
public suspend inline fun DsqlClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())
/**
* Removes a tag from a resource.
*
* @sample aws.sdk.kotlin.services.dsql.samples.UntagResource.sample
*/
public suspend inline fun DsqlClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())
/**
* Updates a cluster.
*
* @sample aws.sdk.kotlin.services.dsql.samples.UpdateCluster.sample
*/
public suspend inline fun DsqlClient.updateCluster(crossinline block: UpdateClusterRequest.Builder.() -> Unit): UpdateClusterResponse = updateCluster(UpdateClusterRequest.Builder().apply(block).build())
© 2015 - 2024 Weber Informatics LLC | Privacy Policy