interface CfnApiMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins.CfnApiMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappsync/mixins#CfnApiMixinProps
Java	software.amazon.awscdk.mixins.preview.services.appsync.mixins.CfnApiMixinProps
Python	aws_cdk.mixins_preview.aws_appsync.mixins.CfnApiMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_appsync » mixins » CfnApiMixinProps

Properties for CfnApiPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as appsync_mixins } from '@aws-cdk/mixins-preview/aws-appsync';
const cfnApiMixinProps: appsync_mixins.CfnApiMixinProps = {
  eventConfig: {
    authProviders: [{
      authType: 'authType',
      cognitoConfig: {
        appIdClientRegex: 'appIdClientRegex',
        awsRegion: 'awsRegion',
        userPoolId: 'userPoolId',
      },
      lambdaAuthorizerConfig: {
        authorizerResultTtlInSeconds: 123,
        authorizerUri: 'authorizerUri',
        identityValidationExpression: 'identityValidationExpression',
      },
      openIdConnectConfig: {
        authTtl: 123,
        clientId: 'clientId',
        iatTtl: 123,
        issuer: 'issuer',
      },
    }],
    connectionAuthModes: [{
      authType: 'authType',
    }],
    defaultPublishAuthModes: [{
      authType: 'authType',
    }],
    defaultSubscribeAuthModes: [{
      authType: 'authType',
    }],
    logConfig: {
      cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
      logLevel: 'logLevel',
    },
  },
  name: 'name',
  ownerContact: 'ownerContact',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
eventConfig?	IResolvable | EventConfigProperty	Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
name?	string	The name of the Api .
ownerContact?	string	The owner contact information for an API resource.
tags?	CfnTag[]	A set of tags (key-value pairs) for this API.

---

eventConfig?

Type: IResolvable | EventConfigProperty (optional)

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

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

---

name?

Type: string (optional)

The name of the Api .

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

---

ownerContact?

Type: string (optional)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

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

---

tags?

Type: CfnTag[] (optional)

A set of tags (key-value pairs) for this API.

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