diff --git a/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts b/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts index a9b6f80c6a9b5..7a50026fde4f7 100644 --- a/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts +++ b/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts @@ -74,6 +74,24 @@ export class PhysicalResourceId { /** * An AWS SDK call. + * + * @example + * + * new cr.AwsCustomResource(this, 'GetParameterCustomResource', { + * onUpdate: { // will also be called for a CREATE event + * service: 'SSM', + * action: 'getParameter', + * parameters: { + * Name: 'my-parameter', + * WithDecryption: true, + * }, + * physicalResourceId: cr.PhysicalResourceId.fromResponse('Parameter.ARN'), + * }, + * policy: cr.AwsCustomResourcePolicy.fromSdkCalls({ + * resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE, + * }), + * }); + * */ export interface AwsSdkCall { /**