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

ApiKey

class ApiKey : KotlinCustomResource

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.

Properties

apiKeyId

val apiKeyId: Output<String>

The ID for the API key. For example: abc123 .

customerId

val customerId: Output<String>?

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

description

val description: Output<String>?

The description of the ApiKey.

enabled

val enabled: Output<Boolean>?

Specifies whether the ApiKey can be used by callers.

generateDistinctId

val generateDistinctId: Output<Boolean>?

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.

val id: Output<String>

name

val name: Output<String>?

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.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

stageKeys

val stageKeys: Output<List<ApiKeyStageKey>>?

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