Skip to main content

Constructs for implementing CDK custom resources

Project description

CDK Custom Resources

Stability: Experimental

This is a developer preview (public beta) module. Releases might lack important features and might have future breaking changes.

This API is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the API is not recommended in production environments. Experimental APIs are not subject to the Semantic Versioning model.

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

AWS Custom Resource

Sometimes a single API call can fill the gap in the CloudFormation coverage. In this case you can use the AwsCustomResource construct. This construct creates a custom resource that can be customized to make specific API calls for the CREATE, UPDATE and DELETE events. Additionally, data returned by the API call can be extracted and used in other constructs/resources (creating a real CloudFormation dependency using Fn::GetAtt under the hood).

The physical id of the custom resource can be specified or derived from the data returned by the API call.

The AwsCustomResource uses the AWS SDK for JavaScript. Services, actions and parameters can be found in the API documentation.

Path to data must be specified using a dot notation, e.g. to get the string value of the Title attribute for the first item returned by dynamodb.query it should be Items.0.Title.S.


Verify a domain with SES:

const verifyDomainIdentity = new AwsCustomResource(this, 'VerifyDomainIdentity', {
  onCreate: {
    service: 'SES',
    action: 'verifyDomainIdentity',
    parameters: {
      Domain: ''
    physicalResourceIdPath: 'VerificationToken' // Use the token returned by the call as physical id

new route53.TxtRecord(zone, 'SESVerificationRecord', {
  recordName: ``,
  recordValue: verifyDomainIdentity.getData('VerificationToken')

Get the latest version of a secure SSM parameter:

const getParameter = new AwsCustomResource(this, 'GetParameter', {
  onUpdate: { // will also be called for a CREATE event
    service: 'SSM',
    action: 'getParameter',
    parameters: {
      Name: 'my-parameter',
      WithDecryption: true
    physicalResourceId: // Update physical id to always fetch the latest version

// Use the value in another construct with

IAM policy statements required to make the API calls are derived from the calls and allow by default the actions to be made on all resources (*). You can restrict the permissions by specifying your own list of statements with the policyStatements prop.

Chained API calls can be achieved by creating dependencies:

const awsCustom1 = new AwsCustomResource(this, 'API1', {
  onCreate: {
    service: '...',
    action: '...',
    physicalResourceId: '...'

const awsCustom2 = new AwsCustomResource(this, 'API2', {
  onCreate: {
    service: '...',
    action: '...'
    parameters: {
      text: awsCustom1.getData('Items.0.text')
    physicalResourceId: '...'

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
aws_cdk.custom_resources-1.0.0-py3-none-any.whl (41.7 kB) Copy SHA256 hash SHA256 Wheel py3
aws-cdk.custom-resources-1.0.0.tar.gz (42.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page