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-serverless

AWS Serverless Construct Library

const serverless = require('@aws-cdk/aws-serverless');

Reference

View in Nuget

csproj:

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

dotnet:

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

packages.config:

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

View in Maven Central

Apache Buildr:

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

Apache Ivy:

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

Apache Maven:

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

Gradle / Grails:

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

Groovy Grape:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

CfnApi

class @aws-cdk/aws-serverless.CfnApi(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnApi;
const { CfnApi } = require('@aws-cdk/aws-serverless');
import { CfnApi } from '@aws-cdk/aws-serverless';
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
requiredTransform

The Transform a template must use in order to use this resource

Type:string (readonly) (static)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
apiName
Type:string (readonly)
propertyOverrides
Type:CfnApiProps (readonly)
class AuthProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnApi.AuthProperty;
// CfnApi.AuthProperty is an interface
import { CfnApi.AuthProperty } from '@aws-cdk/aws-serverless';
authorizers

CfnApi.AuthProperty.Authorizers

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api-auth-object

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

CfnApi.AuthProperty.DefaultAuthorizer

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api-auth-object

Type:string (optional)
class S3LocationProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnApi.S3LocationProperty;
// CfnApi.S3LocationProperty is an interface
import { CfnApi.S3LocationProperty } from '@aws-cdk/aws-serverless';
bucket

CfnApi.S3LocationProperty.Bucket

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string
key

CfnApi.S3LocationProperty.Key

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string
version

CfnApi.S3LocationProperty.Version

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:number or @aws-cdk/cdk.Token
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)

CfnApiProps (interface)

class @aws-cdk/aws-serverless.CfnApiProps

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnApiProps;
// CfnApiProps is an interface
import { CfnApiProps } from '@aws-cdk/aws-serverless';
stageName

AWS::Serverless::Api.StageName

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Type:string
auth

AWS::Serverless::Api.Auth

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

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

AWS::Serverless::Api.BinaryMediaTypes

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

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

AWS::Serverless::Api.CacheClusterEnabled

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

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

AWS::Serverless::Api.CacheClusterSize

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Type:string (optional)
cors

AWS::Serverless::Api.Cors

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Type:string (optional)
definitionBody

AWS::Serverless::Api.DefinitionBody

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

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

AWS::Serverless::Api.DefinitionUri

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Type:string or @aws-cdk/cdk.Token or S3LocationProperty (optional)
endpointConfiguration

AWS::Serverless::Api.EndpointConfiguration

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Type:string (optional)
methodSettings

AWS::Serverless::Api.MethodSettings

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

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

AWS::Serverless::Api.Name

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Type:string (optional)
variables

AWS::Serverless::Api.Variables

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)

CfnApplication

class @aws-cdk/aws-serverless.CfnApplication(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnApplication;
const { CfnApplication } = require('@aws-cdk/aws-serverless');
import { CfnApplication } from '@aws-cdk/aws-serverless';
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
requiredTransform

The Transform a template must use in order to use this resource

Type:string (readonly) (static)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
applicationName
Type:string (readonly)
propertyOverrides
Type:CfnApplicationProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class ApplicationLocationProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnApplication.ApplicationLocationProperty;
// CfnApplication.ApplicationLocationProperty is an interface
import { CfnApplication.ApplicationLocationProperty } from '@aws-cdk/aws-serverless';
applicationId

CfnApplication.ApplicationLocationProperty.ApplicationId

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapplication

Type:string
semanticVersion

CfnApplication.ApplicationLocationProperty.SemanticVersion

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapplication

Type:string
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)

CfnApplicationProps (interface)

class @aws-cdk/aws-serverless.CfnApplicationProps

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnApplicationProps;
// CfnApplicationProps is an interface
import { CfnApplicationProps } from '@aws-cdk/aws-serverless';
location

AWS::Serverless::Application.Location

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapplication

Type:string or @aws-cdk/cdk.Token or ApplicationLocationProperty
notificationArns

AWS::Serverless::Application.NotificationArns

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapplication

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

AWS::Serverless::Application.Parameters

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapplication

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
tags

AWS::Serverless::Application.Tags

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapplication

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
timeoutInMinutes

AWS::Serverless::Application.TimeoutInMinutes

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapplication

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

CfnFunction

