pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin/ApiKeyArgs

ApiKeyArgs

data class ApiKeyArgs(val customerId: Output<String>? = null, val description: Output<String>? = null, val enabled: Output<Boolean>? = null, val generateDistinctId: Output<Boolean>? = null, val name: Output<String>? = null, val stageKeys: Output<List<ApiKeyStageKeyArgs>>? = null, val tags: Output<List<TagArgs>>? = null, val value: Output<String>? = null) : ConvertibleToJava<ApiKeyArgs>

The `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distribute to clients who are executing API Gateway `Method` resources that require an API key. To specify which API key clients must use, map the API key with the `RestApi` and `Stage` resources that include the methods that require a key.

Example Usage

Example

No Java example available.

Example

No Java example available.

Constructors

Link copied to clipboard
constructor(customerId: Output<String>? = null, description: Output<String>? = null, enabled: Output<Boolean>? = null, generateDistinctId: Output<Boolean>? = null, name: Output<String>? = null, stageKeys: Output<List<ApiKeyStageKeyArgs>>? = null, tags: Output<List<TagArgs>>? = null, value: Output<String>? = null)

Properties

Link copied to clipboard
val customerId: Output<String>? = null

An MKT customer identifier, when integrating with the AWS SaaS Marketplace.

Link copied to clipboard
val description: Output<String>? = null

The description of the ApiKey.

Link copied to clipboard
val enabled: Output<Boolean>? = null

Specifies whether the ApiKey can be used by callers.

Link copied to clipboard
val generateDistinctId: Output<Boolean>? = null

Specifies whether (`true`) or not (`false`) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

Link copied to clipboard
val name: Output<String>? = null

A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Link copied to clipboard
val stageKeys: Output<List<ApiKeyStageKeyArgs>>? = null

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

The key-value map of strings. The valid character set is a-zA-Z+-=._:/. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.

Link copied to clipboard
val value: Output<String>? = null

Specifies a value of the API key.

Functions

Link copied to clipboard
open override fun toJava(): ApiKeyArgs