interface ApiKeyOptions

Language	Type name
.NET	`Amazon.CDK.AWS.Apigatewayv2.ApiKeyOptions`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#ApiKeyOptions`
Java	`software.amazon.awscdk.services.apigatewayv2.ApiKeyOptions`
Python	`aws_cdk.aws_apigatewayv2.ApiKeyOptions`
TypeScript (source)	`aws-cdk-lib` » `aws_apigatewayv2` » `ApiKeyOptions`

The options for creating an API Key.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const apiKeyOptions: apigatewayv2.ApiKeyOptions = {
  apiKeyName: 'apiKeyName',
  description: 'description',
  value: 'value',
};

Properties

Name	Type	Description
apiKeyName?	`string`	A name for the API key.
description?	`string`	A description of the purpose of the API key.
value?	`string`	The value of the API key.

apiKeyName?

Type: string (optional, default: automatically generated name)

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.

description?

Type: string (optional, default: none)

A description of the purpose of the API key.

value?

Type: string (optional, default: none)

The value of the API key.

Must be at least 20 characters long.

AWS CDK