io.cloudshiftdev.awscdk.services.apigateway.RateLimitedApiKey.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.apigateway
import io.cloudshiftdev.awscdk.Resource
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.services.iam.Grant
import io.cloudshiftdev.awscdk.services.iam.IGrantable
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* An API Gateway ApiKey, for which a rate limiting configuration can be specified.
*
* Example:
*
* ```
* RestApi api;
* RateLimitedApiKey key = RateLimitedApiKey.Builder.create(this, "rate-limited-api-key")
* .customerId("hello-customer")
* .stages(List.of(api.getDeploymentStage()))
* .quota(QuotaSettings.builder()
* .limit(10000)
* .period(Period.MONTH)
* .build())
* .build();
* ```
*/
public open class RateLimitedApiKey(
cdkObject: software.amazon.awscdk.services.apigateway.RateLimitedApiKey,
) : Resource(cdkObject),
IApiKey {
public constructor(scope: CloudshiftdevConstructsConstruct, id: String) :
this(software.amazon.awscdk.services.apigateway.RateLimitedApiKey(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id)
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: RateLimitedApiKeyProps,
) :
this(software.amazon.awscdk.services.apigateway.RateLimitedApiKey(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(RateLimitedApiKeyProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: RateLimitedApiKeyProps.Builder.() -> Unit,
) : this(scope, id, RateLimitedApiKeyProps(props)
)
/**
* Permits the IAM principal all read operations through this key.
*
* @param grantee The principal to grant access to.
*/
public open fun grantRead(grantee: IGrantable): Grant =
unwrap(this).grantRead(grantee.let(IGrantable.Companion::unwrap)).let(Grant::wrap)
/**
* Permits the IAM principal all read and write operations through this key.
*
* @param grantee The principal to grant access to.
*/
public open fun grantReadWrite(grantee: IGrantable): Grant =
unwrap(this).grantReadWrite(grantee.let(IGrantable.Companion::unwrap)).let(Grant::wrap)
/**
* Permits the IAM principal all write operations through this key.
*
* @param grantee The principal to grant access to.
*/
public open fun grantWrite(grantee: IGrantable): Grant =
unwrap(this).grantWrite(grantee.let(IGrantable.Companion::unwrap)).let(Grant::wrap)
/**
* The API key ARN.
*/
public override fun keyArn(): String = unwrap(this).getKeyArn()
/**
* The API key ID.
*/
public override fun keyId(): String = unwrap(this).getKeyId()
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.apigateway.RateLimitedApiKey].
*/
@CdkDslMarker
public interface Builder {
/**
* A name for the API key.
*
* If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that
* ID for the API key name.
*
* Default: automically generated name
*
* @param apiKeyName A name for the API key.
*/
public fun apiKeyName(apiKeyName: String)
/**
* API Stages to be associated with the RateLimitedApiKey.
*
* Default: none
*
* @param apiStages API Stages to be associated with the RateLimitedApiKey.
*/
public fun apiStages(apiStages: List)
/**
* API Stages to be associated with the RateLimitedApiKey.
*
* Default: none
*
* @param apiStages API Stages to be associated with the RateLimitedApiKey.
*/
public fun apiStages(vararg apiStages: UsagePlanPerApiStage)
/**
* An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
*
* Default: none
*
* @param customerId An AWS Marketplace customer identifier to use when integrating with the AWS
* SaaS Marketplace.
*/
public fun customerId(customerId: String)
/**
* Adds a CORS preflight OPTIONS method to this resource and all child resources.
*
* You can add CORS at the resource-level using `addCorsPreflight`.
*
* Default: - CORS is disabled
*
* @param defaultCorsPreflightOptions Adds a CORS preflight OPTIONS method to this resource and
* all child resources.
*/
public fun defaultCorsPreflightOptions(defaultCorsPreflightOptions: CorsOptions)
/**
* Adds a CORS preflight OPTIONS method to this resource and all child resources.
*
* You can add CORS at the resource-level using `addCorsPreflight`.
*
* Default: - CORS is disabled
*
* @param defaultCorsPreflightOptions Adds a CORS preflight OPTIONS method to this resource and
* all child resources.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("f50ff071625981764f82429784ac3715b63e9f508b1e50d085551637034bad70")
public
fun defaultCorsPreflightOptions(defaultCorsPreflightOptions: CorsOptions.Builder.() -> Unit)
/**
* An integration to use as a default for all methods created within this API unless an
* integration is specified.
*
* Default: - Inherited from parent.
*
* @param defaultIntegration An integration to use as a default for all methods created within
* this API unless an integration is specified.
*/
public fun defaultIntegration(defaultIntegration: Integration)
/**
* An integration to use as a default for all methods created within this API unless an
* integration is specified.
*
* Default: - Inherited from parent.
*
* @param defaultIntegration An integration to use as a default for all methods created within
* this API unless an integration is specified.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("60439bd874f0211a9dafedf2e647e2c45f5a751727d104ed0e83c0f0c9fbb67c")
public fun defaultIntegration(defaultIntegration: Integration.Builder.() -> Unit)
/**
* Method options to use as a default for all methods created within this API unless custom
* options are specified.
*
* Default: - Inherited from parent.
*
* @param defaultMethodOptions Method options to use as a default for all methods created within
* this API unless custom options are specified.
*/
public fun defaultMethodOptions(defaultMethodOptions: MethodOptions)
/**
* Method options to use as a default for all methods created within this API unless custom
* options are specified.
*
* Default: - Inherited from parent.
*
* @param defaultMethodOptions Method options to use as a default for all methods created within
* this API unless custom options are specified.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("ef97845dba141b04eefe2f909187c753c4024aac51744efff91a0adc77af1c6f")
public fun defaultMethodOptions(defaultMethodOptions: MethodOptions.Builder.() -> Unit)
/**
* A description of the purpose of the API key.
*
* Default: none
*
* @param description A description of the purpose of the API key.
*/
public fun description(description: String)
/**
* Indicates whether the API key can be used by clients.
*
* Default: true
*
* @param enabled Indicates whether the API key can be used by clients.
*/
public fun enabled(enabled: Boolean)
/**
* Specifies whether the key identifier is distinct from the created API key value.
*
* Default: false
*
* @param generateDistinctId Specifies whether the key identifier is distinct from the created
* API key value.
*/
public fun generateDistinctId(generateDistinctId: Boolean)
/**
* Number of requests clients can make in a given time period.
*
* Default: none
*
* @param quota Number of requests clients can make in a given time period.
*/
public fun quota(quota: QuotaSettings)
/**
* Number of requests clients can make in a given time period.
*
* Default: none
*
* @param quota Number of requests clients can make in a given time period.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("d3a77bfbeb4a98e3eddcfd39cfed3e64991adc4e7ddb06d0d29ce83cf2cced7c")
public fun quota(quota: QuotaSettings.Builder.() -> Unit)
/**
* (deprecated) A list of resources this api key is associated with.
*
* Default: none
*
* * use `stages` instead
* @param resources A list of resources this api key is associated with.
*/
@Deprecated(message = "deprecated in CDK")
public fun resources(resources: List)
/**
* (deprecated) A list of resources this api key is associated with.
*
* Default: none
*
* * use `stages` instead
* @param resources A list of resources this api key is associated with.
*/
@Deprecated(message = "deprecated in CDK")
public fun resources(vararg resources: IRestApi)
/**
* A list of Stages this api key is associated with.
*
* Default: - the api key is not associated with any stages
*
* @param stages A list of Stages this api key is associated with.
*/
public fun stages(stages: List)
/**
* A list of Stages this api key is associated with.
*
* Default: - the api key is not associated with any stages
*
* @param stages A list of Stages this api key is associated with.
*/
public fun stages(vararg stages: IStage)
/**
* Overall throttle settings for the API.
*
* Default: none
*
* @param throttle Overall throttle settings for the API.
*/
public fun throttle(throttle: ThrottleSettings)
/**
* Overall throttle settings for the API.
*
* Default: none
*
* @param throttle Overall throttle settings for the API.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("6c653e494d941860dd189f107cb8a8595ac6894842b9a37fc7e36b41b4de4771")
public fun throttle(throttle: ThrottleSettings.Builder.() -> Unit)
/**
* The value of the API key.
*
* Must be at least 20 characters long.
*
* Default: none
*
* @param value The value of the API key.
*/
public fun `value`(`value`: String)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.apigateway.RateLimitedApiKey.Builder =
software.amazon.awscdk.services.apigateway.RateLimitedApiKey.Builder.create(scope, id)
/**
* A name for the API key.
*
* If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that
* ID for the API key name.
*
* Default: automically generated name
*
* @param apiKeyName A name for the API key.
*/
override fun apiKeyName(apiKeyName: String) {
cdkBuilder.apiKeyName(apiKeyName)
}
/**
* API Stages to be associated with the RateLimitedApiKey.
*
* Default: none
*
* @param apiStages API Stages to be associated with the RateLimitedApiKey.
*/
override fun apiStages(apiStages: List) {
cdkBuilder.apiStages(apiStages.map(UsagePlanPerApiStage.Companion::unwrap))
}
/**
* API Stages to be associated with the RateLimitedApiKey.
*
* Default: none
*
* @param apiStages API Stages to be associated with the RateLimitedApiKey.
*/
override fun apiStages(vararg apiStages: UsagePlanPerApiStage): Unit =
apiStages(apiStages.toList())
/**
* An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
*
* Default: none
*
* @param customerId An AWS Marketplace customer identifier to use when integrating with the AWS
* SaaS Marketplace.
*/
override fun customerId(customerId: String) {
cdkBuilder.customerId(customerId)
}
/**
* Adds a CORS preflight OPTIONS method to this resource and all child resources.
*
* You can add CORS at the resource-level using `addCorsPreflight`.
*
* Default: - CORS is disabled
*
* @param defaultCorsPreflightOptions Adds a CORS preflight OPTIONS method to this resource and
* all child resources.
*/
override fun defaultCorsPreflightOptions(defaultCorsPreflightOptions: CorsOptions) {
cdkBuilder.defaultCorsPreflightOptions(defaultCorsPreflightOptions.let(CorsOptions.Companion::unwrap))
}
/**
* Adds a CORS preflight OPTIONS method to this resource and all child resources.
*
* You can add CORS at the resource-level using `addCorsPreflight`.
*
* Default: - CORS is disabled
*
* @param defaultCorsPreflightOptions Adds a CORS preflight OPTIONS method to this resource and
* all child resources.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("f50ff071625981764f82429784ac3715b63e9f508b1e50d085551637034bad70")
override
fun defaultCorsPreflightOptions(defaultCorsPreflightOptions: CorsOptions.Builder.() -> Unit):
Unit = defaultCorsPreflightOptions(CorsOptions(defaultCorsPreflightOptions))
/**
* An integration to use as a default for all methods created within this API unless an
* integration is specified.
*
* Default: - Inherited from parent.
*
* @param defaultIntegration An integration to use as a default for all methods created within
* this API unless an integration is specified.
*/
override fun defaultIntegration(defaultIntegration: Integration) {
cdkBuilder.defaultIntegration(defaultIntegration.let(Integration.Companion::unwrap))
}
/**
* An integration to use as a default for all methods created within this API unless an
* integration is specified.
*
* Default: - Inherited from parent.
*
* @param defaultIntegration An integration to use as a default for all methods created within
* this API unless an integration is specified.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("60439bd874f0211a9dafedf2e647e2c45f5a751727d104ed0e83c0f0c9fbb67c")
override fun defaultIntegration(defaultIntegration: Integration.Builder.() -> Unit): Unit =
defaultIntegration(Integration(defaultIntegration))
/**
* Method options to use as a default for all methods created within this API unless custom
* options are specified.
*
* Default: - Inherited from parent.
*
* @param defaultMethodOptions Method options to use as a default for all methods created within
* this API unless custom options are specified.
*/
override fun defaultMethodOptions(defaultMethodOptions: MethodOptions) {
cdkBuilder.defaultMethodOptions(defaultMethodOptions.let(MethodOptions.Companion::unwrap))
}
/**
* Method options to use as a default for all methods created within this API unless custom
* options are specified.
*
* Default: - Inherited from parent.
*
* @param defaultMethodOptions Method options to use as a default for all methods created within
* this API unless custom options are specified.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("ef97845dba141b04eefe2f909187c753c4024aac51744efff91a0adc77af1c6f")
override fun defaultMethodOptions(defaultMethodOptions: MethodOptions.Builder.() -> Unit): Unit
= defaultMethodOptions(MethodOptions(defaultMethodOptions))
/**
* A description of the purpose of the API key.
*
* Default: none
*
* @param description A description of the purpose of the API key.
*/
override fun description(description: String) {
cdkBuilder.description(description)
}
/**
* Indicates whether the API key can be used by clients.
*
* Default: true
*
* @param enabled Indicates whether the API key can be used by clients.
*/
override fun enabled(enabled: Boolean) {
cdkBuilder.enabled(enabled)
}
/**
* Specifies whether the key identifier is distinct from the created API key value.
*
* Default: false
*
* @param generateDistinctId Specifies whether the key identifier is distinct from the created
* API key value.
*/
override fun generateDistinctId(generateDistinctId: Boolean) {
cdkBuilder.generateDistinctId(generateDistinctId)
}
/**
* Number of requests clients can make in a given time period.
*
* Default: none
*
* @param quota Number of requests clients can make in a given time period.
*/
override fun quota(quota: QuotaSettings) {
cdkBuilder.quota(quota.let(QuotaSettings.Companion::unwrap))
}
/**
* Number of requests clients can make in a given time period.
*
* Default: none
*
* @param quota Number of requests clients can make in a given time period.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("d3a77bfbeb4a98e3eddcfd39cfed3e64991adc4e7ddb06d0d29ce83cf2cced7c")
override fun quota(quota: QuotaSettings.Builder.() -> Unit): Unit = quota(QuotaSettings(quota))
/**
* (deprecated) A list of resources this api key is associated with.
*
* Default: none
*
* * use `stages` instead
* @param resources A list of resources this api key is associated with.
*/
@Deprecated(message = "deprecated in CDK")
override fun resources(resources: List) {
cdkBuilder.resources(resources.map(IRestApi.Companion::unwrap))
}
/**
* (deprecated) A list of resources this api key is associated with.
*
* Default: none
*
* * use `stages` instead
* @param resources A list of resources this api key is associated with.
*/
@Deprecated(message = "deprecated in CDK")
override fun resources(vararg resources: IRestApi): Unit = resources(resources.toList())
/**
* A list of Stages this api key is associated with.
*
* Default: - the api key is not associated with any stages
*
* @param stages A list of Stages this api key is associated with.
*/
override fun stages(stages: List) {
cdkBuilder.stages(stages.map(IStage.Companion::unwrap))
}
/**
* A list of Stages this api key is associated with.
*
* Default: - the api key is not associated with any stages
*
* @param stages A list of Stages this api key is associated with.
*/
override fun stages(vararg stages: IStage): Unit = stages(stages.toList())
/**
* Overall throttle settings for the API.
*
* Default: none
*
* @param throttle Overall throttle settings for the API.
*/
override fun throttle(throttle: ThrottleSettings) {
cdkBuilder.throttle(throttle.let(ThrottleSettings.Companion::unwrap))
}
/**
* Overall throttle settings for the API.
*
* Default: none
*
* @param throttle Overall throttle settings for the API.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("6c653e494d941860dd189f107cb8a8595ac6894842b9a37fc7e36b41b4de4771")
override fun throttle(throttle: ThrottleSettings.Builder.() -> Unit): Unit =
throttle(ThrottleSettings(throttle))
/**
* The value of the API key.
*
* Must be at least 20 characters long.
*
* Default: none
*
* @param value The value of the API key.
*/
override fun `value`(`value`: String) {
cdkBuilder.`value`(`value`)
}
public fun build(): software.amazon.awscdk.services.apigateway.RateLimitedApiKey =
cdkBuilder.build()
}
public companion object {
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): RateLimitedApiKey {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return RateLimitedApiKey(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.apigateway.RateLimitedApiKey):
RateLimitedApiKey = RateLimitedApiKey(cdkObject)
internal fun unwrap(wrapped: RateLimitedApiKey):
software.amazon.awscdk.services.apigateway.RateLimitedApiKey = wrapped.cdkObject as
software.amazon.awscdk.services.apigateway.RateLimitedApiKey
}
}