Package software.amazon.awscdk

Interface CustomResourceProviderProps

All Superinterfaces:

CustomResourceProviderOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomResourceProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:43.827Z")
@Stability(Stable)
public interface CustomResourceProviderProps
extends software.amazon.jsii.JsiiSerializable, CustomResourceProviderOptions

Initialization properties for CustomResourceProvider.

Example:

 CustomResourceProvider provider = CustomResourceProvider.getOrCreateProvider(this, "Custom::MyCustomResourceType", CustomResourceProviderProps.builder()
         .codeDirectory(String.format("%s/my-handler", __dirname))
         .runtime(CustomResourceProviderRuntime.NODEJS_18_X)
         .build());
 provider.addToRolePolicy(Map.of(
         "Effect", "Allow",
         "Action", "s3:GetObject",
         "Resource", "*"));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CustomResourceProviderProps.Builder	A builder for CustomResourceProviderProps
static final class	CustomResourceProviderProps.Jsii$Proxy	An implementation for CustomResourceProviderProps

Method Summary

Modifier and Type	Method	Description
static CustomResourceProviderProps.Builder	builder()
String	getCodeDirectory()	A local file system directory with the provider's code.
CustomResourceProviderRuntime	getRuntime()	The AWS Lambda runtime and version to use for the provider.

Methods inherited from interface software.amazon.awscdk.CustomResourceProviderOptions

getDescription, getEnvironment, getMemorySize, getPolicyStatements, getTimeout, getUseCfnResponseWrapper

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCodeDirectory

@Stability(Stable)
@NotNull
String getCodeDirectory()

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.

getRuntime

@Stability(Stable)
@NotNull
CustomResourceProviderRuntime getRuntime()

The AWS Lambda runtime and version to use for the provider.

builder

@Stability(Stable)
static CustomResourceProviderProps.Builder builder()

Returns:

a CustomResourceProviderProps.Builder of CustomResourceProviderProps