Class CustomResourceProvider

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

Inheritance

System.Object

Construct

CustomResourceProvider

Implements

IConstruct

Constructs.IConstruct

IDependable

Inherited Members

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK

Assembly: Amazon.CDK.dll

Syntax (csharp)

public class CustomResourceProvider : Construct, IConstruct, IConstruct, IDependable

Syntax (vb)

Public Class CustomResourceProvider
    Inherits Construct
    Implements IConstruct, IConstruct, IDependable

Remarks

Stability: Experimental

Synopsis

Constructors

CustomResourceProvider(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CustomResourceProvider(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CustomResourceProvider(Construct, String, ICustomResourceProviderProps)

Properties

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

Methods

GetOrCreate(Construct, String, ICustomResourceProviderProps)	(experimental) Returns a stack-level singleton ARN (service token) for the custom resource provider.
GetOrCreateProvider(Construct, String, ICustomResourceProviderProps)	(experimental) Returns a stack-level singleton for the custom resource provider.

Constructors

CustomResourceProvider(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CustomResourceProvider(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CustomResourceProvider(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CustomResourceProvider(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CustomResourceProvider(Construct, String, ICustomResourceProviderProps)

public CustomResourceProvider(Construct scope, string id, ICustomResourceProviderProps props)

Parameters

scope Constructs.Construct

id System.String

props ICustomResourceProviderProps

Remarks

Stability: Experimental

Properties

RoleArn

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

public virtual string RoleArn { get; }

Property Value

System.String

Remarks

Stability: Experimental

ServiceToken

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

public virtual string ServiceToken { get; }

Property Value

System.String

Remarks

Stability: Experimental

Examples

// Example automatically generated. See https://github.com/aws/jsii/issues/826
new CustomResource(this, "MyCustomResource", new Struct {
// ...
ServiceToken = myProvider.ServiceToken
});

Methods

GetOrCreate(Construct, String, ICustomResourceProviderProps)

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

public static string GetOrCreate(Construct scope, string uniqueid, ICustomResourceProviderProps props)

Parameters

scope Constructs.Construct

Construct scope.

uniqueid System.String

A globally unique id that will be used for the stack-level construct.

props ICustomResourceProviderProps

Provider properties which will only be applied when the provider is first created.

Returns

System.String

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

Remarks

Stability: Experimental

GetOrCreateProvider(Construct, String, ICustomResourceProviderProps)

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

public static CustomResourceProvider GetOrCreateProvider(Construct scope, string uniqueid, ICustomResourceProviderProps props)

Parameters

scope Constructs.Construct

Construct scope.

uniqueid System.String

A globally unique id that will be used for the stack-level construct.

props ICustomResourceProviderProps

Provider properties which will only be applied when the provider is first created.

Returns

CustomResourceProvider

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

Remarks

Stability: Experimental

Implements

IConstruct

Constructs.IConstruct

IDependable