aws-cdk-lib.aws_appsync.CfnApiKeyProps

interface CfnApiKeyProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.CfnApiKeyProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnApiKeyProps
Javasoftware.amazon.awscdk.services.appsync.CfnApiKeyProps
Pythonaws_cdk.aws_appsync.CfnApiKeyProps
TypeScript aws-cdk-lib » aws_appsync » CfnApiKeyProps

Properties for defining a CfnApiKey.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const cfnApiKeyProps: appsync.CfnApiKeyProps = {
  apiId: 'apiId',

  // the properties below are optional
  apiKeyId: 'apiKeyId',
  description: 'description',
  expires: 123,
};

Properties

NameTypeDescription
apiIdstringUnique AWS AppSync GraphQL API ID for this API key.
apiKeyId?stringThe API key ID.
description?stringUnique description of your API key.
expires?numberThe time after which the API key expires.

apiId

Type: string

Unique AWS AppSync GraphQL API ID for this API key.


apiKeyId?

Type: string (optional)

The API key ID.


description?

Type: string (optional)

Unique description of your API key.


expires?

Type: number (optional)

The time after which the API key expires.

The date is represented as seconds since the epoch, rounded down to the nearest hour.