software.amazon.awscdk.customresources

Class Provider

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.customresources.Provider

All Implemented Interfaces:

IConstruct, IDependable, ICustomResourceProvider

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:01.360Z")
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 and Description
static class	Provider.Builder A fluent builder for Provider.

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

ICustomResourceProvider.Jsii$Default, ICustomResourceProvider.Jsii$Proxy

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

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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).
java.lang.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 java.lang.Object

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

Constructor Detail

Provider

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

Provider

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

Provider

public Provider(software.constructs.Construct scope,
                java.lang.String id,
                ProviderProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

bind

@Deprecated
public CustomResourceProviderConfig bind(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

public IFunction getOnEventHandler()

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

getServiceToken

public java.lang.String getServiceToken()

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

getIsCompleteHandler

public IFunction getIsCompleteHandler()

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