@types/aws-lambda - npm Package Compare versions

Comparing version 8.10.140 to 8.10.141

aws-lambda/package.json

 {
     "name": "@types/aws-lambda",
-    "version": "8.10.140",
+    "version": "8.10.141",
     "description": "TypeScript definitions for aws-lambda",
@@ -207,2 +207,7 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/aws-lambda",
             "url": "https://github.com/lmanerich"
+        },
+        {
+            "name": "Luciano M. Taranto",
+            "githubUsername": "LucianoTaranto",
+            "url": "https://github.com/LucianoTaranto"
         }
@@ -219,4 +224,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "8fb5617cd4cd0de8e2ed6c40d4c83704dcea247eb0873bb8f8d0823e2f906e6f",
-    "typeScriptVersion": "4.7"
+    "typesPublisherContentHash": "2cf97a298600a542548ab290f42523061a438b637293be8ad3626dccc63486d1",
+    "typeScriptVersion": "4.8"
 }

aws-lambda/README.md

@@ -11,6 +11,6 @@ # Installation
 ### Additional Details
- * Last updated: Tue, 18 Jun 2024 00:25:32 GMT
+ * Last updated: Tue, 09 Jul 2024 22:07:33 GMT
  * Dependencies: none
 
 # Credits
-These definitions were written by [James Darbyshire](https://github.com/darbio), [Michael Skarum](https://github.com/skarum), [Stef Heyenrath](https://github.com/StefH), [Rich Buggy](https://github.com/buggy), [wwwy3y3](https://github.com/wwwy3y3), [Ishaan Malhi](https://github.com/OrthoDex), [Michael Marner](https://github.com/MichaelMarner), [Daniel Cottone](https://github.com/daniel-cottone), [Kostya Misura](https://github.com/kostya-misura), [Markus Tacker](https://github.com/coderbyheart), [Palmi Valgeirsson](https://github.com/palmithor), [Danilo Raisi](https://github.com/daniloraisi), [Simon Buchan](https://github.com/simonbuchan), [David Hayden](https://github.com/Haydabase), [Chris Redekop](https://github.com/repl-chris), [Aneil Mallavarapu](https://github.com/aneilbaboo), [Jeremy Nagel](https://github.com/jeznag), [Louis Larry](https://github.com/louislarry), [Daniel Papukchiev](https://github.com/dpapukchiev), [Oliver Hookins](https://github.com/ohookins), [Trevor Leach](https://github.com/trevor-leach), [James Gregory](https://github.com/jagregory), [Erik Dalén](https://github.com/dalen), [Loïk Gaonac'h](https://github.com/loikg), [Roberto Zen](https://github.com/skyzenr), [Grzegorz Redlicki](https://github.com/redlickigrzegorz), [Juan Carbonel](https://github.com/juancarbonel), [Peter McIntyre](https://github.com/pwmcintyre), [Alex Bolenok](https://github.com/alex-bolenok-centralreach), [Marian Zange](https://github.com/marianzange), [Alessandro Palumbo](https://github.com/apalumbo), [Sachin Shekhar](https://github.com/SachinShekhar), [Ivan Martos](https://github.com/ivanmartos), [Zach Anthony](https://github.com/zach-anthony), [Peter Savnik](https://github.com/savnik), [Benoit Boure](https://github.com/bboure), [James Lakin](https://github.com/jamesorlakin), [Ross Gerbasi](https://github.com/aphex), [Joey Kilpatrick](https://github.com/joeykilpatrick), and [Luciano Manerich Junior](https://github.com/lmanerich).
+These definitions were written by [James Darbyshire](https://github.com/darbio), [Michael Skarum](https://github.com/skarum), [Stef Heyenrath](https://github.com/StefH), [Rich Buggy](https://github.com/buggy), [wwwy3y3](https://github.com/wwwy3y3), [Ishaan Malhi](https://github.com/OrthoDex), [Michael Marner](https://github.com/MichaelMarner), [Daniel Cottone](https://github.com/daniel-cottone), [Kostya Misura](https://github.com/kostya-misura), [Markus Tacker](https://github.com/coderbyheart), [Palmi Valgeirsson](https://github.com/palmithor), [Danilo Raisi](https://github.com/daniloraisi), [Simon Buchan](https://github.com/simonbuchan), [David Hayden](https://github.com/Haydabase), [Chris Redekop](https://github.com/repl-chris), [Aneil Mallavarapu](https://github.com/aneilbaboo), [Jeremy Nagel](https://github.com/jeznag), [Louis Larry](https://github.com/louislarry), [Daniel Papukchiev](https://github.com/dpapukchiev), [Oliver Hookins](https://github.com/ohookins), [Trevor Leach](https://github.com/trevor-leach), [James Gregory](https://github.com/jagregory), [Erik Dalén](https://github.com/dalen), [Loïk Gaonac'h](https://github.com/loikg), [Roberto Zen](https://github.com/skyzenr), [Grzegorz Redlicki](https://github.com/redlickigrzegorz), [Juan Carbonel](https://github.com/juancarbonel), [Peter McIntyre](https://github.com/pwmcintyre), [Alex Bolenok](https://github.com/alex-bolenok-centralreach), [Marian Zange](https://github.com/marianzange), [Alessandro Palumbo](https://github.com/apalumbo), [Sachin Shekhar](https://github.com/SachinShekhar), [Ivan Martos](https://github.com/ivanmartos), [Zach Anthony](https://github.com/zach-anthony), [Peter Savnik](https://github.com/savnik), [Benoit Boure](https://github.com/bboure), [James Lakin](https://github.com/jamesorlakin), [Ross Gerbasi](https://github.com/aphex), [Joey Kilpatrick](https://github.com/joeykilpatrick), [Luciano Manerich Junior](https://github.com/lmanerich), and [Luciano M. Taranto](https://github.com/LucianoTaranto).

aws-lambda/trigger/cdk-custom-resource.d.ts

 import { Callback, Handler } from "../handler";
-import { CloudFormationCustomResourceEvent } from "./cloudformation-custom-resource";
+import {
+    CloudFormationCustomResourceEvent,
+    CloudFormationCustomResourceResourcePropertiesCommon,
+} from "./cloudformation-custom-resource";
 
-// The CDK docs only specify 'important' properties, but in reality the incoming event
-// to the Lambda matches that of a traditional custom resource.
-// This includes the ResponseURL property which should not be used as the framework
-// itself will deal with delivering responses.
-export type CdkCustomResourceEvent = CloudFormationCustomResourceEvent & {
-    /**
-     * **This URL should not be used.** The CDK Provider Framework will call this URL
-     * automatically based on the response produced by the Lambda handler.
-     */
-    ResponseURL: string;
-};
+/**
+ * Request event sent to the Lambda `OnEvent` handler for a CDK Custom Resource
+ * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-onevent
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation
+ */
+export type CdkCustomResourceEvent<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+    TOldResourceProperties = TResourceProperties,
+> =
+    & CloudFormationCustomResourceEvent<TResourceProperties, TOldResourceProperties>
+    & {
+        /**
+         * The response URL identifies a presigned S3 bucket that receives responses from the custom resource provider to AWS CloudFormation.
+         *
+         * **This URL should not be used.**
+         * The CDK Provider Framework will call this URL automatically based on the response produced by the Lambda handler.
+         */
+        ResponseURL: string;
+    };
 
 /**
- * A custom resource based on the AWS CDK custom resource Provider Framework.
- * This is not to be confused with traditional CloudFormation custom resources.
- * @link https://docs.aws.amazon.com/cdk/api/latest/docs/custom-resources-readme.html#handling-lifecycle-events-onevent
+ * Lambda handler function for the `OnEvent` CDK Custom Resource
+ * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-onevent
+ *
+ * NOTE: this is not to be confused with traditional CloudFormation custom resources.
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ * @template TData User-defined output properties that are retuned from any invocation
+ * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation
  */
-export type CdkCustomResourceHandler = Handler<CdkCustomResourceEvent, CdkCustomResourceResponse>;
-export type CdkCustomResourceCallback = Callback<CdkCustomResourceResponse>;
+export type CdkCustomResourceHandler<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+    TData extends Record<string, any> = Record<string, any>,
+    TOldResourceProperties = TResourceProperties,
+> = Handler<CdkCustomResourceEvent<TResourceProperties, TOldResourceProperties>, CdkCustomResourceResponse<TData>>;
 
-export interface CdkCustomResourceResponse {
+/**
+ * Lambda `OnEvent` callback function for a CDK Custom Resource
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export type CdkCustomResourceCallback<TData extends Record<string, any>> = Callback<CdkCustomResourceResponse<TData>>;
+
+/**
+ * Response from the `OnEvent` Lambda handler for a CDK Custom Resource
+ * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-onevent
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export interface CdkCustomResourceResponse<TData extends Record<string, any> = Record<string, any>> {
+    /**
+     * This value should be an identifier unique to the custom resource vendor, and can be up to 1 KB in size. The value must be a non-empty string and must be identical for all responses for the same resource.
+     * The value returned for a `PhysicalResourceId` can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource.
+     *
+     * If omitted for `Create` events, the event's `RequestId` will be used.
+     * For `Update`, the current physical ID will be used. If a different value is returned, CloudFormation will follow with a subsequent `Delete` for the previous ID (resource replacement).
+     * For `Delete`, it will always return the current physical resource ID, and if the user returns a different one, an error will occur.
+     */
     PhysicalResourceId?: string;
-    Data?:
-        | {
-            [Key: string]: any;
-        }
-        | undefined;
-    // Any extra properties will be provided to the isComplete handler for asynchronous resources.
+
+    /**
+     * The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with `Fn::GetAtt`.
+     * NOTE: If the name-value pairs contain sensitive information, you should use the `NoEcho` field to mask the output of the custom resource. Otherwise, the values are visible through APIs that surface property values (such as `DescribeStackEvents`).
+     */
+    Data?: TData;
+
+    /**
+     * Indicates whether to mask the output of the custom resource when retrieved by using the `Fn::GetAtt` function. If set to `true`, all returned values are masked with asterisks (*****), __except for those stored in the `Metadata` section of the template__. AWS CloudFormation does not transform, modify, or redact any information you include in the `Metadata` section. The default value is `false`.
+     */
+    NoEcho?: boolean;
+
+    /**
+     * Any other field included in the response will be passed through to `isComplete`. This can sometimes be useful to pass state between the handlers.
+     */
     [Key: string]: any;
 }
 
-// IsComplete events will contain all normal request fields, as well as those returned from
-// the initial onEvent handler.
-export type CdkCustomResourceIsCompleteEvent = CdkCustomResourceEvent & CdkCustomResourceResponse;
+/**
+ * Request event sent to the Lambda `IsComplete` handler for an asynchronous CDK Custom Resource
+ * The input event to isComplete includes all request fields, combined with all fields returned from onEvent. If PhysicalResourceId has not been explicitly returned from onEvent, it's value will be calculated based on heuristics.
+ * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ * @template TData User-defined output properties that are retuned from any invocation
+ * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation
+ */
+export type CdkCustomResourceIsCompleteEvent<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+    TData extends Record<string, any> = Record<string, any>,
+    TOldResourceProperties = TResourceProperties,
+> = CdkCustomResourceEvent<TResourceProperties, TOldResourceProperties> & CdkCustomResourceResponse<TData>;
 
-export type CdkCustomResourceIsCompleteResponse =
-    | CdkCustomResourceIsCompleteResponseSuccess
+/**
+ * Common response properties from the `IsComplete` Lambda handler for a CDK Custom Resource
+ * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export type CdkCustomResourceIsCompleteResponse<TData extends Record<string, any> = Record<string, any>> =
+    | CdkCustomResourceIsCompleteResponseSuccess<TData>
     | CdkCustomResourceIsCompleteResponseWaiting;
 
-export interface CdkCustomResourceIsCompleteResponseSuccess {
+/**
+ * Response properties that are specifically for a successful `IsComplete` response for a CDK Custom Resource
+ * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export interface CdkCustomResourceIsCompleteResponseSuccess<TData extends Record<string, any> = Record<string, any>> {
+    /**
+     * Indicates the operation has finished.
+     */
     IsComplete: true;
+
     /**
-     * This will be merged with the `Data` property of the onEvent handler's response.
+     * The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with `Fn::GetAtt`.
+     * These attributes will be **merged** with the ones returned from `onEvent`.
      */
-    Data?:
-        | {
-            [Key: string]: any;
-        }
-        | undefined;
+    Data?: TData;
 }
 
+/**
+ * Response properties that are specifically for a still waiting `IsComplete` response for a CDK Custom Resource
+ * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete
+ */
 export interface CdkCustomResourceIsCompleteResponseWaiting {
+    /**
+     * Indicates the operation has not finished.
+     */
     IsComplete: false;
@@ -60,9 +135,25 @@ }
 /**
- * An asynchronous custom resource handler.
- * @link https://docs.aws.amazon.com/cdk/api/latest/docs/custom-resources-readme.html#asynchronous-providers-iscomplete
+ * Lambda `IsComplete` handler function for asynchronous CDK Custom Resources
+ * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ * @template TOnEventData User-defined output properties that are retuned from any invocation of the `OnEvent` function
+ * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation
+ * @template TIsCompleteData User-defined output properties that are retuned from any invocation of the `IsComplete` function
  */
-export type CdkCustomResourceIsCompleteHandler = Handler<
-    CdkCustomResourceIsCompleteEvent,
-    CdkCustomResourceIsCompleteResponse
+export type CdkCustomResourceIsCompleteHandler<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+    TOnEventData extends Record<string, any> = Record<string, any>,
+    TOldResourceProperties = TResourceProperties,
+    TIsCompleteData extends Record<string, any> = TOnEventData,
+> = Handler<
+    CdkCustomResourceIsCompleteEvent<TResourceProperties, TOnEventData, TOldResourceProperties>,
+    CdkCustomResourceIsCompleteResponse<TIsCompleteData>
 >;
-export type CdkCustomResourceIsCompleteCallback = Callback<CdkCustomResourceIsCompleteResponse>;
+
+/**
+ * Lambda `IsComplete` callback function for a CDK Custom Resource
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export type CdkCustomResourceIsCompleteCallback<TData extends Record<string, any> = Record<string, any>> = Callback<
+    CdkCustomResourceIsCompleteResponse<TData>
+>;

aws-lambda/trigger/cloudformation-custom-resource.d.ts

 import { Handler } from "../handler";
 
-// Note, responses are *not* lambda results, they are sent to the event ResponseURL.
-export type CloudFormationCustomResourceHandler = Handler<CloudFormationCustomResourceEvent, void>;
+/**
+ * Named service-defined resource properties
+ * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-properties
+ */
+export interface CloudFormationCustomResourceResourcePropertiesCommon extends Record<string, any> {
+    /**
+     * The service token, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region as the stack.
+     */
+    ServiceToken: string;
 
-export type CloudFormationCustomResourceEvent =
-    | CloudFormationCustomResourceCreateEvent
-    | CloudFormationCustomResourceUpdateEvent
-    | CloudFormationCustomResourceDeleteEvent;
+    /**
+     * The maximum time, in seconds, that can elapse before a custom resource operation times out.
+     * The value must be an integer from 1 to 3600. The default value is 3600 seconds (1 hour).
+     */
+    ServiceTimeout?: string;
+}
 
-export type CloudFormationCustomResourceResponse =
-    | CloudFormationCustomResourceSuccessResponse
-    | CloudFormationCustomResourceFailedResponse;
+/**
+ * Lambda handler function for a Lambda-backed CloudFormation Custom Resource
+ *
+ * NOTE: responses are *not* returned from the Lambda handler but rather they are sent to the event ResponseURL.
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation
+ */
+export type CloudFormationCustomResourceHandler<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+    TOldResourceProperties = TResourceProperties,
+> = Handler<CloudFormationCustomResourceEvent<TResourceProperties, TOldResourceProperties>, void>;
 
 /**
- * CloudFormation Custom Resource event and response
- * http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref.html
+ * Request event sent to the Lambda handler for a Lambda-backed CloudFormation Custom Resource
+ * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-fields
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation
  */
-export interface CloudFormationCustomResourceEventCommon {
+export type CloudFormationCustomResourceEvent<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+    TOldResourceProperties = TResourceProperties,
+> =
+    | CloudFormationCustomResourceCreateEvent<TResourceProperties>
+    | CloudFormationCustomResourceUpdateEvent<TResourceProperties, TOldResourceProperties>
+    | CloudFormationCustomResourceDeleteEvent<TResourceProperties>;
+
+/**
+ * Response from a Lambda handler for a Lambda-backed CloudFormation Custom Resource
+ * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html
+ *
+ * NOTE: responses are *not* returned from the Lambda handler but rather they are sent to the event ResponseURL.
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export type CloudFormationCustomResourceResponse<TData extends Record<string, any> = Record<string, any>> =
+    | CloudFormationCustomResourceSuccessResponse<TData>
+    | CloudFormationCustomResourceFailedResponse<TData>;
+
+/**
+ * Request properties that are common to all invocations of a Lambda-backed CloudFormation Custom Resource
+ * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-fields
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ */
+export interface CloudFormationCustomResourceEventCommon<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+> {
+    /**
+     * The service token, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region as the stack.
+     */
     ServiceToken: string;
+
+    /**
+     * The response URL identifies a presigned S3 bucket that receives responses from the custom resource provider to AWS CloudFormation.
+     */
     ResponseURL: string;
+
+    /**
+     * The Amazon Resource Name (ARN) that identifies the stack that contains the custom resource.
+     * Combining the `StackId` with the `RequestId` forms a value that you can use to uniquely identify a request on a particular custom resource.
+     */
     StackId: string;
+
+    /**
+     * A unique ID for the request.
+     * Combining the `StackId` with the `RequestId` forms a value that you can use to uniquely identify a request on a particular custom resource.
+     */
     RequestId: string;
+
+    /**
+     * The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This is provided to facilitate communication between the custom resource provider and the template developer.
+     */
     LogicalResourceId: string;
+
+    /**
+     * The template developer-chosen resource type of the custom resource in the CloudFormation template. Custom resource type names can be up to 60 characters long and can include alphanumeric and the following characters: `_@-`.
+     */
     ResourceType: string;
-    ResourceProperties: {
-        ServiceToken: string;
-        [Key: string]: any;
-    };
+
+    /**
+     * This field contains the contents of the `Properties` object sent by the template developer. Its contents are defined by the custom resource provider.
+     */
+    ResourceProperties: TResourceProperties & CloudFormationCustomResourceResourcePropertiesCommon;
 }
 
-export interface CloudFormationCustomResourceCreateEvent extends CloudFormationCustomResourceEventCommon {
+/**
+ * Request properties specifically for the `Create` invocation of a Lambda-backed CloudFormation Custom Resource
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ */
+export interface CloudFormationCustomResourceCreateEvent<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+> extends CloudFormationCustomResourceEventCommon<TResourceProperties> {
+    /**
+     * The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource.
+     */
     RequestType: "Create";
 }
 
-export interface CloudFormationCustomResourceUpdateEvent extends CloudFormationCustomResourceEventCommon {
+/**
+ * Request properties specifically for the `Update` invocation of a Lambda-backed CloudFormation Custom Resource
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation
+ */
+export interface CloudFormationCustomResourceUpdateEvent<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+    TOldResourceProperties = TResourceProperties,
+> extends CloudFormationCustomResourceEventCommon<TResourceProperties> {
+    /**
+     * The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource.
+     */
     RequestType: "Update";
+
+    /**
+     * A required custom resource provider-defined physical ID that is unique for that provider.
+     * The value returned for a `PhysicalResourceId` can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource.
+     */
     PhysicalResourceId: string;
-    OldResourceProperties: {
-        [Key: string]: any;
-    };
+
+    /**
+     * Used only for `Update` requests. Contains the resource properties that were declared previous to the update request.
+     */
+    OldResourceProperties: TOldResourceProperties;
 }
 
-export interface CloudFormationCustomResourceDeleteEvent extends CloudFormationCustomResourceEventCommon {
+/**
+ * Request properties specifically for the `Delete` invocation of a Lambda-backed CloudFormation Custom Resource
+ * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
+ */
+export interface CloudFormationCustomResourceDeleteEvent<
+    TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon,
+> extends CloudFormationCustomResourceEventCommon<TResourceProperties> {
+    /**
+     * The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource.
+     */
     RequestType: "Delete";
+
+    /**
+     * A required custom resource provider-defined physical ID that is unique for that provider.
+     * The value returned for a `PhysicalResourceId` can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource.
+     */
     PhysicalResourceId: string;
 }
 
-export interface CloudFormationCustomResourceResponseCommon {
+/**
+ * Response properties that are common to all invocations of a Lambda-backed CloudFormation Custom Resource
+ * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export interface CloudFormationCustomResourceResponseCommon<TData extends Record<string, any> = Record<string, any>> {
+    /**
+     * This value should be an identifier unique to the custom resource vendor, and can be up to 1 KB in size. The value must be a non-empty string and must be identical for all responses for the same resource.
+     * The value returned for a `PhysicalResourceId` can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource.
+     */
     PhysicalResourceId: string;
+
+    /**
+     * The Amazon Resource Name (ARN) that identifies the stack that contains the custom resource. This response value should be copied verbatim from the request.
+     */
     StackId: string;
+
+    /**
+     * A unique ID for the request. This response value should be copied verbatim from the request.
+     */
     RequestId: string;
+
+    /**
+     * The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This response value should be copied verbatim from the request.
+     */
     LogicalResourceId: string;
-    Data?:
-        | {
-            [Key: string]: any;
-        }
-        | undefined;
+
+    /**
+     * The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with `Fn::GetAtt`.
+     * NOTE: If the name-value pairs contain sensitive information, you should use the `NoEcho` field to mask the output of the custom resource. Otherwise, the values are visible through APIs that surface property values (such as `DescribeStackEvents`).
+     */
+    Data?: TData | undefined;
+
+    /**
+     * Indicates whether to mask the output of the custom resource when retrieved by using the `Fn::GetAtt` function. If set to `true`, all returned values are masked with asterisks (*****), __except for those stored in the `Metadata` section of the template__. AWS CloudFormation does not transform, modify, or redact any information you include in the `Metadata` section. The default value is `false`.
+     */
     NoEcho?: boolean | undefined;
 }
 
-export interface CloudFormationCustomResourceSuccessResponse extends CloudFormationCustomResourceResponseCommon {
+/**
+ * Response properties that are specifically for a response indicating succesful invocation of a Lambda-backed CloudFormation Custom Resource
+ * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export interface CloudFormationCustomResourceSuccessResponse<TData extends Record<string, any> = Record<string, any>>
+    extends CloudFormationCustomResourceResponseCommon<TData>
+{
+    /**
+     * The status value sent by the custom resource provider in response to an AWS CloudFormation-generated request.
+     */
     Status: "SUCCESS";
+
+    /**
+     * Describes the reason for a failure response.
+     */
     Reason?: string | undefined;
 }
 
-export interface CloudFormationCustomResourceFailedResponse extends CloudFormationCustomResourceResponseCommon {
+/**
+ * Response properties that are specifically for a response indicating failed invocation of a Lambda-backed CloudFormation Custom Resource
+ * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html
+ * @template TData User-defined output properties that are retuned from any invocation
+ */
+export interface CloudFormationCustomResourceFailedResponse<TData extends Record<string, any> = Record<string, any>>
+    extends CloudFormationCustomResourceResponseCommon<TData>
+{
+    /**
+     * The status value sent by the custom resource provider in response to an AWS CloudFormation-generated request.
+     */
     Status: "FAILED";
+
+    /**
+     * Describes the reason for a failure response.
+     */
     Reason: string;
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

165617

increased by11.87%

Lines of code

3819

increased by6.56%

No dependency changes