Class CustomResource

Custom resource that is implemented using a Lambda.

Inheritance
System.Object
Construct
Resource
CustomResource
CustomResource
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class CustomResource : Resource, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class CustomResource
    Inherits Resource
    Implements IResource, IConstruct, IConstruct, IDependable
Remarks

As a custom resource author, you should be publishing a subclass of this class that hides the choice of provider, and accepts a strongly-typed properties object with the properties your provider accepts.

Resource: AWS::CloudFormation::CustomResource

Synopsis

Constructors

CustomResource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CustomResource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CustomResource(Construct, String, ICustomResourceProps)

Properties

Ref

The physical name of this custom resource.

Methods

GetAtt(String)

Returns the value of an attribute of the custom resource of an arbitrary type.
GetAttString(String)

Returns the value of an attribute of the custom resource of type string.

Constructors

CustomResource(ByRefValue)

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

protected CustomResource(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CustomResource(DeputyBase.DeputyProps)

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

protected CustomResource(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CustomResource(Construct, String, ICustomResourceProps)

public CustomResource(Construct scope, string id, ICustomResourceProps props)
Parameters
scope Constructs.Construct
id System.String
props ICustomResourceProps

Properties

Ref

The physical name of this custom resource.

public virtual string Ref { get; }
Property Value

System.String

Methods

GetAtt(String)

Returns the value of an attribute of the custom resource of an arbitrary type.

public virtual Reference GetAtt(string attributeName)
Parameters
attributeName System.String

the name of the attribute.

Returns

Reference

a token for Fn::GetAtt. Use Token.asXxx to encode the returned Reference as a specific type or use the convenience getAttString for string attributes.

Remarks

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

GetAttString(String)

Returns the value of an attribute of the custom resource of type string.

public virtual string GetAttString(string attributeName)
Parameters
attributeName System.String

the name of the attribute.

Returns

System.String

a token for Fn::GetAtt encoded as a string.

Remarks

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

Implements

Constructs.IConstruct