Class ApiKeyConfig
Configuration for API Key authorization in AppSync.
Inheritance
System.Object
ApiKeyConfig
Implements
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ApiKeyConfig : Object, IApiKeyConfig
Syntax (vb)
Public Class ApiKeyConfig
Inherits Object
Implements IApiKeyConfig
Remarks
ExampleMetadata: fixture=_generated
Examples
// 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"
};
Synopsis
Constructors
ApiKeyConfig() |
Properties
Description | Description of API key. |
Expires | The time from creation time after which the API key expires. |
Name | Unique name of the API Key. |
Constructors
ApiKeyConfig()
public ApiKeyConfig()
Properties
Description
Description of API key.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - 'Default API Key created by CDK'
Expires
The time from creation time after which the API key expires.
public Expiration Expires { get; set; }
Property Value
Remarks
It must be a minimum of 1 day and a maximum of 365 days from date of creation. Rounded down to the nearest hour.
Default: - 7 days rounded down to nearest hour
Name
Unique name of the API Key.
public string Name { get; set; }
Property Value
System.String
Remarks
Default: - 'DefaultAPIKey'