Skip to content
v2.277.0

CustomResourceProviderProps Struct ​

Initialization properties for CustomResourceProvider.

Example ​

ts
const provider = CustomResourceProvider.getOrCreateProvider(this, 'Custom::MyCustomResourceType', {
  codeDirectory: `${__dirname}/my-handler`,
  runtime: CustomResourceProviderRuntime.NODEJS_22_X,
});
provider.addToRolePolicy({
  Effect: 'Allow',
  Action: 's3:GetObject',
  Resource: '*',
})
python
provider = CustomResourceProvider.get_or_create_provider(self, "Custom::MyCustomResourceType",
    code_directory=f"{__dirname}/my-handler",
    runtime=CustomResourceProviderRuntime.NODEJS_22_X
)
provider.add_to_role_policy({
    "Effect": "Allow",
    "Action": "s3:GetObject",
    "Resource": "*"
})
java
CustomResourceProvider provider = CustomResourceProvider.getOrCreateProvider(this, "Custom::MyCustomResourceType", CustomResourceProviderProps.builder()
        .codeDirectory(String.format("%s/my-handler", __dirname))
        .runtime(CustomResourceProviderRuntime.NODEJS_22_X)
        .build());
provider.addToRolePolicy(Map.of(
        "Effect", "Allow",
        "Action", "s3:GetObject",
        "Resource", "*"));
csharp
// Install: dotnet add package Amazon.CDK.Lib
var provider = CustomResourceProvider.GetOrCreateProvider(this, "Custom::MyCustomResourceType", new CustomResourceProviderProps {
    CodeDirectory = $"{__dirname}/my-handler",
    Runtime = CustomResourceProviderRuntime.NODEJS_22_X
});
provider.AddToRolePolicy(new Dictionary<string, string> {
    { "Effect", "Allow" },
    { "Action", "s3:GetObject" },
    { "Resource", "*" }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
provider := awscdk.CustomResourceProvider_GetOrCreateProvider(this, jsii.String("Custom::MyCustomResourceType"), &CustomResourceProviderProps{
	CodeDirectory: fmt.Sprintf("%v/my-handler", __dirname),
	Runtime: awscdk.CustomResourceProviderRuntime_NODEJS_22_X,
})
provider.AddToRolePolicy(map[string]*string{
	"Effect": jsii.String("Allow"),
	"Action": jsii.String("s3:GetObject"),
	"Resource": jsii.String("*"),
})

Properties ​

codeDirectorystringcode_directorystrcodeDirectoryStringCodeDirectorystringCodeDirectory*stringrequired#
A local file system directory with the provider's code.

The code will be bundled into a zip asset and wired to the provider's AWS Lambda function.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the function.

Default: No description.

environmentoptional{ [key: string]: string }environmentoptionaltyping.Mapping[str, str]environmentoptionalMap<String, String>EnvironmentoptionalIDictionary<string, string>Environmentoptional*map[string]*string#
Key-value pairs that are passed to Lambda as Environment.

Default: No environment variables.

memorySizeoptionalSizememory_sizeoptionalSizememorySizeoptionalSizeMemorySizeoptionalSizeMemorySizeoptionalSize= Size.mebibytes(128)#
The amount of memory that your function has access to.

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

policyStatementsoptionalany[]policy_statementsoptionaltyping.List[Any]policyStatementsoptionalList<Object>PolicyStatementsoptionalobject[]PolicyStatementsoptional*[]interface{}#
A set of IAM policy statements to include in the inline policy of the provider's lambda function.

Default: no additional inline policy

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: '*',
    }
  ],
});
The AWS Lambda runtime and version to use for the provider.
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Duration.minutes(15)#
AWS Lambda timeout for the provider.
useCfnResponseWrapperoptionalbooleanuse_cfn_response_wrapperoptionalbooluseCfnResponseWrapperoptionalBooleanUseCfnResponseWrapperoptionalboolUseCfnResponseWrapperoptional*bool#
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: true if inlineCode: false and false otherwise.