interface CfnApiKeyProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AppSync.CfnApiKeyProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnApiKeyProps |
 Java | software.amazon.awscdk.services.appsync.CfnApiKeyProps |
 Python | aws_cdk.aws_appsync.CfnApiKeyProps |
 TypeScript | aws-cdk-lib » aws_appsync » CfnApiKeyProps |
Properties for defining a CfnApiKey.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html
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
description: 'description',
expires: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| api | string | Unique AWS AppSync GraphQL API ID for this API key. |
| 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.
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.