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<ApiKeyTagArgs>>? = null, val value: Output<String>? = null) : ConvertibleToJava<ApiKeyArgs>

Resource Type definition for AWS::ApiGateway::ApiKey

Example Usage

Example

No Java example available.

Example

No Java example available.

Constructors

Link copied to clipboard
fun ApiKeyArgs(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<ApiKeyTagArgs>>? = null, value: Output<String>? = null)

Functions

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

Properties

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

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

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

A description of the purpose of the API key.

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

Indicates whether the API key can be used by clients.

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

Specifies whether 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, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.

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

A list of stages to associate with this API key.

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

An array of arbitrary tags (key-value pairs) to associate with the API key.

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

The value of the API key. Must be at least 20 characters long.