Interface CustomResourceProviderProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.011Z") @Stability(Stable) public interface CustomResourceProviderProps extends
Initialization properties for CustomResourceProvider.


 String serviceToken = CustomResourceProvider.getOrCreate(this, "Custom::MyCustomResourceType", CustomResourceProviderProps.builder()
         .codeDirectory(String.format("%s/my-handler", __dirname))
         .description("Lambda function created by the custom resource provider")
 CustomResource.Builder.create(this, "MyResource")
  • 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.
    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description of the function.

      Default: - No description.

    • getEnvironment

      @Stability(Stable) @Nullable default Map<String,String> getEnvironment()
      Key-value pairs that are passed to Lambda as Environment.

      Default: - No environment variables.

    • getMemorySize

      @Stability(Stable) @Nullable default Size getMemorySize()
      The amount of memory that your function has access to.

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

      Default: Size.mebibytes(128)

    • getPolicyStatements

      @Stability(Stable) @Nullable default List<Object> getPolicyStatements()
      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.

      Default: - no additional inline policy


       CustomResourceProvider provider = CustomResourceProvider.getOrCreateProvider(this, "Custom::MyCustomResourceType", CustomResourceProviderProps.builder()
               .codeDirectory(String.format("%s/my-handler", __dirname))
                       "Effect", "Allow",
                       "Action", "s3:PutObject*",
                       "Resource", "*")))
    • getTimeout

      @Stability(Stable) @Nullable default Duration getTimeout()
      AWS Lambda timeout for the provider.

      Default: Duration.minutes(15)

    • builder

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