Interface IApiKeyConfig

Configuration for API Key authorization in AppSync.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IApiKeyConfig

Syntax (vb)

Public Interface 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

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.

Properties

Description

Description of API key.

string? Description { get; }

Property Value

string

Remarks

Default: - 'Default API Key created by CDK'

Expires

The time from creation time after which the API key expires.

Expiration? Expires { get; }

Property Value

Expiration

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.

string? Name { get; }

Property Value

string

Remarks

Default: - 'DefaultAPIKey'