software.amazon.awscdk.core

Class CustomResource.Builder

java.lang.Object

software.amazon.awscdk.core.CustomResource.Builder

Enclosing class:

CustomResource

public static final class CustomResource.Builder
extends java.lang.Object

A fluent builder for CustomResource.

Method Summary

Modifier and Type	Method and Description
CustomResource	build()
static CustomResource.Builder	create(software.constructs.Construct scope, java.lang.String id)
CustomResource.Builder	pascalCaseProperties(java.lang.Boolean pascalCaseProperties) Convert all property keys to pascal case.
CustomResource.Builder	properties(java.util.Map<java.lang.String,? extends java.lang.Object> properties) Properties to pass to the Lambda.
CustomResource.Builder	removalPolicy(RemovalPolicy removalPolicy) The policy to apply when this resource is removed from the application.
CustomResource.Builder	resourceType(java.lang.String resourceType) For custom resources, you can specify AWS::CloudFormation::CustomResource (the default) as the resource type, or you can specify your own resource type name.
CustomResource.Builder	serviceToken(java.lang.String serviceToken) The ARN of the provider which implements this custom resource type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CustomResource.Builder create(software.constructs.Construct scope,
                                            java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CustomResource.Builder.

serviceToken

public CustomResource.Builder serviceToken(java.lang.String serviceToken)

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")
         .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();
 

Parameters:

serviceToken - The ARN of the provider which implements this custom resource type. This parameter is required.

Returns:

this

pascalCaseProperties

public CustomResource.Builder pascalCaseProperties(java.lang.Boolean pascalCaseProperties)

Convert all property keys to pascal case.

Default: false

Parameters:

pascalCaseProperties - Convert all property keys to pascal case. This parameter is required.

Returns:

this

properties

public CustomResource.Builder properties(java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Properties to pass to the Lambda.

Default: - No properties.

Parameters:

properties - Properties to pass to the Lambda. This parameter is required.

Returns:

this

removalPolicy

public CustomResource.Builder removalPolicy(RemovalPolicy removalPolicy)

The policy to apply when this resource is removed from the application.

Default: cdk.RemovalPolicy.Destroy

Parameters:

removalPolicy - The policy to apply when this resource is removed from the application. This parameter is required.

Returns:

this

resourceType

public CustomResource.Builder resourceType(java.lang.String resourceType)

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

Parameters:

resourceType - For custom resources, you can specify AWS::CloudFormation::CustomResource (the default) as the resource type, or you can specify your own resource type name. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#aws-cfn-resource-type-name

build

public CustomResource build()