Class EventApiAuthConfig

Authorization configuration for the Event API.

Inheritance

object

EventApiAuthConfig

Implements

IEventApiAuthConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EventApiAuthConfig : IEventApiAuthConfig

Syntax (vb)

Public Class EventApiAuthConfig Implements IEventApiAuthConfig

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Logs;


            var apiKeyProvider = new AppSyncAuthProvider {
                AuthorizationType = AppSyncAuthorizationType.API_KEY
            };

            var api = new EventApi(this, "api", new EventApiProps {
                ApiName = "Api",
                OwnerContact = "OwnerContact",
                AuthorizationConfig = new EventApiAuthConfig {
                    AuthProviders = new [] { apiKeyProvider },
                    ConnectionAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
                    DefaultPublishAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
                    DefaultSubscribeAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY }
                },
                LogConfig = new AppSyncLogConfig {
                    FieldLogLevel = AppSyncFieldLogLevel.INFO,
                    Retention = RetentionDays.ONE_WEEK
                }
            });

            api.AddChannelNamespace("default");

Synopsis

Constructors

EventApiAuthConfig()

Authorization configuration for the Event API.

Properties

AuthProviders	Auth providers for use in connection, publish, and subscribe operations.
ConnectionAuthModeTypes	Connection auth modes.
DefaultPublishAuthModeTypes	Default publish auth modes.
DefaultSubscribeAuthModeTypes	Default subscribe auth modes.

Constructors

EventApiAuthConfig()

Authorization configuration for the Event API.

public EventApiAuthConfig()

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Logs;


            var apiKeyProvider = new AppSyncAuthProvider {
                AuthorizationType = AppSyncAuthorizationType.API_KEY
            };

            var api = new EventApi(this, "api", new EventApiProps {
                ApiName = "Api",
                OwnerContact = "OwnerContact",
                AuthorizationConfig = new EventApiAuthConfig {
                    AuthProviders = new [] { apiKeyProvider },
                    ConnectionAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
                    DefaultPublishAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
                    DefaultSubscribeAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY }
                },
                LogConfig = new AppSyncLogConfig {
                    FieldLogLevel = AppSyncFieldLogLevel.INFO,
                    Retention = RetentionDays.ONE_WEEK
                }
            });

            api.AddChannelNamespace("default");

Properties

AuthProviders

Auth providers for use in connection, publish, and subscribe operations.

public IAppSyncAuthProvider[]? AuthProviders { get; set; }

Property Value

IAppSyncAuthProvider[]

Remarks

Default: - API Key authorization

ConnectionAuthModeTypes

Connection auth modes.

public AppSyncAuthorizationType[]? ConnectionAuthModeTypes { get; set; }

Property Value

AppSyncAuthorizationType[]

Remarks

Default: - API Key authorization

DefaultPublishAuthModeTypes

Default publish auth modes.

public AppSyncAuthorizationType[]? DefaultPublishAuthModeTypes { get; set; }

Property Value

AppSyncAuthorizationType[]

Remarks

Default: - API Key authorization

DefaultSubscribeAuthModeTypes

Default subscribe auth modes.

public AppSyncAuthorizationType[]? DefaultSubscribeAuthModeTypes { get; set; }

Property Value

AppSyncAuthorizationType[]

Remarks

Default: - API Key authorization

Implements

IEventApiAuthConfig