software.amazon.awscdk.core

Class CustomResource

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.core.CustomResource

All Implemented Interfaces:

IConstruct, IDependable, IResource

Direct Known Subclasses:

CustomResource

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:34.959Z")
public class CustomResource
extends Resource

Instantiation of a custom resource, whose implementation is provided a Provider.

This class is intended to be used by construct library authors. Application builder should not be able to tell whether or not a construct is backed by a custom resource, and so the use of this class should be invisible.

Instead, construct library authors declare a custom construct that hides the choice of provider, and accepts a strongly-typed properties object with the properties your provider accepts.

Your custom resource provider (identified by the serviceToken property) can be one of 4 constructs:

• If you are authoring a construct library or application, we recommend you use the Provider class in the custom-resources module.
• If you are authoring a construct for the CDK's AWS Construct Library, you should use the CustomResourceProvider construct in this package.
• If you want full control over the provider, you can always directly use a Lambda Function or SNS Topic by passing the ARN into serviceToken.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomResource.Builder A fluent builder for CustomResource.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CustomResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CustomResource(software.amazon.jsii.JsiiObjectRef objRef)
	CustomResource(software.constructs.Construct scope, java.lang.String id, CustomResourceProps props)

Method Summary

Modifier and Type	Method and Description
Reference	getAtt(java.lang.String attributeName) Returns the value of an attribute of the custom resource of an arbitrary type.
java.lang.String	getAttString(java.lang.String attributeName) Returns the value of an attribute of the custom resource of type string.
java.lang.String	getRef() The physical name of this custom resource.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

CustomResource

protected CustomResource(software.amazon.jsii.JsiiObjectRef objRef)

CustomResource

protected CustomResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CustomResource

public CustomResource(software.constructs.Construct scope,
                      java.lang.String id,
                      CustomResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getAtt

public Reference getAtt(java.lang.String attributeName)

Returns the value of an attribute of the custom resource of an arbitrary type.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

Parameters:

attributeName - the name of the attribute. This parameter is required.

Returns:

a token for `Fn::GetAtt`. Use `Token.asXxx` to encode the returned `Reference` as a specific type or use the convenience `getAttString` for string attributes.

getAttString

public java.lang.String getAttString(java.lang.String attributeName)

Returns the value of an attribute of the custom resource of type string.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

Parameters:

attributeName - the name of the attribute. This parameter is required.

Returns:

a token for `Fn::GetAtt` encoded as a string.

getRef

public java.lang.String getRef()

The physical name of this custom resource.