AWS CDK Reference

Appearance

v2.273.0

CustomResourceProviderOptions Struct ​

Initialization options for custom resource providers.

Source
core/lib/custom-resource-provider/shared.ts
Type last changed
v2.116.0 · 22 Dec 2023

Example ​

ts
// 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 ​

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= No description.#
A description of the function.
environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*string= No environment variables.#
Key-value pairs that are passed to Lambda as Environment.
memorySizeSizememory_sizeSizememorySizeSizeMemorySizeSizeMemorySizeSize= Size.mebibytes(128)#
The amount of memory that your function has access to.

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

policyStatementsany[]policy_statementstyping.List[Any]policyStatementsList<Object>PolicyStatementsobject[]PolicyStatements*[]interface{}= 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
ts
const provider = CustomResourceProvider.getOrCreateProvider(this, 'Custom::MyCustomResourceType', {
  codeDirectory: `${__dirname}/my-handler`,
  runtime: CustomResourceProviderRuntime.NODEJS_18_X,
  policyStatements: [
    {
      Effect: 'Allow',
      Action: 's3:PutObject*',
      Resource: '*',
    }
  ],
});
timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Duration.minutes(15)#
AWS Lambda timeout for the provider.
useCfnResponseWrapperbooleanuse_cfn_response_wrapperbooluseCfnResponseWrapperBooleanUseCfnResponseWrapperboolUseCfnResponseWrapper*bool= `true` if `inlineCode: false` an…#
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.
default

Default: true if inlineCode: false and false otherwise.