PhysicalResourceId

class aws_cdk.custom_resources.PhysicalResourceId(*args: Any, **kwargs)

Bases: object

Physical ID of the custom resource.

ExampleMetadata:

infused

Example:

aws_custom = cr.AwsCustomResource(self, "aws-custom",
    on_create=cr.AwsSdkCall(
        service="...",
        action="...",
        parameters={
            "text": "..."
        },
        physical_resource_id=cr.PhysicalResourceId.of("...")
    ),
    on_update=cr.AwsSdkCall(
        service="...",
        action="...",
        parameters={
            "text": "...",
            "resource_id": cr.PhysicalResourceIdReference()
        }
    ),
    policy=cr.AwsCustomResourcePolicy.from_sdk_calls(
        resources=cr.AwsCustomResourcePolicy.ANY_RESOURCE
    )
)

Attributes

id

Literal string to be used as the physical id.

response_path

Path to a response data element to be used as the physical id.

Static Methods

classmethod from_response(response_path)

Extract the physical resource id from the path (dot notation) to the data in the API call response.

Parameters:

response_path (str)

Return type:

PhysicalResourceId

classmethod of(id)

Explicit physical resource id.

Parameters:

id (str)

Return type:

PhysicalResourceId