@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/dist/src/lib/services/aws/step-function/main.js

@@ -31,16 +31,13 @@ const utils = __importStar(require("../../../utils"));
 const uuid_1 = require("uuid");
 const DEFAULT_RETRY_CONFIG = [
     {
+        backoffRate: 2,
         errors: ['States.ALL'],
         intervalInSecs: 30,
         maxAttempts: 6,
-        backoffRate: 2,
     },
 ];
 /**
- * @stability stable
- * @category cdk-utils.step-functions-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Step Functions Service.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -54,15 +51,14 @@ const DEFAULT_RETRY_CONFIG = [
  *     this.sfnManager.createSuccessStep('MyStep', this, myStepProps)
  *   }
  * }
- *
  * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
  */
 class SfnManager {
     /**
      * @summary Method to create a success step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnSucceedProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createSuccessStep(id, scope, props) {
         if (!props)
@@ -76,9 +72,9 @@ class SfnManager {
     }
     /**
      * @summary Method to create a failure step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnFailProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createFailStep(id, scope, props) {
         if (!props)
@@ -92,9 +88,9 @@ class SfnManager {
     }
     /**
      * @summary Method to create a pass step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnPassProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createPassStep(id, scope, props) {
         if (!props)
@@ -108,9 +104,9 @@ class SfnManager {
     }
     /**
      * @summary Method to create a parallel step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnParallelProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createParallelStep(id, scope, props) {
         if (!props)
@@ -133,9 +129,9 @@ class SfnManager {
     }
     /**
      * @summary Method to create a choice step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnChoiceProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createChoiceStep(id, scope, props) {
         if (!props)
@@ -149,9 +145,9 @@ class SfnManager {
     }
     /**
      * @summary Method to create a wait step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnWaitProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createWaitStep(id, scope, props) {
         return new sfn.Wait(scope, `${props.name}`, {
@@ -164,10 +160,10 @@ class SfnManager {
     }
     /**
      * @summary Method to create a DynamoDB get item step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnDynamoGetItemProps} props
-     * @param {dynamodb.ITable} table The table to get the item from
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param table The table to get the item from
      * @param tableKey The table key for query/scan
      */
     createDynamoDbGetItemStep(id, scope, props, table, tableKey) {
@@ -176,20 +172,20 @@ class SfnManager {
         const step = new tasks.DynamoGetItem(scope, `${props.name}`, {
             ...props,
             ...{
-                table: table,
-                key: tableKey,
+                comment: `DynamoDB GetItem step for ${props.name} - ${scope.props.stage} stage`,
                 consistentRead: props.consistentRead,
+                expressionAttributeNames: props.expressionAttributeNames,
+                heartbeatTimeout: props.heartbeatTimeout,
                 inputPath: props.inputPath,
+                integrationPattern: props.integrationPattern,
+                key: tableKey,
                 outputPath: props.outputPath,
+                projectionExpression: props.projectionExpression,
                 resultPath: props.resultPath,
                 resultSelector: props.resultSelector,
-                taskTimeout: props.taskTimeout,
-                heartbeatTimeout: props.heartbeatTimeout,
-                integrationPattern: props.integrationPattern,
-                expressionAttributeNames: props.expressionAttributeNames,
-                projectionExpression: props.projectionExpression,
                 returnConsumedCapacity: props.returnConsumedCapacity,
-                comment: `DynamoDB GetItem step for ${props.name} - ${scope.props.stage} stage`,
+                table: table,
+                taskTimeout: props.taskTimeout,
             },
         });
         let retries = props.retries;
@@ -204,10 +200,10 @@ class SfnManager {
     }
     /**
      * @summary Method to create a DynamoDB put item step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnDynamoPutItemProps} props
-     * @param {dynamodb.ITable} table The table to put the item in
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param table The table to put the item in
      * @param tableItem The item to add to the table
      */
     createDynamoDbPutItemStep(id, scope, props, table, tableItem) {
@@ -216,22 +212,22 @@ class SfnManager {
         const step = new tasks.DynamoPutItem(scope, `${props.name}`, {
             ...props,
             ...{
-                table: table,
-                item: tableItem,
+                comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
+                conditionExpression: props.conditionExpression,
+                expressionAttributeNames: props.expressionAttributeNames,
+                expressionAttributeValues: props.expressionAttributeValues,
+                heartbeatTimeout: props.heartbeatTimeout,
                 inputPath: props.inputPath,
+                integrationPattern: props.integrationPattern,
+                item: tableItem,
                 outputPath: props.outputPath,
                 resultPath: props.resultPath,
                 resultSelector: props.resultSelector,
-                taskTimeout: props.taskTimeout,
-                heartbeatTimeout: props.heartbeatTimeout,
-                integrationPattern: props.integrationPattern,
-                conditionExpression: props.conditionExpression,
-                expressionAttributeNames: props.expressionAttributeNames,
-                expressionAttributeValues: props.expressionAttributeValues,
                 returnConsumedCapacity: props.returnConsumedCapacity,
                 returnItemCollectionMetrics: props.returnItemCollectionMetrics,
                 returnValues: props.returnValues,
-                comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
+                table: table,
+                taskTimeout: props.taskTimeout,
             },
         });
         let retries = props.retries;
@@ -246,10 +242,10 @@ class SfnManager {
     }
     /**
      * @summary Method to create a DynamoDB delete item step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnDynamoDeleteItemProps} props
-     * @param {dynamodb.ITable} table The table to put the item in
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param table The table to put the item in
      * @param tableKey The table key for query/scan
      */
     createDynamoDbDeleteItemStep(id, scope, props, table, tableKey) {
@@ -258,22 +254,22 @@ class SfnManager {
         const step = new tasks.DynamoDeleteItem(scope, `${props.name}`, {
             ...props,
             ...{
-                table: table,
-                key: tableKey,
+                comment: `DynamoDB DeleteItem step for ${props.name} - ${scope.props.stage} stage`,
                 conditionExpression: props.conditionExpression,
                 expressionAttributeNames: props.expressionAttributeNames,
                 expressionAttributeValues: props.expressionAttributeValues,
-                taskTimeout: props.taskTimeout,
                 heartbeatTimeout: props.heartbeatTimeout,
                 inputPath: props.inputPath,
+                integrationPattern: props.integrationPattern,
+                key: tableKey,
                 outputPath: props.outputPath,
                 resultPath: props.resultPath,
                 resultSelector: props.resultSelector,
-                integrationPattern: props.integrationPattern,
                 returnConsumedCapacity: props.returnConsumedCapacity,
                 returnItemCollectionMetrics: props.returnItemCollectionMetrics,
                 returnValues: props.returnValues,
-                comment: `DynamoDB DeleteItem step for ${props.name} - ${scope.props.stage} stage`,
+                table: table,
+                taskTimeout: props.taskTimeout,
             },
         });
         let retries = props.retries;
@@ -288,10 +284,10 @@ class SfnManager {
     }
     /**
      * @summary Method to send a message to SQS step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnSqsSendMessageProps} props
-     * @param {sqs.IQueue} queue The queue to send the message to
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param queue The queue to send the message to
      */
     createSendSqsMessageStep(id, scope, props, queue) {
         if (!props)
@@ -301,19 +297,19 @@ class SfnManager {
         const step = new tasks.SqsSendMessage(scope, `${props.name}`, {
             ...props,
             ...{
-                queue: queue,
-                messageBody: props.messageBody,
-                messageGroupId: props.messageGroupId,
-                messageDeduplicationId: props.messageDeduplicationId,
+                comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
                 delay: props.delay,
+                heartbeatTimeout: props.heartbeatTimeout,
                 inputPath: props.inputPath,
+                integrationPattern: props.integrationPattern,
+                messageBody: props.messageBody,
+                messageDeduplicationId: props.messageDeduplicationId,
+                messageGroupId: props.messageGroupId,
                 outputPath: props.outputPath,
+                queue: queue,
                 resultPath: props.resultPath,
                 resultSelector: props.resultSelector,
                 taskTimeout: props.taskTimeout,
-                heartbeatTimeout: props.heartbeatTimeout,
-                integrationPattern: props.integrationPattern,
-                comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
             },
         });
         let retries = props.retries;
@@ -328,10 +324,10 @@ class SfnManager {
     }
     /**
      * @summary Method to create a lambda invoke step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnLambdaInvokeProps} props
-     * @param {lambda.IFunction} lambdaFunction
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param lambdaFunction
      */
     createLambdaStep(id, scope, props, lambdaFunction) {
         if (!props)
@@ -339,8 +335,8 @@ class SfnManager {
         const step = new tasks.LambdaInvoke(scope, `${props.name}`, {
             ...props,
             ...{
-                lambdaFunction,
                 comment: `Lambda step for ${props.name} - ${scope.props.stage} stage`,
+                lambdaFunction,
             },
         });
         let retries = props.retries;
@@ -355,10 +351,10 @@ class SfnManager {
     }
     /**
      * @summary Method to create a API Gateway invoke step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnLambdaInvokeProps} props
-     * @param {apig.IRestApi} api
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param api
      */
     createApiStep(id, scope, props, api) {
         if (!props)
@@ -367,8 +363,8 @@ class SfnManager {
             ...props,
             ...{
                 api,
-                stageName: scope.props.stage,
                 comment: `API step for ${props.name} - ${scope.props.stage} stage`,
+                stageName: scope.props.stage,
             },
         });
         let retries = props.retries;
@@ -383,10 +379,10 @@ class SfnManager {
     }
     /**
      * @summary Method to create a step function execution step
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnStartExecutionProps} props props for the step
-     * @param {sfn.IStateMachine} stateMachine the state machine to execute
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props props for the step
+     * @param stateMachine the state machine to execute
      */
     createSfnExecutionStep(id, scope, props, stateMachine) {
         const step = new tasks.StepFunctionsStartExecution(scope, `${id}`, {
@@ -408,37 +404,37 @@ class SfnManager {
     }
     /**
      * @summary Method to create a step function map state
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnMapProps} props props for the map state
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props props for the map state
      */
     createMapState(id, scope, props) {
         return new sfn.Map(scope, `${id}`, props);
     }
     /**
      * @summary Method to create a state machine
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {SfnStateMachineProps} props
-     * @param {sfn.IChainable} definition
-     * @param {logs.ILogGroup} logGroup
-     * @param {iam.IRole} role
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param definition
+     * @param logGroup
+     * @param role
      */
     createStateMachine(id, scope, props, definition, logGroup, role) {
         if (!props)
             throw `State Machine props undefined for ${id}`;
         const stateMachine = new sfn.StateMachine(scope, `${id}`, {
-            stateMachineName: `${props.stateMachineName}-${scope.props.stage}`,
             definition,
-            role,
-            stateMachineType: props.stateMachineType,
             logs: {
                 destination: logGroup,
                 includeExecutionData: props.logs?.includeExecutionData ?? true,
                 level: props.logs?.level ?? sfn.LogLevel.ALL,
             },
-            tracingEnabled: props.tracingEnabled,
+            role,
+            stateMachineName: `${props.stateMachineName}-${scope.props.stage}`,
+            stateMachineType: props.stateMachineType,
             timeout: props.timeout,
+            tracingEnabled: props.tracingEnabled,
         });
         utils.createCfnOutput(`${id}-stateMachineName`, scope, stateMachine.stateMachineName);
         utils.createCfnOutput(`${id}-stateMachineArn`, scope, stateMachine.stateMachineArn);

package/dist/src/lib/services/aws/step-function/types.d.ts

@@ -1,119 +1,87 @@
 import { ChoiceProps, FailProps, MapProps, ParallelProps, PassProps, RetryProps, StateMachineProps, SucceedProps, WaitProps } from 'aws-cdk-lib/aws-stepfunctions';
 import { CallApiGatewayRestApiEndpointProps, DynamoDeleteItemProps, DynamoGetItemProps, DynamoPutItemProps, LambdaInvokeProps, SqsSendMessageProps, StepFunctionsStartExecutionProps } from 'aws-cdk-lib/aws-stepfunctions-tasks';
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnSucceedProps extends SucceedProps {
     name: string;
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnRetryProps extends RetryProps {
     intervalInSecs: number;
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnFailProps extends FailProps {
     name: string;
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnPassProps extends PassProps {
     name: string;
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnDynamoGetItemProps extends DynamoGetItemProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnDynamoPutItemProps extends DynamoPutItemProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnDynamoDeleteItemProps extends DynamoDeleteItemProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnSqsSendMessageProps extends SqsSendMessageProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnParallelProps extends ParallelProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnChoiceProps extends ChoiceProps {
     name: string;
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnWaitProps extends WaitProps {
     name: string;
     delayInSeconds: number;
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnLambdaInvokeProps extends LambdaInvokeProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRestApiEndpointProps {
     name: string;
     retries?: SfnRetryProps[];
 }
 /**
- * @category cdk-utils.step-functions-manager
- * @subcategory Properties
  */
 export interface SfnStateMachineProps extends StateMachineProps {
 }
 /**
- * @category cdk-utils.sfn-manager
- * @subcategory Properties
  */
 export interface SfnMapProps extends MapProps {
 }
 /**
- * @category cdk-utils.sfn-manager
- * @subcategory Properties
  */
 export interface SfnStartExecutionProps extends StepFunctionsStartExecutionProps {
     retries?: SfnRetryProps[];

package/dist/src/lib/services/aws/systems-manager/main.d.ts

@@ -3,9 +3,6 @@ import * as cr from 'aws-cdk-lib/custom-resources';
 import { CommonConstruct } from '../../../common';
 import { SSMParameterReaderProps } from './types';
 /**
- * @stability stable
- * @category cdk-utils.ssm-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Systems Manager.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -19,37 +16,34 @@ import { SSMParameterReaderProps } from './types';
  *     this.acmManager.writeStringToParameters('MyParameter', this, ...props)
  *   }
  * }
- *
  * @see [CDK Systems Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
  */
 export declare class SsmManager {
     static SECRETS_MODIFIED_TIMESTAMP_PARAM: string;
     /**
      * Method to write a string parameter to the parameters store
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {ssm.StringParameterProps} props parameter props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props parameter props
      */
     writeStringToParameters(id: string, scope: CommonConstruct, props: ssm.StringParameterProps): ssm.StringParameter;
     /**
      * Method to read a string parameter from the parameters store
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} parameterName parameter name to lookup
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param parameterName parameter name to lookup
      */
     readStringParameter(id: string, scope: CommonConstruct, parameterName: string): string;
     /**
      * Method to read a string parameter from the parameters store in a given region
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} parameterName parameter name to lookup
-     * @param {string} region region name to lookup parameter
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param parameterName parameter name to lookup
+     * @param region region name to lookup parameter
      */
     readStringParameterFromRegion(id: string, scope: CommonConstruct, parameterName: string, region: string): string;
 }
 /**
- * @category cdk-utils.ssm-manager
- * @subcategory Construct
  * @classdesc Provides utilities to read same/cross region SSM parameters
  */
 export declare class SSMParameterReader extends cr.AwsCustomResource {

package/dist/src/lib/services/aws/systems-manager/main.js

@@ -28,9 +28,6 @@ const ssm = __importStar(require("aws-cdk-lib/aws-ssm"));
 const cr = __importStar(require("aws-cdk-lib/custom-resources"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.ssm-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Systems Manager.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -44,23 +41,22 @@ const utils = __importStar(require("../../../utils"));
  *     this.acmManager.writeStringToParameters('MyParameter', this, ...props)
  *   }
  * }
- *
  * @see [CDK Systems Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
  */
 class SsmManager {
     static SECRETS_MODIFIED_TIMESTAMP_PARAM = 'secrets-last-modified-timestamp';
     /**
      * Method to write a string parameter to the parameters store
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {ssm.StringParameterProps} props parameter props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props parameter props
      */
     writeStringToParameters(id, scope, props) {
         if (!props)
             throw `Parameter props undefined for ${id}`;
         const parameter = new ssm.StringParameter(scope, `${id}`, {
-            parameterName: `${props.parameterName}-${scope.props.stage}`,
             description: `${props.description} - ${scope.props.stage} stage`,
+            parameterName: `${props.parameterName}-${scope.props.stage}`,
             stringValue: props.stringValue,
         });
         utils.createCfnOutput(`${id}-parameterArn`, scope, parameter.parameterArn);
@@ -69,9 +65,9 @@ class SsmManager {
     }
     /**
      * Method to read a string parameter from the parameters store
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} parameterName parameter name to lookup
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param parameterName parameter name to lookup
      */
     readStringParameter(id, scope, parameterName) {
         if (!parameterName || parameterName == '')
@@ -80,10 +76,10 @@ class SsmManager {
     }
     /**
      * Method to read a string parameter from the parameters store in a given region
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} parameterName parameter name to lookup
-     * @param {string} region region name to lookup parameter
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param parameterName parameter name to lookup
+     * @param region region name to lookup parameter
      */
     readStringParameterFromRegion(id, scope, parameterName, region) {
         if (!parameterName || parameterName == '')
@@ -98,21 +94,19 @@ class SsmManager {
 }
 exports.SsmManager = SsmManager;
 /**
- * @category cdk-utils.ssm-manager
- * @subcategory Construct
  * @classdesc Provides utilities to read same/cross region SSM parameters
  */
 class SSMParameterReader extends cr.AwsCustomResource {
     constructor(scope, name, props) {
         const { parameterName, region } = props;
         const ssmAwsSdkCall = {
-            service: 'SSM',
             action: 'getParameter',
             parameters: {
                 Name: `${parameterName}-${scope.props.stage}`,
             },
-            region,
             physicalResourceId: cr.PhysicalResourceId.of(Date.now().toString()),
+            region,
+            service: 'SSM',
         };
         super(scope, name, {
             onUpdate: ssmAwsSdkCall,

package/dist/src/lib/services/aws/systems-manager/types.d.ts

@@ -1,6 +1,4 @@
 /**
- * @category cdk-utils.ssm-manager
- * @subcategory Properties
  */
 export interface SSMParameterReaderProps {
     parameterName: string;