ApiKeyConfig Struct
Configuration for API Key authorization in AppSync.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_appsync as appsync } from 'aws-cdk-lib';
declare const expiration: cdk.Expiration;
const apiKeyConfig: appsync.ApiKeyConfig = {
description: 'description',
expires: expiration,
name: 'name',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_appsync as appsync
# expiration: cdk.Expiration
api_key_config = appsync.ApiKeyConfig(
description="description",
expires=expiration,
name="name"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.appsync.*;
Expiration expiration;
ApiKeyConfig apiKeyConfig = ApiKeyConfig.builder()
.description("description")
.expires(expiration)
.name("name")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.AppSync;
Expiration expiration;
var apiKeyConfig = new ApiKeyConfig {
Description = "description",
Expires = expiration,
Name = "name"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var expiration Expiration
apiKeyConfig := &ApiKeyConfig{
Description: jsii.String("description"),
Expires: expiration,
Name: jsii.String("name"),
}
Properties
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Description of API key.
Default: 'Default API Key created by CDK'
expiresoptionalExpirationexpiresoptionalExpirationexpiresoptionalExpirationExpiresoptionalExpirationExpiresoptionalExpiration#The time from creation time after which the API key expires.
Default: 7 days rounded down to nearest hour
It must be a minimum of 1 day and a maximum of 365 days from date of creation. Rounded down to the nearest hour.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string= 'DefaultAPIKey'#Unique name of the API Key.