CustomResourceProvider
An AWS-Lambda backed custom resource provider, for CDK Construct Library constructs.
This is a provider for CustomResource constructs, backed by an AWS Lambda Function. It only supports NodeJS runtimes.
Application builders do not need to use this provider type. This is not a generic custom resource provider class. It is specifically intended to be used only by constructs in the AWS CDK Construct Library, and only exists here because of reverse dependency issues (for example, it cannot use
iam.PolicyStatementobjects, since theiamlibrary already depends on the CDKcorelibrary and we cannot have cyclic dependencies).
If you are not writing constructs for the AWS Construct Library, you should use the Provider class in the custom-resources module instead, which has a better API and supports all Lambda runtimes, not just Node.
N.B.: When you are writing Custom Resource Providers, there are a number of lifecycle events you have to pay attention to. These are documented in the README of the custom-resources module. Be sure to give the documentation in that module a read, regardless of whether you end up using the Provider class in there or this one.
Example
const provider = CustomResourceProvider.getOrCreateProvider(this, 'Custom::MyCustomResourceType', {
codeDirectory: `${__dirname}/my-handler`,
runtime: CustomResourceProviderRuntime.NODEJS_22_X,
});
provider.addToRolePolicy({
Effect: 'Allow',
Action: 's3:GetObject',
Resource: '*',
})
Properties
Can be used to trigger updates on code changes, even when the properties of a custom resource remain unchanged.
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{})#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: '*',
});
getOrCreate(scope: Construct, uniqueid: string, props: CustomResourceProviderProps): string@staticmethod def get_or_create(scope: Construct, uniqueid: str, props: CustomResourceProviderProps) -> strpublic static String getOrCreate(Construct scope, String uniqueid, CustomResourceProviderProps props)public static string GetOrCreate(Construct scope, string uniqueid, CustomResourceProviderProps props)func GetOrCreate(Scope Construct, Uniqueid *string, Props CustomResourceProviderProps) *stringstatic#3 parameters · returns
Parameters
scopescopescopescopeScope— Construct scope.uniqueiduniqueiduniqueiduniqueidUniqueid— A globally unique id that will be used for the stack-level construct.propspropspropspropsProps— Provider properties which will only be applied when the provider is first created.
Returns: the service token of the custom resource provider, which should be used when defining a CustomResource.
getOrCreateProvider(scope: Construct, uniqueid: string, props: CustomResourceProviderProps): CustomResourceProvider // chainable@staticmethod def get_or_create_provider(scope: Construct, uniqueid: str, props: CustomResourceProviderProps) -> CustomResourceProviderpublic static CustomResourceProvider getOrCreateProvider(Construct scope, String uniqueid, CustomResourceProviderProps props)public static CustomResourceProvider GetOrCreateProvider(Construct scope, string uniqueid, CustomResourceProviderProps props)func GetOrCreateProvider(Scope Construct, Uniqueid *string, Props CustomResourceProviderProps) CustomResourceProviderstatic#3 parameters · returns
Parameters
scopescopescopescopeScope— Construct scope.uniqueiduniqueiduniqueiduniqueidUniqueid— A globally unique id that will be used for the stack-level construct.propspropspropspropsProps— Provider properties which will only be applied when the provider is first created.
Returns: the service token of the custom resource provider, which should be used when defining a CustomResource.
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#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#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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