class @aws-cdk/aws-serverless.CfnFunction(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction;
const { CfnFunction } = require('@aws-cdk/aws-serverless');
import { CfnFunction } from '@aws-cdk/aws-serverless';
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
requiredTransform

The Transform a template must use in order to use this resource

Type:string (readonly) (static)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
functionName
Type:string (readonly)
propertyOverrides
Type:CfnFunctionProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class AlexaSkillEventProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.AlexaSkillEventProperty;
// CfnFunction.AlexaSkillEventProperty is an interface
import { CfnFunction.AlexaSkillEventProperty } from '@aws-cdk/aws-serverless';
variables

CfnFunction.AlexaSkillEventProperty.Variables

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#alexaskill

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
class ApiEventProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.ApiEventProperty;
// CfnFunction.ApiEventProperty is an interface
import { CfnFunction.ApiEventProperty } from '@aws-cdk/aws-serverless';
method

CfnFunction.ApiEventProperty.Method

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

Type:string
path

CfnFunction.ApiEventProperty.Path

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

Type:string
restApiId

CfnFunction.ApiEventProperty.RestApiId

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

Type:string (optional)
class CloudWatchEventEventProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.CloudWatchEventEventProperty;
// CfnFunction.CloudWatchEventEventProperty is an interface
import { CfnFunction.CloudWatchEventEventProperty } from '@aws-cdk/aws-serverless';
pattern

CfnFunction.CloudWatchEventEventProperty.Pattern

http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html

Type:json or @aws-cdk/cdk.Token
input

CfnFunction.CloudWatchEventEventProperty.Input

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cloudwatchevent

Type:string (optional)
inputPath

CfnFunction.CloudWatchEventEventProperty.InputPath

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cloudwatchevent

Type:string (optional)
class DeadLetterQueueProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.DeadLetterQueueProperty;
// CfnFunction.DeadLetterQueueProperty is an interface
import { CfnFunction.DeadLetterQueueProperty } from '@aws-cdk/aws-serverless';
targetArn

CfnFunction.DeadLetterQueueProperty.TargetArn

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string
type

CfnFunction.DeadLetterQueueProperty.Type

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string
class DeploymentPreferenceProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.DeploymentPreferenceProperty;
// CfnFunction.DeploymentPreferenceProperty is an interface
import { CfnFunction.DeploymentPreferenceProperty } from '@aws-cdk/aws-serverless';
enabled

CfnFunction.DeploymentPreferenceProperty.Enabled

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

Type:boolean or @aws-cdk/cdk.Token
type

CfnFunction.DeploymentPreferenceProperty.Type

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

Type:string
alarms

CfnFunction.DeploymentPreferenceProperty.Alarms

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

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

CfnFunction.DeploymentPreferenceProperty.Hooks

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

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

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.DynamoDBEventProperty;
// CfnFunction.DynamoDBEventProperty is an interface
import { CfnFunction.DynamoDBEventProperty } from '@aws-cdk/aws-serverless';
batchSize

CfnFunction.DynamoDBEventProperty.BatchSize

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb

Type:number or @aws-cdk/cdk.Token
startingPosition

CfnFunction.DynamoDBEventProperty.StartingPosition

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb

Type:string
stream

CfnFunction.DynamoDBEventProperty.Stream

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb

Type:string
class EventSourceProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.EventSourceProperty;
// CfnFunction.EventSourceProperty is an interface
import { CfnFunction.EventSourceProperty } from '@aws-cdk/aws-serverless';
properties

CfnFunction.EventSourceProperty.Properties

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#event-source-types

Type:@aws-cdk/cdk.Token or AlexaSkillEventProperty or ApiEventProperty or CloudWatchEventEventProperty or DynamoDBEventProperty or S3EventProperty or SNSEventProperty or SQSEventProperty or KinesisEventProperty or ScheduleEventProperty or IoTRuleEventProperty
type

CfnFunction.EventSourceProperty.Type

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#event-source-object

Type:string
class FunctionEnvironmentProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.FunctionEnvironmentProperty;
// CfnFunction.FunctionEnvironmentProperty is an interface
import { CfnFunction.FunctionEnvironmentProperty } from '@aws-cdk/aws-serverless';
variables

CfnFunction.FunctionEnvironmentProperty.Variables

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#environment-object

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token)
class IAMPolicyDocumentProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.IAMPolicyDocumentProperty;
// CfnFunction.IAMPolicyDocumentProperty is an interface
import { CfnFunction.IAMPolicyDocumentProperty } from '@aws-cdk/aws-serverless';
statement

CfnFunction.IAMPolicyDocumentProperty.Statement

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html

Type:json or @aws-cdk/cdk.Token
class IoTRuleEventProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.IoTRuleEventProperty;
// CfnFunction.IoTRuleEventProperty is an interface
import { CfnFunction.IoTRuleEventProperty } from '@aws-cdk/aws-serverless';
sql

CfnFunction.IoTRuleEventProperty.Sql

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#iotrule

Type:string
awsIotSqlVersion

CfnFunction.IoTRuleEventProperty.AwsIotSqlVersion

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#iotrule

Type:string (optional)
class KinesisEventProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.KinesisEventProperty;
// CfnFunction.KinesisEventProperty is an interface
import { CfnFunction.KinesisEventProperty } from '@aws-cdk/aws-serverless';
startingPosition

CfnFunction.KinesisEventProperty.StartingPosition

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis

Type:string
stream

CfnFunction.KinesisEventProperty.Stream

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis

Type:string
batchSize

CfnFunction.KinesisEventProperty.BatchSize

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis

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

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.S3EventProperty;
// CfnFunction.S3EventProperty is an interface
import { CfnFunction.S3EventProperty } from '@aws-cdk/aws-serverless';
bucket

CfnFunction.S3EventProperty.Bucket

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3

Type:string
events

CfnFunction.S3EventProperty.Events

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3

Type:string or @aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
filter

CfnFunction.S3EventProperty.Filter

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3

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

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.S3LocationProperty;
// CfnFunction.S3LocationProperty is an interface
import { CfnFunction.S3LocationProperty } from '@aws-cdk/aws-serverless';
bucket

CfnFunction.S3LocationProperty.Bucket

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string
key

CfnFunction.S3LocationProperty.Key

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string
version

CfnFunction.S3LocationProperty.Version

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.S3NotificationFilterProperty;
// CfnFunction.S3NotificationFilterProperty is an interface
import { CfnFunction.S3NotificationFilterProperty } from '@aws-cdk/aws-serverless';
s3Key

CfnFunction.S3NotificationFilterProperty.S3Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html

Type:string
class SNSEventProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.SNSEventProperty;
// CfnFunction.SNSEventProperty is an interface
import { CfnFunction.SNSEventProperty } from '@aws-cdk/aws-serverless';
topic

CfnFunction.SNSEventProperty.Topic

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#sns

Type:string
class SQSEventProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.SQSEventProperty;
// CfnFunction.SQSEventProperty is an interface
import { CfnFunction.SQSEventProperty } from '@aws-cdk/aws-serverless';
queue

CfnFunction.SQSEventProperty.Queue

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#sqs

Type:string
batchSize

CfnFunction.SQSEventProperty.BatchSize

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#sqs

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

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.ScheduleEventProperty;
// CfnFunction.ScheduleEventProperty is an interface
import { CfnFunction.ScheduleEventProperty } from '@aws-cdk/aws-serverless';
schedule

CfnFunction.ScheduleEventProperty.Schedule

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#schedule

Type:string
input

CfnFunction.ScheduleEventProperty.Input

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#schedule

Type:string (optional)
class VpcConfigProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunction.VpcConfigProperty;
// CfnFunction.VpcConfigProperty is an interface
import { CfnFunction.VpcConfigProperty } from '@aws-cdk/aws-serverless';
securityGroupIds

CfnFunction.VpcConfigProperty.SecurityGroupIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
subnetIds

CfnFunction.VpcConfigProperty.SubnetIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
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)

CfnFunctionProps (interface)

class @aws-cdk/aws-serverless.CfnFunctionProps

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnFunctionProps;
// CfnFunctionProps is an interface
import { CfnFunctionProps } from '@aws-cdk/aws-serverless';
codeUri

AWS::Serverless::Function.CodeUri

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string or @aws-cdk/cdk.Token or S3LocationProperty
handler

AWS::Serverless::Function.Handler

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string
runtime

AWS::Serverless::Function.Runtime

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string
autoPublishAlias

AWS::Serverless::Function.AutoPublishAlias

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string (optional)
deadLetterQueue

AWS::Serverless::Function.DeadLetterQueue

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

AWS::Serverless::Function.DeploymentPreference

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

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

AWS::Serverless::Function.Description

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string (optional)
environment

AWS::Serverless::Function.Environment

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

AWS::Serverless::Function.Events

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:@aws-cdk/cdk.Token or string => (@aws-cdk/cdk.Token or EventSourceProperty) (optional)
functionName

AWS::Serverless::Function.FunctionName

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string (optional)
kmsKeyArn

AWS::Serverless::Function.KmsKeyArn

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string (optional)
layers

AWS::Serverless::Function.Layers

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

AWS::Serverless::Function.MemorySize

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

