API Reference

Modules

The AWS Construct Library is organized into several modules. They are named like this:

• aws-xxx: service package for the indicated service. This package will contain constructs to work with the given service.
• aws-xxx¹: a little superscript 1 indicates that his package only contains CloudFormation Resources (for now).
• aws-xxx-targets: integration package for the indicated service. This package will contain classes to connect the constructs in the "aws-xxx" package to other AWS services it can work with.
• xxx: packages that don't start "aws-" are AWS CDK framework packages.

Module Contents

Modules contain the following types:

• Constructs - All higher-level constructs in this library.
• Other Types - All non-construct classes, interfaces, structs and enums that exist to support the constructs.
• CloudFormation Resources - All constructs that map directly onto CloudFormation Resources. We recommend that you read the CloudFormation Resource and Property Type Reference for details on these resources.
• CloudFormation Property Types - All structs that are used by the CloudFormation Resource constructs.

Constructs take a set of (input) properties in their constructor; the set of properties (and which ones are required) can be seen on a construct's documentation page.

The construct's documentation page also lists the available methods to call and the properties which can be used to retrieve information about the construct after it has been instantiated.

Every type's page has a table at the top with links to language-specific documentation on the type.