Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(custom-resources): clarify that AwsCustomResource uses SingletonFunction #19358

Merged
merged 2 commits into from
Mar 14, 2022
Merged

docs(custom-resources): clarify that AwsCustomResource uses SingletonFunction #19358

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd75f0f
docs(custom-resources): Call out that AwsCustomResource uses Singleto…
ckifer Mar 11, 2022
6a6e7d2
Merge branch 'master' into patch-1
mergify[bot] Mar 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions packages/@aws-cdk/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ export interface AwsCustomResourceProps {
readonly policy: AwsCustomResourcePolicy;

/**
* The execution role for the Lambda function implementing this custom
* The execution role for the singleton Lambda function implementing this custom
* resource provider. This role will apply to all `AwsCustomResource`
* instances in the stack. The role must be assumable by the
* `lambda.amazonaws.com` service principal.
Expand All @@ -273,14 +273,14 @@ export interface AwsCustomResourceProps {
readonly role?: iam.IRole;

/**
* The timeout for the Lambda function implementing this custom resource.
* The timeout for the singleton Lambda function implementing this custom resource.
*
* @default Duration.minutes(2)
*/
readonly timeout?: cdk.Duration

/**
* The number of days log events of the Lambda function implementing
* The number of days log events of the singleton Lambda function implementing
* this custom resource are kept in CloudWatch Logs.
*
* @default logs.RetentionDays.INFINITE
Expand All @@ -298,7 +298,8 @@ export interface AwsCustomResourceProps {
readonly installLatestAwsSdk?: boolean;

/**
* A name for the Lambda function implementing this custom resource.
* A name for the singleton Lambda function implementing this custom resource.
* The function name will remain the same after the first AwsCustomResource is created in a stack.
*
* @default - AWS CloudFormation generates a unique physical ID and uses that
* ID for the function's name. For more information, see Name Type.
Expand All @@ -307,7 +308,8 @@ export interface AwsCustomResourceProps {
}

/**
* Defines a custom resource that is materialized using specific AWS API calls.
* Defines a custom resource that is materialized using specific AWS API calls. These calls are created using
* a singleton Lambda function.
*
* Use this to bridge any gap that might exist in the CloudFormation Coverage.
* You can specify exactly which calls are invoked for the 'CREATE', 'UPDATE' and 'DELETE' life cycle events.
Expand Down