CustomResourceProvider

class aws_cdk.core.CustomResourceProvider(scope, id, *, code_directory, runtime, description=None, environment=None, memory_size=None, policy_statements=None, timeout=None)

Bases: Construct

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.

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.PolicyStatement objects, since the iam library already depends on the CDK core library 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.

ExampleMetadata:: infused

Example:

provider = CustomResourceProvider.get_or_create_provider(self, "Custom::MyCustomResourceType",
    code_directory=f"{__dirname}/my-handler",
    runtime=CustomResourceProviderRuntime.NODEJS_14_X
)

role_arn = provider.role_arn

Parameters:

scope (Construct)
id (str)
code_directory (str) – A local file system directory with the provider’s code. The code will be bundled into a zip asset and wired to the provider’s AWS Lambda function.
runtime (CustomResourceProviderRuntime) – The AWS Lambda runtime and version to use for the provider.
description (Optional[str]) – A description of the function. Default: - No description.
environment (Optional[Mapping[str, str]]) – Key-value pairs that are passed to Lambda as Environment. Default: - No environment variables.
memory_size (Optional[Size]) – The amount of memory that your function has access to. Increasing the function’s memory also increases its CPU allocation. Default: Size.mebibytes(128)
policy_statements (Optional[Sequence[Any]]) – A set of IAM policy statements to include in the inline policy of the provider’s lambda function. Please note: these are direct IAM JSON policy blobs, not iam.PolicyStatement objects like you will see in the rest of the CDK. Default: - no additional inline policy
timeout (Optional[Duration]) – AWS Lambda timeout for the provider. Default: Duration.minutes(15)

Methods

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

code_hash

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.

node: The construct tree node associated with this construct.

role_arn: The ARN of the provider’s AWS Lambda function role.

service_token

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

Example:

# my_provider: CustomResourceProvider


CustomResource(self, "MyCustomResource",
    service_token=my_provider.service_token,
    properties={
        "my_property_one": "one",
        "my_property_two": "two"
    }
)

Static Methods

classmethod get_or_create(scope, uniqueid, *, code_directory, runtime, description=None, environment=None, memory_size=None, policy_statements=None, timeout=None)

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

Parameters:

scope (Construct) – Construct scope.
uniqueid (str) – A globally unique id that will be used for the stack-level construct.
code_directory (str) – A local file system directory with the provider’s code. The code will be bundled into a zip asset and wired to the provider’s AWS Lambda function.
runtime (CustomResourceProviderRuntime) – The AWS Lambda runtime and version to use for the provider.
description (Optional[str]) – A description of the function. Default: - No description.
environment (Optional[Mapping[str, str]]) – Key-value pairs that are passed to Lambda as Environment. Default: - No environment variables.
memory_size (Optional[Size]) – The amount of memory that your function has access to. Increasing the function’s memory also increases its CPU allocation. Default: Size.mebibytes(128)
policy_statements (Optional[Sequence[Any]]) – A set of IAM policy statements to include in the inline policy of the provider’s lambda function. Please note: these are direct IAM JSON policy blobs, not iam.PolicyStatement objects like you will see in the rest of the CDK. Default: - no additional inline policy
timeout (Optional[Duration]) – AWS Lambda timeout for the provider. Default: Duration.minutes(15)

Return type:

str

Returns:

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

classmethod get_or_create_provider(scope, uniqueid, *, code_directory, runtime, description=None, environment=None, memory_size=None, policy_statements=None, timeout=None)

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

Parameters:

scope (Construct) – Construct scope.
uniqueid (str) – A globally unique id that will be used for the stack-level construct.
code_directory (str) – A local file system directory with the provider’s code. The code will be bundled into a zip asset and wired to the provider’s AWS Lambda function.
runtime (CustomResourceProviderRuntime) – The AWS Lambda runtime and version to use for the provider.
description (Optional[str]) – A description of the function. Default: - No description.
environment (Optional[Mapping[str, str]]) – Key-value pairs that are passed to Lambda as Environment. Default: - No environment variables.
memory_size (Optional[Size]) – The amount of memory that your function has access to. Increasing the function’s memory also increases its CPU allocation. Default: Size.mebibytes(128)
policy_statements (Optional[Sequence[Any]]) – A set of IAM policy statements to include in the inline policy of the provider’s lambda function. Please note: these are direct IAM JSON policy blobs, not iam.PolicyStatement objects like you will see in the rest of the CDK. Default: - no additional inline policy
timeout (Optional[Duration]) – AWS Lambda timeout for the provider. Default: Duration.minutes(15)

Return type:

CustomResourceProvider

Returns:

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

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool