Package software.amazon.awscdk.customresources

Class Provider

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.customresources.Provider

All Implemented Interfaces:

IConstruct, IDependable, ICustomResourceProvider, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:42.052Z")
@Stability(Stable)
public class Provider
extends Construct
implements ICustomResourceProvider

Defines an AWS CloudFormation custom resource provider.

Example:

 import software.amazon.awscdk.customresources.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.core.Stack;
 Function myOnEventLambda;
 Function myIsCompleteLambda;
 Stack stack = new Stack();
 Provider provider = Provider.Builder.create(stack, "myProvider")
         .onEventHandler(myOnEventLambda)
         .isCompleteHandler(myIsCompleteLambda)
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudformation.ICustomResourceProvider

ICustomResourceProvider.Jsii$Default, ICustomResourceProvider.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	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 Type	Method	Description
CustomResourceProviderConfig	bind(Construct _scope)	Deprecated. use provider.serviceToken instead
IFunction	getIsCompleteHandler()	The user-defined AWS Lambda function which is invoked asynchronously in order to determine if the operation is complete.
IFunction	getOnEventHandler()	The user-defined AWS Lambda function which is invoked for all resource lifecycle operations (CREATE/UPDATE/DELETE).
String	getServiceToken()	The service token to use in order to define custom resources that are backed by this provider.

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

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

Methods inherited from class software.constructs.Construct

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

bind

@Stability(Deprecated)
@Deprecated
@NotNull
public CustomResourceProviderConfig bind(@NotNull
 Construct _scope)

Deprecated.

use provider.serviceToken instead

(deprecated) Called by CustomResource which uses this provider.

Specified by:

bind in interface ICustomResourceProvider

Parameters:

_scope - This parameter is required.

Returns:

provider configuration

getOnEventHandler

@Stability(Stable)
@NotNull
public IFunction getOnEventHandler()

The user-defined AWS Lambda function which is invoked for all resource lifecycle operations (CREATE/UPDATE/DELETE).

getServiceToken

@Stability(Stable)
@NotNull
public String getServiceToken()

The service token to use in order to define custom resources that are backed by this provider.

getIsCompleteHandler

@Stability(Stable)
@Nullable
public IFunction getIsCompleteHandler()

The user-defined AWS Lambda function which is invoked asynchronously in order to determine if the operation is complete.