Class Provider
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.customresources.Provider
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-08-15T01:32:56.564Z")
@Stability(Stable)
public class Provider
extends software.constructs.Construct
Defines an AWS CloudFormation custom resource provider.
Example:
// Create custom resource handler entrypoint Function handler = Function.Builder.create(this, "my-handler") .runtime(Runtime.NODEJS_20_X) .handler("index.handler") .code(Code.fromInline("\n exports.handler = async (event, context) => {\n return {\n PhysicalResourceId: '1234',\n NoEcho: true,\n Data: {\n mySecret: 'secret-value',\n hello: 'world',\n ghToken: 'gho_xxxxxxx',\n },\n };\n };")) .build(); // Provision a custom resource provider framework Provider provider = Provider.Builder.create(this, "my-provider") .onEventHandler(handler) .build(); CustomResource.Builder.create(this, "my-cr") .serviceToken(provider.getServiceToken()) .build();
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Provider
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Provider
(software.amazon.jsii.JsiiObjectRef objRef) Provider
(software.constructs.Construct scope, String id, ProviderProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe user-defined AWS Lambda function which is invoked asynchronously in order to determine if the operation is complete.The user-defined AWS Lambda function which is invoked for all resource lifecycle operations (CREATE/UPDATE/DELETE).The service token to use in order to define custom resources that are backed by this provider.Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Provider
protected Provider(software.amazon.jsii.JsiiObjectRef objRef) -
Provider
protected Provider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Provider
@Stability(Stable) public Provider(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ProviderProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
getOnEventHandler
The user-defined AWS Lambda function which is invoked for all resource lifecycle operations (CREATE/UPDATE/DELETE). -
getServiceToken
The service token to use in order to define custom resources that are backed by this provider. -
getIsCompleteHandler
The user-defined AWS Lambda function which is invoked asynchronously in order to determine if the operation is complete.
-