Interface IApiKeyConfig
(experimental) Configuration for API Key authorization in AppSync.
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public interface IApiKeyConfig
Syntax (vb)
Public Interface IApiKeyConfig
Remarks
Stability: Experimental
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.AWS.AppSync;
using Amazon.CDK;
Expiration expiration;
var apiKeyConfig = new ApiKeyConfig {
Description = "description",
Expires = expiration,
Name = "name"
};
Synopsis
Properties
Description | (experimental) Description of API key. |
Expires | (experimental) The time from creation time after which the API key expires. |
Name | (experimental) Unique name of the API Key. |
Properties
Description
(experimental) Description of API key.
virtual string Description { get; }
Property Value
System.String
Remarks
Default: - 'Default API Key created by CDK'
Stability: Experimental
Expires
(experimental) The time from creation time after which the API key expires.
virtual Expiration Expires { get; }
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
Stability: Experimental
Name
(experimental) Unique name of the API Key.
virtual string Name { get; }
Property Value
System.String
Remarks
Default: - 'DefaultAPIKey'
Stability: Experimental