Class CfnApiPropsMixin

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

Inheritance

object

Mixin

CfnApiPropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnApiPropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnApiPropsMixin Inherits Mixin Implements IMixin

Remarks

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

CloudformationResource: AWS::AppSync::Api

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins;

             var cfnApiPropsMixin = new CfnApiPropsMixin(new CfnApiMixinProps {
                 EventConfig = new EventConfigProperty {
                     AuthProviders = new [] { new AuthProviderProperty {
                         AuthType = "authType",
                         CognitoConfig = new CognitoConfigProperty {
                             AppIdClientRegex = "appIdClientRegex",
                             AwsRegion = "awsRegion",
                             UserPoolId = "userPoolId"
                         },
                         LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                             AuthorizerResultTtlInSeconds = 123,
                             AuthorizerUri = "authorizerUri",
                             IdentityValidationExpression = "identityValidationExpression"
                         },
                         OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                             AuthTtl = 123,
                             ClientId = "clientId",
                             IatTtl = 123,
                             Issuer = "issuer"
                         }
                     } },
                     ConnectionAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultPublishAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultSubscribeAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     LogConfig = new EventLogConfigProperty {
                         CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                         LogLevel = "logLevel"
                     }
                 },
                 Name = "name",
                 OwnerContact = "ownerContact",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnApiPropsMixin(ICfnApiMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::AppSync::Api.

Properties

CFN_PROPERTY_KEYS	The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
Props	The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
Strategy	The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnApiPropsMixin(ICfnApiMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::AppSync::Api.

public CfnApiPropsMixin(ICfnApiMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnApiMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

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

CloudformationResource: AWS::AppSync::Api

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

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

CloudformationResource: AWS::AppSync::Api

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins;

             var cfnApiPropsMixin = new CfnApiPropsMixin(new CfnApiMixinProps {
                 EventConfig = new EventConfigProperty {
                     AuthProviders = new [] { new AuthProviderProperty {
                         AuthType = "authType",
                         CognitoConfig = new CognitoConfigProperty {
                             AppIdClientRegex = "appIdClientRegex",
                             AwsRegion = "awsRegion",
                             UserPoolId = "userPoolId"
                         },
                         LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                             AuthorizerResultTtlInSeconds = 123,
                             AuthorizerUri = "authorizerUri",
                             IdentityValidationExpression = "identityValidationExpression"
                         },
                         OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                             AuthTtl = 123,
                             ClientId = "clientId",
                             IatTtl = 123,
                             Issuer = "issuer"
                         }
                     } },
                     ConnectionAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultPublishAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultSubscribeAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     LogConfig = new EventLogConfigProperty {
                         CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                         LogLevel = "logLevel"
                     }
                 },
                 Name = "name",
                 OwnerContact = "ownerContact",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

protected virtual ICfnApiMixinProps Props { get; }

Property Value

ICfnApiMixinProps

Remarks

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

CloudformationResource: AWS::AppSync::Api

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins;

             var cfnApiPropsMixin = new CfnApiPropsMixin(new CfnApiMixinProps {
                 EventConfig = new EventConfigProperty {
                     AuthProviders = new [] { new AuthProviderProperty {
                         AuthType = "authType",
                         CognitoConfig = new CognitoConfigProperty {
                             AppIdClientRegex = "appIdClientRegex",
                             AwsRegion = "awsRegion",
                             UserPoolId = "userPoolId"
                         },
                         LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                             AuthorizerResultTtlInSeconds = 123,
                             AuthorizerUri = "authorizerUri",
                             IdentityValidationExpression = "identityValidationExpression"
                         },
                         OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                             AuthTtl = 123,
                             ClientId = "clientId",
                             IatTtl = 123,
                             Issuer = "issuer"
                         }
                     } },
                     ConnectionAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultPublishAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultSubscribeAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     LogConfig = new EventLogConfigProperty {
                         CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                         LogLevel = "logLevel"
                     }
                 },
                 Name = "name",
                 OwnerContact = "ownerContact",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

protected virtual PropertyMergeStrategy Strategy { get; }

Property Value

PropertyMergeStrategy

Remarks

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

CloudformationResource: AWS::AppSync::Api

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins;

             var cfnApiPropsMixin = new CfnApiPropsMixin(new CfnApiMixinProps {
                 EventConfig = new EventConfigProperty {
                     AuthProviders = new [] { new AuthProviderProperty {
                         AuthType = "authType",
                         CognitoConfig = new CognitoConfigProperty {
                             AppIdClientRegex = "appIdClientRegex",
                             AwsRegion = "awsRegion",
                             UserPoolId = "userPoolId"
                         },
                         LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                             AuthorizerResultTtlInSeconds = 123,
                             AuthorizerUri = "authorizerUri",
                             IdentityValidationExpression = "identityValidationExpression"
                         },
                         OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                             AuthTtl = 123,
                             ClientId = "clientId",
                             IatTtl = 123,
                             Issuer = "issuer"
                         }
                     } },
                     ConnectionAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultPublishAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultSubscribeAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     LogConfig = new EventLogConfigProperty {
                         CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                         LogLevel = "logLevel"
                     }
                 },
                 Name = "name",
                 OwnerContact = "ownerContact",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Returns

IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

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

CloudformationResource: AWS::AppSync::Api

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

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

CloudformationResource: AWS::AppSync::Api

Mixin: true

ExampleMetadata: fixture=_generated

Implements

IMixin