Interface CustomResourceProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.003Z") @Stability(Stable) public interface CustomResourceProps extends
Properties to provide a Lambda-backed custom resource.


 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

    • getServiceToken

      @Stability(Stable) @NotNull String getServiceToken()
      The ARN of the provider which implements this custom resource type.

      You can implement a provider by listening to raw AWS CloudFormation events and specify the ARN of an SNS topic (topic.topicArn) or the ARN of an AWS Lambda function (lambda.functionArn) or use the CDK's custom resource provider framework which makes it easier to implement robust providers.

      Provider framework:

       // use the provider framework from aws-cdk/custom-resources:
       Provider provider = Provider.Builder.create(this, "ResourceProvider")
       CustomResource.Builder.create(this, "MyResource")

      AWS Lambda function:

       // invoke an AWS Lambda function when a lifecycle event occurs:
       // invoke an AWS Lambda function when a lifecycle event occurs:
       CustomResource.Builder.create(this, "MyResource")

      SNS topic:

       // publish lifecycle events to an SNS topic:
       // publish lifecycle events to an SNS topic:
       CustomResource.Builder.create(this, "MyResource")
    • getPascalCaseProperties

      @Stability(Stable) @Nullable default Boolean getPascalCaseProperties()
      Convert all property keys to pascal case.

      Default: false

    • getProperties

      @Stability(Stable) @Nullable default Map<String,Object> getProperties()
      Properties to pass to the Lambda.

      Default: - No properties.

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      The policy to apply when this resource is removed from the application.

      Default: cdk.RemovalPolicy.Destroy

    • getResourceType

      @Stability(Stable) @Nullable default String getResourceType()
      For custom resources, you can specify AWS::CloudFormation::CustomResource (the default) as the resource type, or you can specify your own resource type name.

      For example, you can use "Custom::MyCustomResourceTypeName".

      Custom resource type names must begin with "Custom::" and can include alphanumeric characters and the following characters: _@-. You can specify a custom resource type name up to a maximum length of 60 characters. You cannot change the type during an update.

      Using your own resource type names helps you quickly differentiate the types of custom resources in your stack. For example, if you had two custom resources that conduct two different ping tests, you could name their type as Custom::PingTester to make them easily identifiable as ping testers (instead of using AWS::CloudFormation::CustomResource).

      Default: - AWS::CloudFormation::CustomResource

      See Also:
    • builder

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