commonMain.aws.sdk.kotlin.services.cloudhsmv2.CloudHsmV2Client.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.cloudhsmv2
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.http.retries.AwsDefaultRetryPolicy
import aws.sdk.kotlin.services.cloudhsmv2.endpoints.DefaultEndpointProvider
import aws.sdk.kotlin.services.cloudhsmv2.endpoints.EndpointParameters
import aws.sdk.kotlin.services.cloudhsmv2.endpoints.EndpointProvider
import aws.sdk.kotlin.services.cloudhsmv2.model.CopyBackupToRegionRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.CopyBackupToRegionResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.CreateClusterRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.CreateClusterResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.CreateHsmRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.CreateHsmResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.DeleteBackupRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.DeleteBackupResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.DeleteClusterRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.DeleteClusterResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.DeleteHsmRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.DeleteHsmResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.DescribeBackupsRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.DescribeBackupsResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.DescribeClustersRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.DescribeClustersResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.InitializeClusterRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.InitializeClusterResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.ListTagsRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.ListTagsResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.ModifyBackupAttributesRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.ModifyBackupAttributesResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.ModifyClusterRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.ModifyClusterResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.RestoreBackupRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.RestoreBackupResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.TagResourceRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.TagResourceResponse
import aws.sdk.kotlin.services.cloudhsmv2.model.UntagResourceRequest
import aws.sdk.kotlin.services.cloudhsmv2.model.UntagResourceResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.client.SdkClientFactory
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.auth.HttpAuthScheme
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
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.StandardRetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.tracing.DefaultTracer
import aws.smithy.kotlin.runtime.tracing.LoggingTraceProbe
import aws.smithy.kotlin.runtime.tracing.Tracer
import aws.smithy.kotlin.runtime.tracing.TracingClientConfig
import kotlin.collections.List
import kotlin.jvm.JvmStatic
/**
* For more information about AWS CloudHSM, see [AWS CloudHSM](http://aws.amazon.com/cloudhsm/) and the [AWS CloudHSM User Guide](https://docs.aws.amazon.com/cloudhsm/latest/userguide/).
*/
public interface CloudHsmV2Client : SdkClient {
/**
* CloudHsmV2Client's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory() {
@JvmStatic
override fun builder(): Builder = Builder()
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): CloudHsmV2Client = DefaultCloudHsmV2Client(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), SdkClientConfig, TracingClientConfig {
override val clientName: String = builder.clientName
override val region: String = requireNotNull(builder.region) { "region is a required configuration property" }
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: EndpointProvider = builder.endpointProvider ?: DefaultEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsDefaultRetryPolicy
override val retryStrategy: RetryStrategy = builder.retryStrategy ?: StandardRetryStrategy()
override val tracer: Tracer = builder.tracer ?: DefaultTracer(LoggingTraceProbe, clientName)
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
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]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
tracer = [email protected]
useDualStack = [email protected]
useFips = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TracingClientConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "CloudHSM V2"
/**
* 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 [HttpAuthScheme]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: EndpointProvider? = 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
/**
* 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 [RetryStrategy] implementation to use for service calls. All API calls will be wrapped by the
* strategy.
*/
override var retryStrategy: RetryStrategy? = null
/**
* The tracer that is responsible for creating trace spans and wiring them up to a tracing backend (e.g.,
* a trace probe). By default, this will create a standard tracer that uses the service name for the root
* trace span and delegates to a logging trace probe (i.e.,
* `DefaultTracer(LoggingTraceProbe, "")`).
*/
override var tracer: Tracer? = 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
override fun build(): Config = Config(this)
}
}
/**
* Copy an AWS CloudHSM cluster backup to a different region.
*/
public suspend fun copyBackupToRegion(input: CopyBackupToRegionRequest): CopyBackupToRegionResponse
/**
* Creates a new AWS CloudHSM cluster.
*/
public suspend fun createCluster(input: CreateClusterRequest): CreateClusterResponse
/**
* Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
*/
public suspend fun createHsm(input: CreateHsmRequest): CreateHsmResponse
/**
* Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
*/
public suspend fun deleteBackup(input: DeleteBackupRequest): DeleteBackupResponse
/**
* Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
*/
public suspend fun deleteCluster(input: DeleteClusterRequest): DeleteClusterResponse
/**
* Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
*/
public suspend fun deleteHsm(input: DeleteHsmRequest): DeleteHsmResponse
/**
* Gets information about backups of AWS CloudHSM clusters.
*
* This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a `NextToken` value. Use this value in a subsequent `DescribeBackups` request to get more backups. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more backups to get.
*/
public suspend fun describeBackups(input: DescribeBackupsRequest = DescribeBackupsRequest {}): DescribeBackupsResponse
/**
* Gets information about AWS CloudHSM clusters.
*
* This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a `NextToken` value. Use this value in a subsequent `DescribeClusters` request to get more clusters. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more clusters to get.
*/
public suspend fun describeClusters(input: DescribeClustersRequest = DescribeClustersRequest {}): DescribeClustersResponse
/**
* Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
*/
public suspend fun initializeCluster(input: InitializeClusterRequest): InitializeClusterResponse
/**
* Gets a list of tags for the specified AWS CloudHSM cluster.
*
* This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a `NextToken` value. Use this value in a subsequent `ListTags` request to get more tags. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more tags to get.
*/
public suspend fun listTags(input: ListTagsRequest): ListTagsResponse
/**
* Modifies attributes for AWS CloudHSM backup.
*/
public suspend fun modifyBackupAttributes(input: ModifyBackupAttributesRequest): ModifyBackupAttributesResponse
/**
* Modifies AWS CloudHSM cluster.
*/
public suspend fun modifyCluster(input: ModifyClusterRequest): ModifyClusterResponse
/**
* Restores a specified AWS CloudHSM backup that is in the `PENDING_DELETION` state. For mor information on deleting a backup, see DeleteBackup.
*/
public suspend fun restoreBackup(input: RestoreBackupRequest): RestoreBackupResponse
/**
* Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
*/
public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse
/**
* Removes the specified tag or tags from the specified AWS CloudHSM cluster.
*/
public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse
}
/**
* 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 CloudHsmV2Client.withConfig(block: CloudHsmV2Client.Config.Builder.() -> Unit): CloudHsmV2Client {
val newConfig = config.toBuilder().apply(block).build()
return DefaultCloudHsmV2Client(newConfig)
}
/**
* Copy an AWS CloudHSM cluster backup to a different region.
*/
public suspend inline fun CloudHsmV2Client.copyBackupToRegion(crossinline block: CopyBackupToRegionRequest.Builder.() -> Unit): CopyBackupToRegionResponse = copyBackupToRegion(CopyBackupToRegionRequest.Builder().apply(block).build())
/**
* Creates a new AWS CloudHSM cluster.
*/
public suspend inline fun CloudHsmV2Client.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse = createCluster(CreateClusterRequest.Builder().apply(block).build())
/**
* Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
*/
public suspend inline fun CloudHsmV2Client.createHsm(crossinline block: CreateHsmRequest.Builder.() -> Unit): CreateHsmResponse = createHsm(CreateHsmRequest.Builder().apply(block).build())
/**
* Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
*/
public suspend inline fun CloudHsmV2Client.deleteBackup(crossinline block: DeleteBackupRequest.Builder.() -> Unit): DeleteBackupResponse = deleteBackup(DeleteBackupRequest.Builder().apply(block).build())
/**
* Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
*/
public suspend inline fun CloudHsmV2Client.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse = deleteCluster(DeleteClusterRequest.Builder().apply(block).build())
/**
* Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
*/
public suspend inline fun CloudHsmV2Client.deleteHsm(crossinline block: DeleteHsmRequest.Builder.() -> Unit): DeleteHsmResponse = deleteHsm(DeleteHsmRequest.Builder().apply(block).build())
/**
* Gets information about backups of AWS CloudHSM clusters.
*
* This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a `NextToken` value. Use this value in a subsequent `DescribeBackups` request to get more backups. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more backups to get.
*/
public suspend inline fun CloudHsmV2Client.describeBackups(crossinline block: DescribeBackupsRequest.Builder.() -> Unit): DescribeBackupsResponse = describeBackups(DescribeBackupsRequest.Builder().apply(block).build())
/**
* Gets information about AWS CloudHSM clusters.
*
* This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a `NextToken` value. Use this value in a subsequent `DescribeClusters` request to get more clusters. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more clusters to get.
*/
public suspend inline fun CloudHsmV2Client.describeClusters(crossinline block: DescribeClustersRequest.Builder.() -> Unit): DescribeClustersResponse = describeClusters(DescribeClustersRequest.Builder().apply(block).build())
/**
* Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
*/
public suspend inline fun CloudHsmV2Client.initializeCluster(crossinline block: InitializeClusterRequest.Builder.() -> Unit): InitializeClusterResponse = initializeCluster(InitializeClusterRequest.Builder().apply(block).build())
/**
* Gets a list of tags for the specified AWS CloudHSM cluster.
*
* This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a `NextToken` value. Use this value in a subsequent `ListTags` request to get more tags. When you receive a response with no `NextToken` (or an empty or null value), that means there are no more tags to get.
*/
public suspend inline fun CloudHsmV2Client.listTags(crossinline block: ListTagsRequest.Builder.() -> Unit): ListTagsResponse = listTags(ListTagsRequest.Builder().apply(block).build())
/**
* Modifies attributes for AWS CloudHSM backup.
*/
public suspend inline fun CloudHsmV2Client.modifyBackupAttributes(crossinline block: ModifyBackupAttributesRequest.Builder.() -> Unit): ModifyBackupAttributesResponse = modifyBackupAttributes(ModifyBackupAttributesRequest.Builder().apply(block).build())
/**
* Modifies AWS CloudHSM cluster.
*/
public suspend inline fun CloudHsmV2Client.modifyCluster(crossinline block: ModifyClusterRequest.Builder.() -> Unit): ModifyClusterResponse = modifyCluster(ModifyClusterRequest.Builder().apply(block).build())
/**
* Restores a specified AWS CloudHSM backup that is in the `PENDING_DELETION` state. For mor information on deleting a backup, see DeleteBackup.
*/
public suspend inline fun CloudHsmV2Client.restoreBackup(crossinline block: RestoreBackupRequest.Builder.() -> Unit): RestoreBackupResponse = restoreBackup(RestoreBackupRequest.Builder().apply(block).build())
/**
* Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
*/
public suspend inline fun CloudHsmV2Client.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())
/**
* Removes the specified tag or tags from the specified AWS CloudHSM cluster.
*/
public suspend inline fun CloudHsmV2Client.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())
© 2015 - 2025 Weber Informatics LLC | Privacy Policy