aws-cdk-lib.CustomResourceProviderBase

CustomResourceProviderBase

Base class for creating a custom resource provider.

Construct›CustomResourceProviderBase

implements

• IConstruct,
• IDependable

superclass of

• CustomResourceProvider

Source

core/lib/custom-resource-provider/custom-resource-provider-base.ts

Type last changed

v2.116.0 · 22 Dec 2023

Properties

codeHashstringcode_hashstrcodeHashStringCodeHashstringCodeHash*string#

The hash of the lambda code backing this provider.

Can be used to trigger updates on code changes, even when the properties of a custom resource remain unchanged.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*string#

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

serviceTokenstringservice_tokenstrserviceTokenStringServiceTokenstringServiceToken*string#

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

Methods

addToRolePolicy(statement: any): voiddef add_to_role_policy(self, statement: Any) -> Nonepublic void addToRolePolicy(Object statement)public void AddToRolePolicy(object statement)func AddToRolePolicy(Statement interface{})#

Add an IAM policy statement to the inline policy of the provider's lambda function's role.

Please note: this is a direct IAM JSON policy blob, not a iam.PolicyStatement object like you will see in the rest of the CDK.

example

declare const myProvider: CustomResourceProvider;

myProvider.addToRolePolicy({
  Effect: 'Allow',
  Action: 's3:GetObject',
  Resource: '*',
});

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining