@gradientedge/cdk-utils 10.7.0 → 11.0.0

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

@@ -1,380 +0,0 @@
-import { Duration } from 'aws-cdk-lib';
-import { Choice, DefinitionBody, Fail, LogLevel, Map, Parallel, Pass, StateMachine, Succeed, Wait, WaitTime, } from 'aws-cdk-lib/aws-stepfunctions';
-import { CallApiGatewayRestApiEndpoint, DynamoDeleteItem, DynamoGetItem, DynamoPutItem, LambdaInvoke, SqsSendMessage, StepFunctionsStartExecution, } from 'aws-cdk-lib/aws-stepfunctions-tasks';
-import _ from 'lodash';
-import { v4 as uuidv4 } from 'uuid';
-import { createCfnOutput } from '../../utils/index.js';
-const DEFAULT_RETRY_CONFIG = [
-    {
-        backoffRate: 2,
-        errors: ['States.ALL'],
-        intervalInSecs: 30,
-        maxAttempts: 6,
-    },
-];
-/**
- * @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.
- * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     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}
- */
-export class SfnManager {
-    /**
-     * @summary Method to create a success step
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props
-     */
-    createSuccessStep(id, scope, props) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        return new Succeed(scope, `${props.name}`, {
-            ...props,
-            comment: `Succeed step for ${props.name} - ${scope.props.stage} stage`,
-        });
-    }
-    /**
-     * @summary Method to create a failure step
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props
-     */
-    createFailStep(id, scope, props) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        return new Fail(scope, `${props.name}`, {
-            ...props,
-            comment: `Fail step for ${props.name} - ${scope.props.stage} stage`,
-        });
-    }
-    /**
-     * @summary Method to create a pass step
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props
-     */
-    createPassStep(id, scope, props) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        return new Pass(scope, `${props.name}`, {
-            ...props,
-            comment: `Pass step for ${props.name} - ${scope.props.stage} stage`,
-        });
-    }
-    /**
-     * @summary Method to create a parallel step
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props
-     */
-    createParallelStep(id, scope, props) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        return new Parallel(scope, `${props.name}`, {
-            ...props,
-            comment: `Parallel step for ${props.name} - ${scope.props.stage} stage`,
-        });
-    }
-    /**
-     * @summary Method to create a choice step
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props
-     */
-    createChoiceStep(id, scope, props) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        return new Choice(scope, `${props.name}`, {
-            ...props,
-            comment: `Choice step for ${props.name} - ${scope.props.stage} stage`,
-        });
-    }
-    /**
-     * @summary Method to create a wait step
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props
-     */
-    createWaitStep(id, scope, props) {
-        return new Wait(scope, `${props.name}`, {
-            ...props,
-            comment: `Choice step for ${props.name} - ${scope.props.stage} stage`,
-            time: WaitTime.duration(Duration.seconds(props.delayInSeconds)),
-        });
-    }
-    /**
-     * @summary Method to create a DynamoDB get item step
-     * @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) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        const step = new DynamoGetItem(scope, `${props.name}`, {
-            ...props,
-            comment: `DynamoDB GetItem step for ${props.name} - ${scope.props.stage} stage`,
-            key: tableKey,
-            table,
-        });
-        let retries = props.retries;
-        if (!retries || retries.length === 0) {
-            retries = DEFAULT_RETRY_CONFIG;
-        }
-        _.forEach(retries, retry => {
-            step.addRetry({
-                ...retry,
-                interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval,
-            });
-        });
-        return step;
-    }
-    /**
-     * @summary Method to create a DynamoDB put item step
-     * @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) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        const step = new DynamoPutItem(scope, `${props.name}`, {
-            ...props,
-            comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
-            item: tableItem,
-            table,
-        });
-        let retries = props.retries;
-        if (!retries || retries.length === 0) {
-            retries = DEFAULT_RETRY_CONFIG;
-        }
-        _.forEach(retries, retry => {
-            step.addRetry({
-                ...retry,
-                ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
-            });
-        });
-        return step;
-    }
-    /**
-     * @summary Method to create a DynamoDB delete item step
-     * @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) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        const step = new DynamoDeleteItem(scope, `${props.name}`, {
-            ...props,
-            comment: `DynamoDB DeleteItem step for ${props.name} - ${scope.props.stage} stage`,
-            key: tableKey,
-            table,
-        });
-        let retries = props.retries;
-        if (!retries || retries.length === 0) {
-            retries = DEFAULT_RETRY_CONFIG;
-        }
-        _.forEach(retries, retry => {
-            step.addRetry({
-                ...retry,
-                ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
-            });
-        });
-        return step;
-    }
-    /**
-     * @summary Method to send a message to SQS step
-     * @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)
-            throw `Step props undefined for ${id}`;
-        if (!props.messageBody)
-            throw 'Message body undefined';
-        const step = new SqsSendMessage(scope, `${props.name}`, {
-            ...props,
-            comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
-            queue,
-        });
-        let retries = props.retries;
-        if (!retries || retries.length === 0) {
-            retries = DEFAULT_RETRY_CONFIG;
-        }
-        _.forEach(retries, retry => {
-            step.addRetry({
-                ...retry,
-                interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval,
-            });
-        });
-        return step;
-    }
-    /**
-     * @summary Method to create a lambda invoke step
-     * @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)
-            throw `Step props undefined for ${id}`;
-        const step = new LambdaInvoke(scope, `${props.name}`, {
-            ...props,
-            comment: `Lambda step for ${props.name} - ${scope.props.stage} stage`,
-            lambdaFunction,
-        });
-        let retries = props.retries;
-        if (!retries || retries.length === 0) {
-            retries = DEFAULT_RETRY_CONFIG;
-        }
-        _.forEach(retries, retry => {
-            step.addRetry({
-                ...retry,
-                interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval,
-            });
-        });
-        return step;
-    }
-    /**
-     * @summary Method to create a lambda invoke step
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props
-     * @param lambdaFunction
-     * @param skipExecution
-     */
-    createSkippableLambdaStep(id, scope, props, lambdaFunction, skipExecution) {
-        if (!props)
-            throw `Step props undefined for ${id}`;
-        if (skipExecution)
-            return this.createPassStep(id, scope, { comment: props.comment, name: props.name });
-        const step = new LambdaInvoke(scope, `${props.name}`, {
-            ...props,
-            comment: `Lambda step for ${props.name} - ${scope.props.stage} stage`,
-            lambdaFunction,
-        });
-        let retries = props.retries;
-        if (!retries || retries.length === 0) {
-            retries = DEFAULT_RETRY_CONFIG;
-        }
-        _.forEach(retries, retry => {
-            step.addRetry({
-                ...retry,
-                interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval,
-            });
-        });
-        return step;
-    }
-    /**
-     * @summary Method to create a API Gateway invoke step
-     * @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)
-            throw `Step props undefined for ${id}`;
-        const step = new CallApiGatewayRestApiEndpoint(scope, `${props.name}`, {
-            ...props,
-            api,
-            comment: `API step for ${props.name} - ${scope.props.stage} stage`,
-            stageName: scope.props.stage,
-        });
-        let retries = props.retries;
-        if (!retries || retries.length === 0) {
-            retries = DEFAULT_RETRY_CONFIG;
-        }
-        _.forEach(retries, retry => {
-            step.addRetry({
-                ...retry,
-                interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval,
-            });
-        });
-        return step;
-    }
-    /**
-     * @summary Method to create a step function execution step
-     * @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 StepFunctionsStartExecution(scope, `${id}`, {
-            ...props,
-            associateWithParent: props.associateWithParent ?? true,
-            name: props.name ?? uuidv4(),
-            stateMachine,
-        });
-        let retries = props.retries;
-        if (!retries || retries.length === 0) {
-            retries = DEFAULT_RETRY_CONFIG;
-        }
-        _.forEach(retries, retry => {
-            step.addRetry({
-                ...retry,
-                interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval,
-            });
-        });
-        return step;
-    }
-    /**
-     * @summary Method to create a step function 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 Map(scope, `${id}`, props);
-    }
-    /**
-     * @summary Method to create a state machine
-     * @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}`;
-        if (!props.stateMachineName)
-            throw `State Machine stateMachineName undefined for ${id}`;
-        const stateMachine = new StateMachine(scope, `${id}`, {
-            ...props,
-            definitionBody: DefinitionBody.fromChainable(definition),
-            logs: {
-                destination: logGroup,
-                includeExecutionData: props.logs?.includeExecutionData ?? true,
-                level: props.logs?.level ?? LogLevel.ALL,
-            },
-            role,
-            stateMachineName: scope.resourceNameFormatter.format(props.stateMachineName, scope.props.resourceNameOptions?.stepFunction),
-        });
-        createCfnOutput(`${id}-stateMachineName`, scope, stateMachine.stateMachineName);
-        createCfnOutput(`${id}-stateMachineArn`, scope, stateMachine.stateMachineArn);
-        return stateMachine;
-    }
-}

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

@@ -1,88 +0,0 @@
-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';
-/**
- */
-export interface SfnSucceedProps extends SucceedProps {
-    name: string;
-}
-/**
- */
-export interface SfnRetryProps extends RetryProps {
-    intervalInSecs: number;
-}
-/**
- */
-export interface SfnFailProps extends FailProps {
-    name: string;
-}
-/**
- */
-export interface SfnPassProps extends PassProps {
-    name: string;
-}
-/**
- */
-export interface SfnDynamoGetItemProps extends DynamoGetItemProps {
-    name: string;
-    retries?: SfnRetryProps[];
-}
-/**
- */
-export interface SfnDynamoPutItemProps extends DynamoPutItemProps {
-    name: string;
-    retries?: SfnRetryProps[];
-}
-/**
- */
-export interface SfnDynamoDeleteItemProps extends DynamoDeleteItemProps {
-    name: string;
-    retries?: SfnRetryProps[];
-}
-/**
- */
-export interface SfnSqsSendMessageProps extends SqsSendMessageProps {
-    name: string;
-    retries?: SfnRetryProps[];
-}
-/**
- */
-export interface SfnParallelProps extends ParallelProps {
-    name: string;
-    retries?: SfnRetryProps[];
-}
-/**
- */
-export interface SfnChoiceProps extends ChoiceProps {
-    name: string;
-}
-/**
- */
-export interface SfnWaitProps extends WaitProps {
-    name: string;
-    delayInSeconds: number;
-}
-/**
- */
-export interface SfnLambdaInvokeProps extends LambdaInvokeProps {
-    name: string;
-    retries?: SfnRetryProps[];
-}
-/**
- */
-export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRestApiEndpointProps {
-    name: string;
-    retries?: SfnRetryProps[];
-}
-/**
- */
-export interface SfnStateMachineProps extends StateMachineProps {
-}
-/**
- */
-export interface SfnMapProps extends MapProps {
-}
-/**
- */
-export interface SfnStartExecutionProps extends StepFunctionsStartExecutionProps {
-    retries?: SfnRetryProps[];
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

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

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

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

@@ -1,55 +0,0 @@
-import { StringParameter } from 'aws-cdk-lib/aws-ssm';
-import { AwsCustomResource } from 'aws-cdk-lib/custom-resources';
-import { CommonConstruct } from '../../common/index.js';
-import { SSMParameterReaderProps, SSMStringParameterProps } from './types.js';
-/**
- * @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.
- * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     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 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: SSMStringParameterProps): StringParameter;
-    /**
-     * Method to read a string parameter from the parameters store
-     * @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 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;
-}
-/**
- * @classdesc Provides utilities to read same/cross region SSM parameters
- */
-export declare class SSMParameterReader extends AwsCustomResource {
-    constructor(scope: CommonConstruct, name: string, props: SSMParameterReaderProps);
-    /**
-     *
-     */
-    getParameterValue(): string;
-}

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

@@ -1,97 +0,0 @@
-import { StringParameter } from 'aws-cdk-lib/aws-ssm';
-import { AwsCustomResource, AwsCustomResourcePolicy, PhysicalResourceId, } from 'aws-cdk-lib/custom-resources';
-import { createCfnOutput } from '../../utils/index.js';
-/**
- * @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.
- * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     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 class SsmManager {
-    static SECRETS_MODIFIED_TIMESTAMP_PARAM = 'secrets-last-modified-timestamp';
-    /**
-     * Method to write a string parameter to the parameters store
-     * @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}`;
-        if (!props.parameterName)
-            throw `Parameter parameterName undefined for ${id}`;
-        const parameter = new StringParameter(scope, `${id}`, {
-            ...props,
-            description: `${props.description} - ${scope.props.stage} stage`,
-            parameterName: scope.resourceNameFormatter.format(props.parameterName, scope.props.resourceNameOptions?.ssm),
-        });
-        createCfnOutput(`${id}-parameterArn`, scope, parameter.parameterArn);
-        createCfnOutput(`${id}-parameterName`, scope, parameter.parameterName);
-        return parameter;
-    }
-    /**
-     * Method to read a string parameter from the parameters store
-     * @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 == '')
-            throw 'Invalid parameter name';
-        return StringParameter.valueFromLookup(scope, scope.resourceNameFormatter.format(parameterName, scope.props.resourceNameOptions?.ssm));
-    }
-    /**
-     * Method to read a string parameter from the parameters store in a given region
-     * @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 == '')
-            throw `Invalid parameter name for ${id}`;
-        if (!region || region == '')
-            throw `Invalid region for ${id}`;
-        return new SSMParameterReader(scope, `${id}`, {
-            parameterName: scope.resourceNameFormatter.format(parameterName, scope.props.resourceNameOptions?.ssm),
-            region,
-        }).getParameterValue();
-    }
-}
-/**
- * @classdesc Provides utilities to read same/cross region SSM parameters
- */
-export class SSMParameterReader extends AwsCustomResource {
-    constructor(scope, name, props) {
-        const { parameterName, region } = props;
-        const ssmAwsSdkCall = {
-            action: 'getParameter',
-            parameters: {
-                Name: parameterName,
-            },
-            physicalResourceId: PhysicalResourceId.of(Date.now().toString()),
-            region,
-            service: 'SSM',
-        };
-        super(scope, name, {
-            onUpdate: ssmAwsSdkCall,
-            policy: AwsCustomResourcePolicy.fromSdkCalls({ resources: AwsCustomResourcePolicy.ANY_RESOURCE }),
-        });
-    }
-    /**
-     *
-     */
-    getParameterValue() {
-        return this.getResponseField('Parameter.Value');
-    }
-}

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

@@ -1,9 +0,0 @@
-import { StringParameterProps } from 'aws-cdk-lib/aws-ssm';
-/**
- */
-export interface SSMParameterReaderProps {
-    parameterName: string;
-    region: string;
-}
-export interface SSMStringParameterProps extends StringParameterProps {
-}

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

@@ -1 +0,0 @@
-export {};

package/dist/src/lib/aws/services/virtual-private-cloud/index.d.ts

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

package/dist/src/lib/aws/services/virtual-private-cloud/index.js

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

package/dist/src/lib/aws/services/virtual-private-cloud/ipv6.d.ts

@@ -1,7 +0,0 @@
-import { Vpc } from 'aws-cdk-lib/aws-ec2';
-import { CommonConstruct } from '../../common/index.js';
-import { VpcProps } from './types.js';
-export declare class Ipv6Vpc extends Vpc {
-    egressOnlyInternetGatewayId: string;
-    constructor(scope: CommonConstruct, id: string, props: VpcProps);
-}