software.amazon.awscdk

Class CustomResourceProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CustomResourceProvider

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:42.446Z")
 @Stability(value=Experimental)
public class CustomResourceProvider
extends software.constructs.Construct

(experimental) An AWS-Lambda backed custom resource provider.

Nested Class Summary

Nested 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

Constructors

Modifier	Constructor and Description
protected	CustomResourceProvider(software.constructs.Construct scope, String id, CustomResourceProviderProps props)
protected	CustomResourceProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CustomResourceProvider(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static String	getOrCreate(software.constructs.Construct scope, String uniqueid, CustomResourceProviderProps props) (experimental) Returns a stack-level singleton ARN (service token) for the custom resource provider.
static CustomResourceProvider	getOrCreateProvider(software.constructs.Construct scope, String uniqueid, CustomResourceProviderProps props) (experimental) Returns a stack-level singleton for the custom resource provider.
String	getRoleArn() (experimental) The ARN of the provider's AWS Lambda function role.
String	getServiceToken() (experimental) The ARN of the provider's AWS Lambda function which should be used as the `serviceToken` when defining a custom resource.

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 Detail

CustomResourceProvider

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

CustomResourceProvider

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

CustomResourceProvider

@Stability(value=Experimental)
protected CustomResourceProvider(@NotNull
                                                                software.constructs.Construct scope,
                                                                @NotNull
                                                                String id,
                                                                @NotNull
                                                                CustomResourceProviderProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getOrCreate

@Stability(value=Experimental)
 @NotNull
public static String getOrCreate(@NotNull
                                                                          software.constructs.Construct scope,
                                                                          @NotNull
                                                                          String uniqueid,
                                                                          @NotNull
                                                                          CustomResourceProviderProps props)

(experimental) Returns a stack-level singleton ARN (service token) for the custom resource provider.

Parameters:

scope - Construct scope. This parameter is required.

uniqueid - A globally unique id that will be used for the stack-level construct. This parameter is required.

props - Provider properties which will only be applied when the provider is first created. This parameter is required.

Returns:

the service token of the custom resource provider, which should be used when defining a `CustomResource`.

getOrCreateProvider

@Stability(value=Experimental)
 @NotNull
public static CustomResourceProvider getOrCreateProvider(@NotNull
                                                                                                  software.constructs.Construct scope,
                                                                                                  @NotNull
                                                                                                  String uniqueid,
                                                                                                  @NotNull
                                                                                                  CustomResourceProviderProps props)

(experimental) Returns a stack-level singleton for the custom resource provider.

Parameters:

scope - Construct scope. This parameter is required.

uniqueid - A globally unique id that will be used for the stack-level construct. This parameter is required.

props - Provider properties which will only be applied when the provider is first created. This parameter is required.

Returns:

the service token of the custom resource provider, which should be used when defining a `CustomResource`.

getRoleArn

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

(experimental) The ARN of the provider's AWS Lambda function role.

getServiceToken

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

(experimental) The ARN of the provider's AWS Lambda function which should be used as the `serviceToken` when defining a custom resource.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 new CustomResource(this, "MyCustomResource", new CustomResourceProps()
         // ...
         .serviceToken(myProvider.getServiceToken()));