AWS::Serverless::Function.Policies

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

AWS::Serverless::Function.ReservedConcurrentExecutions

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

AWS::Serverless::Function.Role

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string (optional)
tags

AWS::Serverless::Function.Tags

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
timeout

AWS::Serverless::Function.Timeout

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

AWS::Serverless::Function.Tracing

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

Type:string (optional)
vpcConfig

AWS::Serverless::Function.VpcConfig

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction

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

CfnLayerVersion

class @aws-cdk/aws-serverless.CfnLayerVersion(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnLayerVersion;
const { CfnLayerVersion } = require('@aws-cdk/aws-serverless');
import { CfnLayerVersion } from '@aws-cdk/aws-serverless';
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
requiredTransform

The Transform a template must use in order to use this resource

Type:string (readonly) (static)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
layerVersionArn
Type:string (readonly)
propertyOverrides
Type:CfnLayerVersionProps (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)

CfnLayerVersionProps (interface)

class @aws-cdk/aws-serverless.CfnLayerVersionProps

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnLayerVersionProps;
// CfnLayerVersionProps is an interface
import { CfnLayerVersionProps } from '@aws-cdk/aws-serverless';
compatibleRuntimes

AWS::Serverless::LayerVersion.CompatibleRuntimes

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesslayerversion

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

AWS::Serverless::LayerVersion.ContentUri

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesslayerversion

Type:string (optional)
description

AWS::Serverless::LayerVersion.Description

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesslayerversion

Type:string (optional)
layerName

AWS::Serverless::LayerVersion.LayerName

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesslayerversion

Type:string (optional)
licenseInfo

AWS::Serverless::LayerVersion.LicenseInfo

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesslayerversion

Type:string (optional)
retentionPolicy

AWS::Serverless::LayerVersion.RetentionPolicy

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesslayerversion

Type:string (optional)

CfnSimpleTable

class @aws-cdk/aws-serverless.CfnSimpleTable(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnSimpleTable;
const { CfnSimpleTable } = require('@aws-cdk/aws-serverless');
import { CfnSimpleTable } from '@aws-cdk/aws-serverless';
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
requiredTransform

The Transform a template must use in order to use this resource

Type:string (readonly) (static)
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnSimpleTableProps (readonly)
simpleTableName
Type:string (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class PrimaryKeyProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnSimpleTable.PrimaryKeyProperty;
// CfnSimpleTable.PrimaryKeyProperty is an interface
import { CfnSimpleTable.PrimaryKeyProperty } from '@aws-cdk/aws-serverless';
type

CfnSimpleTable.PrimaryKeyProperty.Type

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#primary-key-object

Type:string
name

CfnSimpleTable.PrimaryKeyProperty.Name

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#primary-key-object

Type:string (optional)
class ProvisionedThroughputProperty

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnSimpleTable.ProvisionedThroughputProperty;
// CfnSimpleTable.ProvisionedThroughputProperty is an interface
import { CfnSimpleTable.ProvisionedThroughputProperty } from '@aws-cdk/aws-serverless';
writeCapacityUnits

CfnSimpleTable.ProvisionedThroughputProperty.WriteCapacityUnits

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html

Type:number or @aws-cdk/cdk.Token
readCapacityUnits

CfnSimpleTable.ProvisionedThroughputProperty.ReadCapacityUnits

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html

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

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnSimpleTable.SSESpecificationProperty;
// CfnSimpleTable.SSESpecificationProperty is an interface
import { CfnSimpleTable.SSESpecificationProperty } from '@aws-cdk/aws-serverless';
sseEnabled

CfnSimpleTable.SSESpecificationProperty.SSEEnabled

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html

Type:boolean 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)

CfnSimpleTableProps (interface)

class @aws-cdk/aws-serverless.CfnSimpleTableProps

Language-specific names:

using Amazon.CDK.AWS.Serverless;
import software.amazon.awscdk.services.serverless.CfnSimpleTableProps;
// CfnSimpleTableProps is an interface
import { CfnSimpleTableProps } from '@aws-cdk/aws-serverless';
primaryKey

AWS::Serverless::SimpleTable.PrimaryKey

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#primary-key-object

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

AWS::Serverless::SimpleTable.ProvisionedThroughput

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html

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

AWS::Serverless::SimpleTable.SSESpecification

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesssimpletable

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

AWS::Serverless::SimpleTable.TableName

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesssimpletable

Type:string (optional)
tags

AWS::Serverless::SimpleTable.Tags

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesssimpletable

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)