Interface CfnApi.IEventConfigProperty

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnApi.IEventConfigProperty

Syntax (vb)

Public Interface CfnApi.IEventConfigProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html

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;

             var eventConfigProperty = new EventConfigProperty {
                 AuthProviders = new [] { new AuthProviderProperty {
                     AuthType = "authType",

                     // the properties below are optional
                     CognitoConfig = new CognitoConfigProperty {
                         AwsRegion = "awsRegion",
                         UserPoolId = "userPoolId",

                         // the properties below are optional
                         AppIdClientRegex = "appIdClientRegex"
                     },
                     LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                         AuthorizerUri = "authorizerUri",

                         // the properties below are optional
                         AuthorizerResultTtlInSeconds = 123,
                         IdentityValidationExpression = "identityValidationExpression"
                     },
                     OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                         Issuer = "issuer",

                         // the properties below are optional
                         AuthTtl = 123,
                         ClientId = "clientId",
                         IatTtl = 123
                     }
                 } },
                 ConnectionAuthModes = new [] { new AuthModeProperty {
                     AuthType = "authType"
                 } },
                 DefaultPublishAuthModes = new [] { new AuthModeProperty {
                     AuthType = "authType"
                 } },
                 DefaultSubscribeAuthModes = new [] { new AuthModeProperty {
                     AuthType = "authType"
                 } },

                 // the properties below are optional
                 LogConfig = new EventLogConfigProperty {
                     CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                     LogLevel = "logLevel"
                 }
             };

Synopsis

Properties

AuthProviders	A list of authorization providers.
ConnectionAuthModes	A list of valid authorization modes for the Event API connections.
DefaultPublishAuthModes	A list of valid authorization modes for the Event API publishing.
DefaultSubscribeAuthModes	A list of valid authorization modes for the Event API subscriptions.
LogConfig	The CloudWatch Logs configuration for the Event API.

Properties

AuthProviders

A list of authorization providers.

object AuthProviders { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-authproviders

Type union: either IResolvable or (either IResolvable or CfnApi.IAuthProviderProperty)[]

ConnectionAuthModes

A list of valid authorization modes for the Event API connections.

object ConnectionAuthModes { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-connectionauthmodes

Type union: either IResolvable or (either IResolvable or CfnApi.IAuthModeProperty)[]

DefaultPublishAuthModes

A list of valid authorization modes for the Event API publishing.

object DefaultPublishAuthModes { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-defaultpublishauthmodes

Type union: either IResolvable or (either IResolvable or CfnApi.IAuthModeProperty)[]

DefaultSubscribeAuthModes

A list of valid authorization modes for the Event API subscriptions.

object DefaultSubscribeAuthModes { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-defaultsubscribeauthmodes

Type union: either IResolvable or (either IResolvable or CfnApi.IAuthModeProperty)[]

LogConfig

The CloudWatch Logs configuration for the Event API.

object? LogConfig { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-logconfig

Type union: either IResolvable or CfnApi.IEventLogConfigProperty