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:

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

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:16.495Z")
 @Stability(value=Experimental)
public class Provider
extends Construct
implements ICustomResourceProvider

(experimental) Defines an AWS CloudFormation custom resource provider.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.CustomResource;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 Function onEvent = Function.Builder.create(this, "MyHandler").build();
 Role myRole = Role.Builder.create(this, "MyRole").build();
 Provider myProvider = Provider.Builder.create(this, "MyProvider")
         .onEventHandler(onEvent)
         .isCompleteHandler(isComplete) // optional async "waiter"
         .logRetention(RetentionDays.ONE_DAY) // default is INFINITE
         .role(myRole)
         .build();
 CustomResource.Builder.create(this, "Resource1").serviceToken(myProvider.getServiceToken()).build();
 CustomResource.Builder.create(this, "Resource2").serviceToken(myProvider.getServiceToken()).build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Provider.Builder (experimental) 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.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
	Provider(software.constructs.Construct scope, String id, ProviderProps props)
protected	Provider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Provider(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
CustomResourceProviderConfig	bind(Construct _scope) Deprecated. use `provider.serviceToken` instead
IFunction	getIsCompleteHandler() (experimental) The user-defined AWS Lambda function which is invoked asynchronously in order to determine if the operation is complete.
IFunction	getOnEventHandler() (experimental) The user-defined AWS Lambda function which is invoked for all resource lifecycle operations (CREATE/UPDATE/DELETE).
String	getServiceToken() (experimental) 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 Detail

Provider

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

Provider

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

Provider

@Stability(value=Experimental)
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 Detail

bind

@Stability(value=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(value=Experimental)
 @NotNull
public IFunction getOnEventHandler()

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

getServiceToken

@Stability(value=Experimental)
 @NotNull
public String getServiceToken()

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

getIsCompleteHandler

@Stability(value=Experimental)
 @Nullable
public IFunction getIsCompleteHandler()

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