interface CfnApiKeyProps

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.CfnApiKeyProps
Java	software.amazon.awscdk.services.appsync.CfnApiKeyProps
Python	aws_cdk.aws_appsync.CfnApiKeyProps
TypeScript	@aws-cdk/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 * as appsync from '@aws-cdk/aws-appsync';
const cfnApiKeyProps: appsync.CfnApiKeyProps = {
  apiId: 'apiId',

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

Properties

Name	Type	Description
apiId	string	Unique AWS AppSync GraphQL API ID for this API key.
apiKeyId?	string	The API key ID.
description?	string	Unique description of your API key.
expires?	number	The 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.