Show / Hide Table of Contents

Class CfnApi.EventConfigProperty

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

Inheritance
object
CfnApi.EventConfigProperty
Implements
CfnApi.IEventConfigProperty
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 CfnApi.EventConfigProperty : CfnApi.IEventConfigProperty
Syntax (vb)
Public Class CfnApi.EventConfigProperty Implements 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

Constructors

EventConfigProperty()

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

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.

Constructors

EventConfigProperty()

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

public EventConfigProperty()
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"
                 }
             };

Properties

AuthProviders

A list of authorization providers.

public object AuthProviders { get; set; }
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.

public object ConnectionAuthModes { get; set; }
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.

public object DefaultPublishAuthModes { get; set; }
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.

public object DefaultSubscribeAuthModes { get; set; }
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.

public object? LogConfig { get; set; }
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

Implements

CfnApi.IEventConfigProperty
Back to top Generated by DocFX