class CfnApiPropsMixin

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

Implements IMixin

Extends Mixin

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.

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 } from '@aws-cdk/mixins-preview';
import { mixins as appsync_mixins } from '@aws-cdk/mixins-preview/aws-appsync';
const cfnApiPropsMixin = new appsync_mixins.CfnApiPropsMixin({
  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',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnApiPropsMixin(props: CfnApiMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnApiMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnApiMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnApiMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.