Class CustomResourceProvider

An AWS-Lambda backed custom resource provider.

Inheritance
System.Object
Construct
CustomResourceProvider
Implements
Constructs.IConstruct
Inherited Members
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

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

The ARN of the provider's AWS Lambda function role.
ServiceToken

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)

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

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

Properties

RoleArn

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

public virtual string RoleArn { get; }
Property Value

System.String

ServiceToken

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

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

Methods

GetOrCreate(Construct, String, ICustomResourceProviderProps)

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.

GetOrCreateProvider(Construct, String, ICustomResourceProviderProps)

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.

Implements

Constructs.IConstruct