interface CustomResourceProviderOptions

Language	Type name
.NET	Amazon.CDK.CustomResourceProviderOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2#CustomResourceProviderOptions
Java	software.amazon.awscdk.CustomResourceProviderOptions
Python	aws_cdk.CustomResourceProviderOptions
TypeScript (source)	aws-cdk-lib » CustomResourceProviderOptions

Initialization options for custom resource providers.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';

declare const policyStatements: any;
declare const size: cdk.Size;
const customResourceProviderOptions: cdk.CustomResourceProviderOptions = {
  description: 'description',
  environment: {
    environmentKey: 'environment',
  },
  memorySize: size,
  policyStatements: [policyStatements],
  timeout: cdk.Duration.minutes(30),
  useCfnResponseWrapper: false,
};

Properties

Name	Type	Description
description?	string	A description of the function.
environment?	{ [string]: string }	Key-value pairs that are passed to Lambda as Environment.
memorySize?	Size	The amount of memory that your function has access to.
policyStatements?	any[]	A set of IAM policy statements to include in the inline policy of the provider's lambda function.
timeout?	Duration	AWS Lambda timeout for the provider.
useCfnResponseWrapper?	boolean	Whether or not the cloudformation response wrapper (nodejs-entrypoint.ts) is used. If set to true, nodejs-entrypoint.js is bundled in the same asset as the custom resource and set as the entrypoint. If set to false, the custom resource provided is the entrypoint.

---

description?

Type: string (optional, default: No description.)

A description of the function.

---

environment?

Type: { [string]: string } (optional, default: No environment variables.)

Key-value pairs that are passed to Lambda as Environment.

---

memorySize?

Type: Size (optional, default: Size.mebibytes(128))

The amount of memory that your function has access to.

Increasing the function's memory also increases its CPU allocation.

---

policyStatements?

Type: any[] (optional, default: no additional inline policy)

A set of IAM policy statements to include in the inline policy of the provider's lambda function.

Please note: these are direct IAM JSON policy blobs, not iam.PolicyStatement objects like you will see in the rest of the CDK. Example

const provider = CustomResourceProvider.getOrCreateProvider(this, 'Custom::MyCustomResourceType', {
  codeDirectory: `${__dirname}/my-handler`,
  runtime: CustomResourceProviderRuntime.NODEJS_18_X,
  policyStatements: [
    {
      Effect: 'Allow',
      Action: 's3:PutObject*',
      Resource: '*',
    }
  ],
});

---

timeout?

Type: Duration (optional, default: Duration.minutes(15))

AWS Lambda timeout for the provider.

---

useCfnResponseWrapper?

Type: boolean (optional, default: true if inlineCode: false and false otherwise.)

Whether or not the cloudformation response wrapper (nodejs-entrypoint.ts) is used. If set to true, nodejs-entrypoint.js is bundled in the same asset as the custom resource and set as the entrypoint. If set to false, the custom resource provided is the entrypoint.