This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-appsync

The CDK Construct Library for AWS AppSync

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.AppSync" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.AppSync --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.AppSync" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:appsync:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="appsync" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>appsync</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:appsync:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='appsync', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-appsync@0.25.3

package.json:

{
  "@aws-cdk/aws-appsync": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-appsync@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-appsync@0.25.3

package.json:

{
  "@aws-cdk/aws-appsync": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-appsync@0.25.3

CfnApiKey

class @aws-cdk/aws-appsync.CfnApiKey(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnApiKey;
const { CfnApiKey } = require('@aws-cdk/aws-appsync');
import { CfnApiKey } from '@aws-cdk/aws-appsync';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
apiKey
Type:string (readonly)
apiKeyArn
Type:string (readonly)
propertyOverrides
Type:CfnApiKeyProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnApiKeyProps (interface)

class @aws-cdk/aws-appsync.CfnApiKeyProps

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnApiKeyProps;
// CfnApiKeyProps is an interface
import { CfnApiKeyProps } from '@aws-cdk/aws-appsync';
apiId

AWS::AppSync::ApiKey.ApiId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apiid

Type:string
description

AWS::AppSync::ApiKey.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-description

Type:string (optional)
expires

AWS::AppSync::ApiKey.Expires

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires

Type:number or @aws-cdk/cdk.Token (optional)

CfnDataSource

class @aws-cdk/aws-appsync.CfnDataSource(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource;
const { CfnDataSource } = require('@aws-cdk/aws-appsync');
import { CfnDataSource } from '@aws-cdk/aws-appsync';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dataSourceArn
Type:string (readonly)
dataSourceName
Type:string (readonly)
propertyOverrides
Type:CfnDataSourceProps (readonly)
class AuthorizationConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource.AuthorizationConfigProperty;
// CfnDataSource.AuthorizationConfigProperty is an interface
import { CfnDataSource.AuthorizationConfigProperty } from '@aws-cdk/aws-appsync';
authorizationType

CfnDataSource.AuthorizationConfigProperty.AuthorizationType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-authorizationconfig.html#cfn-appsync-datasource-authorizationconfig-authorizationtype

Type:string
awsIamConfig

CfnDataSource.AuthorizationConfigProperty.AwsIamConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-authorizationconfig.html#cfn-appsync-datasource-authorizationconfig-awsiamconfig

Type:@aws-cdk/cdk.Token or AwsIamConfigProperty (optional)
class AwsIamConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource.AwsIamConfigProperty;
// CfnDataSource.AwsIamConfigProperty is an interface
import { CfnDataSource.AwsIamConfigProperty } from '@aws-cdk/aws-appsync';
signingRegion

CfnDataSource.AwsIamConfigProperty.SigningRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-awsiamconfig.html#cfn-appsync-datasource-awsiamconfig-signingregion

Type:string (optional)
signingServiceName

CfnDataSource.AwsIamConfigProperty.SigningServiceName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-awsiamconfig.html#cfn-appsync-datasource-awsiamconfig-signingservicename

Type:string (optional)
class DynamoDBConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource.DynamoDBConfigProperty;
// CfnDataSource.DynamoDBConfigProperty is an interface
import { CfnDataSource.DynamoDBConfigProperty } from '@aws-cdk/aws-appsync';
awsRegion

CfnDataSource.DynamoDBConfigProperty.AwsRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-awsregion

Type:string
tableName

CfnDataSource.DynamoDBConfigProperty.TableName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-tablename

Type:string
useCallerCredentials

CfnDataSource.DynamoDBConfigProperty.UseCallerCredentials

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-usecallercredentials

Type:boolean or @aws-cdk/cdk.Token (optional)
class ElasticsearchConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource.ElasticsearchConfigProperty;
// CfnDataSource.ElasticsearchConfigProperty is an interface
import { CfnDataSource.ElasticsearchConfigProperty } from '@aws-cdk/aws-appsync';
awsRegion

CfnDataSource.ElasticsearchConfigProperty.AwsRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-elasticsearchconfig.html#cfn-appsync-datasource-elasticsearchconfig-awsregion

Type:string
endpoint

CfnDataSource.ElasticsearchConfigProperty.Endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-elasticsearchconfig.html#cfn-appsync-datasource-elasticsearchconfig-endpoint

Type:string
class HttpConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource.HttpConfigProperty;
// CfnDataSource.HttpConfigProperty is an interface
import { CfnDataSource.HttpConfigProperty } from '@aws-cdk/aws-appsync';
endpoint

CfnDataSource.HttpConfigProperty.Endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig.html#cfn-appsync-datasource-httpconfig-endpoint

Type:string
authorizationConfig

CfnDataSource.HttpConfigProperty.AuthorizationConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig.html#cfn-appsync-datasource-httpconfig-authorizationconfig

Type:@aws-cdk/cdk.Token or AuthorizationConfigProperty (optional)
class LambdaConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource.LambdaConfigProperty;
// CfnDataSource.LambdaConfigProperty is an interface
import { CfnDataSource.LambdaConfigProperty } from '@aws-cdk/aws-appsync';
lambdaFunctionArn

CfnDataSource.LambdaConfigProperty.LambdaFunctionArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-lambdaconfig.html#cfn-appsync-datasource-lambdaconfig-lambdafunctionarn

Type:string
class RdsHttpEndpointConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource.RdsHttpEndpointConfigProperty;
// CfnDataSource.RdsHttpEndpointConfigProperty is an interface
import { CfnDataSource.RdsHttpEndpointConfigProperty } from '@aws-cdk/aws-appsync';
awsRegion

CfnDataSource.RdsHttpEndpointConfigProperty.AwsRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-awsregion

Type:string
awsSecretStoreArn

CfnDataSource.RdsHttpEndpointConfigProperty.AwsSecretStoreArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-awssecretstorearn

Type:string
dbClusterIdentifier

CfnDataSource.RdsHttpEndpointConfigProperty.DbClusterIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-dbclusteridentifier

Type:string
databaseName

CfnDataSource.RdsHttpEndpointConfigProperty.DatabaseName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-databasename

Type:string (optional)
schema

CfnDataSource.RdsHttpEndpointConfigProperty.Schema

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-schema

Type:string (optional)
class RelationalDatabaseConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSource.RelationalDatabaseConfigProperty;
// CfnDataSource.RelationalDatabaseConfigProperty is an interface
import { CfnDataSource.RelationalDatabaseConfigProperty } from '@aws-cdk/aws-appsync';
relationalDatabaseSourceType

CfnDataSource.RelationalDatabaseConfigProperty.RelationalDatabaseSourceType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-relationaldatabaseconfig.html#cfn-appsync-datasource-relationaldatabaseconfig-relationaldatabasesourcetype

Type:string
rdsHttpEndpointConfig

CfnDataSource.RelationalDatabaseConfigProperty.RdsHttpEndpointConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-relationaldatabaseconfig.html#cfn-appsync-datasource-relationaldatabaseconfig-rdshttpendpointconfig

Type:@aws-cdk/cdk.Token or RdsHttpEndpointConfigProperty (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDataSourceProps (interface)

class @aws-cdk/aws-appsync.CfnDataSourceProps

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnDataSourceProps;
// CfnDataSourceProps is an interface
import { CfnDataSourceProps } from '@aws-cdk/aws-appsync';
apiId

AWS::AppSync::DataSource.ApiId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-apiid

Type:string
name

AWS::AppSync::DataSource.Name

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

Type:string
type

AWS::AppSync::DataSource.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-type

Type:string
description

AWS::AppSync::DataSource.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description

Type:string (optional)
dynamoDbConfig

AWS::AppSync::DataSource.DynamoDBConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-dynamodbconfig

Type:@aws-cdk/cdk.Token or DynamoDBConfigProperty (optional)
elasticsearchConfig

AWS::AppSync::DataSource.ElasticsearchConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-elasticsearchconfig

Type:@aws-cdk/cdk.Token or ElasticsearchConfigProperty (optional)
httpConfig

AWS::AppSync::DataSource.HttpConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-httpconfig

Type:@aws-cdk/cdk.Token or HttpConfigProperty (optional)
lambdaConfig

AWS::AppSync::DataSource.LambdaConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-lambdaconfig

Type:@aws-cdk/cdk.Token or LambdaConfigProperty (optional)
relationalDatabaseConfig

AWS::AppSync::DataSource.RelationalDatabaseConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-relationaldatabaseconfig

Type:@aws-cdk/cdk.Token or RelationalDatabaseConfigProperty (optional)
serviceRoleArn

AWS::AppSync::DataSource.ServiceRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn

Type:string (optional)

CfnFunctionConfiguration

class @aws-cdk/aws-appsync.CfnFunctionConfiguration(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnFunctionConfiguration;
const { CfnFunctionConfiguration } = require('@aws-cdk/aws-appsync');
import { CfnFunctionConfiguration } from '@aws-cdk/aws-appsync';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
functionConfigurationArn
Type:string (readonly)
functionConfigurationDataSourceName
Type:string (readonly)
functionConfigurationFunctionArn
Type:string (readonly)
functionConfigurationFunctionId
Type:string (readonly)
functionConfigurationName
Type:string (readonly)
propertyOverrides
Type:CfnFunctionConfigurationProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnFunctionConfigurationProps (interface)

class @aws-cdk/aws-appsync.CfnFunctionConfigurationProps

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnFunctionConfigurationProps;
// CfnFunctionConfigurationProps is an interface
import { CfnFunctionConfigurationProps } from '@aws-cdk/aws-appsync';
apiId

AWS::AppSync::FunctionConfiguration.ApiId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-apiid

Type:string
dataSourceName

AWS::AppSync::FunctionConfiguration.DataSourceName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-datasourcename

Type:string (optional)
description

AWS::AppSync::FunctionConfiguration.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-description

Type:string (optional)
functionVersion

AWS::AppSync::FunctionConfiguration.FunctionVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-functionversion

Type:string (optional)
name

AWS::AppSync::FunctionConfiguration.Name

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

Type:string (optional)
requestMappingTemplate

AWS::AppSync::FunctionConfiguration.RequestMappingTemplate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-requestmappingtemplate

Type:string (optional)
requestMappingTemplateS3Location

AWS::AppSync::FunctionConfiguration.RequestMappingTemplateS3Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-requestmappingtemplates3location

Type:string (optional)
responseMappingTemplate

AWS::AppSync::FunctionConfiguration.ResponseMappingTemplate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-responsemappingtemplate

Type:string (optional)
responseMappingTemplateS3Location

AWS::AppSync::FunctionConfiguration.ResponseMappingTemplateS3Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-responsemappingtemplates3location

Type:string (optional)

CfnGraphQLApi

class @aws-cdk/aws-appsync.CfnGraphQLApi(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnGraphQLApi;
const { CfnGraphQLApi } = require('@aws-cdk/aws-appsync');
import { CfnGraphQLApi } from '@aws-cdk/aws-appsync';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
graphQlApiApiId
Type:string (readonly)
graphQlApiArn
Type:string (readonly)
graphQlApiGraphQlUrl
Type:string (readonly)
propertyOverrides
Type:CfnGraphQLApiProps (readonly)
class LogConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnGraphQLApi.LogConfigProperty;
// CfnGraphQLApi.LogConfigProperty is an interface
import { CfnGraphQLApi.LogConfigProperty } from '@aws-cdk/aws-appsync';
cloudWatchLogsRoleArn

CfnGraphQLApi.LogConfigProperty.CloudWatchLogsRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-cloudwatchlogsrolearn

Type:string (optional)
fieldLogLevel

CfnGraphQLApi.LogConfigProperty.FieldLogLevel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-fieldloglevel

Type:string (optional)
class OpenIDConnectConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnGraphQLApi.OpenIDConnectConfigProperty;
// CfnGraphQLApi.OpenIDConnectConfigProperty is an interface
import { CfnGraphQLApi.OpenIDConnectConfigProperty } from '@aws-cdk/aws-appsync';
authTtl

CfnGraphQLApi.OpenIDConnectConfigProperty.AuthTTL

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-authttl

Type:number or @aws-cdk/cdk.Token (optional)
clientId

CfnGraphQLApi.OpenIDConnectConfigProperty.ClientId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-clientid

Type:string (optional)
iatTtl

CfnGraphQLApi.OpenIDConnectConfigProperty.IatTTL

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-iatttl

Type:number or @aws-cdk/cdk.Token (optional)
issuer

CfnGraphQLApi.OpenIDConnectConfigProperty.Issuer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-issuer

Type:string (optional)
class UserPoolConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnGraphQLApi.UserPoolConfigProperty;
// CfnGraphQLApi.UserPoolConfigProperty is an interface
import { CfnGraphQLApi.UserPoolConfigProperty } from '@aws-cdk/aws-appsync';
appIdClientRegex

CfnGraphQLApi.UserPoolConfigProperty.AppIdClientRegex

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-appidclientregex

Type:string (optional)
awsRegion

CfnGraphQLApi.UserPoolConfigProperty.AwsRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-awsregion

Type:string (optional)
defaultAction

CfnGraphQLApi.UserPoolConfigProperty.DefaultAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-defaultaction

Type:string (optional)
userPoolId

CfnGraphQLApi.UserPoolConfigProperty.UserPoolId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-userpoolid

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnGraphQLApiProps (interface)

class @aws-cdk/aws-appsync.CfnGraphQLApiProps

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnGraphQLApiProps;
// CfnGraphQLApiProps is an interface
import { CfnGraphQLApiProps } from '@aws-cdk/aws-appsync';
authenticationType

AWS::AppSync::GraphQLApi.AuthenticationType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-authenticationtype

Type:string
name

AWS::AppSync::GraphQLApi.Name

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

Type:string
logConfig

AWS::AppSync::GraphQLApi.LogConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-logconfig

Type:@aws-cdk/cdk.Token or LogConfigProperty (optional)
openIdConnectConfig

AWS::AppSync::GraphQLApi.OpenIDConnectConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig

Type:@aws-cdk/cdk.Token or OpenIDConnectConfigProperty (optional)
userPoolConfig

AWS::AppSync::GraphQLApi.UserPoolConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig

Type:@aws-cdk/cdk.Token or UserPoolConfigProperty (optional)

CfnGraphQLSchema

class @aws-cdk/aws-appsync.CfnGraphQLSchema(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnGraphQLSchema;
const { CfnGraphQLSchema } = require('@aws-cdk/aws-appsync');
import { CfnGraphQLSchema } from '@aws-cdk/aws-appsync';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
graphQlSchemaId
Type:string (readonly)
propertyOverrides
Type:CfnGraphQLSchemaProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnGraphQLSchemaProps (interface)

class @aws-cdk/aws-appsync.CfnGraphQLSchemaProps

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnGraphQLSchemaProps;
// CfnGraphQLSchemaProps is an interface
import { CfnGraphQLSchemaProps } from '@aws-cdk/aws-appsync';
apiId

AWS::AppSync::GraphQLSchema.ApiId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-apiid

Type:string
definition

AWS::AppSync::GraphQLSchema.Definition

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definition

Type:string (optional)
definitionS3Location

AWS::AppSync::GraphQLSchema.DefinitionS3Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definitions3location

Type:string (optional)

CfnResolver

class @aws-cdk/aws-appsync.CfnResolver(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnResolver;
const { CfnResolver } = require('@aws-cdk/aws-appsync');
import { CfnResolver } from '@aws-cdk/aws-appsync';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnResolverProps (readonly)
resolverArn
Type:string (readonly)
resolverFieldName
Type:string (readonly)
resolverTypeName
Type:string (readonly)
class PipelineConfigProperty

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnResolver.PipelineConfigProperty;
// CfnResolver.PipelineConfigProperty is an interface
import { CfnResolver.PipelineConfigProperty } from '@aws-cdk/aws-appsync';
functions

CfnResolver.PipelineConfigProperty.Functions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-pipelineconfig.html#cfn-appsync-resolver-pipelineconfig-functions

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnResolverProps (interface)

class @aws-cdk/aws-appsync.CfnResolverProps

Language-specific names:

using Amazon.CDK.AWS.AppSync;
import software.amazon.awscdk.services.appsync.CfnResolverProps;
// CfnResolverProps is an interface
import { CfnResolverProps } from '@aws-cdk/aws-appsync';
apiId

AWS::AppSync::Resolver.ApiId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-apiid

Type:string
fieldName

AWS::AppSync::Resolver.FieldName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-fieldname

Type:string
typeName

AWS::AppSync::Resolver.TypeName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-typename

Type:string
dataSourceName

AWS::AppSync::Resolver.DataSourceName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-datasourcename

Type:string (optional)
kind

AWS::AppSync::Resolver.Kind

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-kind

Type:string (optional)
pipelineConfig

AWS::AppSync::Resolver.PipelineConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-pipelineconfig

Type:@aws-cdk/cdk.Token or PipelineConfigProperty (optional)
requestMappingTemplate

AWS::AppSync::Resolver.RequestMappingTemplate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-requestmappingtemplate

Type:string (optional)
requestMappingTemplateS3Location

AWS::AppSync::Resolver.RequestMappingTemplateS3Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-requestmappingtemplates3location

Type:string (optional)
responseMappingTemplate

AWS::AppSync::Resolver.ResponseMappingTemplate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-responsemappingtemplate

Type:string (optional)
responseMappingTemplateS3Location

AWS::AppSync::Resolver.ResponseMappingTemplateS3Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-responsemappingtemplates3location

Type:string (optional)