@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:45.123Z")
public interface CustomResourceProps
Example:
String serviceToken = CustomResourceProvider.getOrCreate(this, "Custom::MyCustomResourceType", CustomResourceProviderProps.builder() .codeDirectory(String.format("%s/my-handler", __dirname)) .runtime(CustomResourceProviderRuntime.NODEJS_14_X) .description("Lambda function created by the custom resource provider") .build()); CustomResource.Builder.create(this, "MyResource") .resourceType("Custom::MyCustomResourceType") .serviceToken(serviceToken) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CustomResourceProps.Builder
A builder for
CustomResourceProps |
static class |
CustomResourceProps.Jsii$Proxy
An implementation for
CustomResourceProps |
Modifier and Type | Method and Description |
---|---|
static CustomResourceProps.Builder |
builder() |
default java.lang.Boolean |
getPascalCaseProperties()
Convert all property keys to pascal case.
|
default java.util.Map<java.lang.String,java.lang.Object> |
getProperties()
Properties to pass to the Lambda.
|
default RemovalPolicy |
getRemovalPolicy()
The policy to apply when this resource is removed from the application.
|
default java.lang.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.
|
java.lang.String |
getServiceToken()
The ARN of the provider which implements this custom resource type.
|
java.lang.String getServiceToken()
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") .onEventHandler(onEventHandler) .isCompleteHandler(isCompleteHandler) .build(); CustomResource.Builder.create(this, "MyResource") .serviceToken(provider.getServiceToken()) .build();
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") .serviceToken(myFunction.getFunctionArn()) .build();
SNS topic:
// publish lifecycle events to an SNS topic: // publish lifecycle events to an SNS topic: CustomResource.Builder.create(this, "MyResource") .serviceToken(myTopic.getTopicArn()) .build();
default java.lang.Boolean getPascalCaseProperties()
Default: false
default java.util.Map<java.lang.String,java.lang.Object> getProperties()
Default: - No properties.
default RemovalPolicy getRemovalPolicy()
Default: cdk.RemovalPolicy.Destroy
default java.lang.String getResourceType()
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
static CustomResourceProps.Builder builder()
CustomResourceProps.Builder
of CustomResourceProps