@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/dist/src/lib/services/aws/simple-storage-service/main.js

@@ -30,9 +30,6 @@ const s3 = __importStar(require("aws-cdk-lib/aws-s3"));
 const s3deploy = __importStar(require("aws-cdk-lib/aws-s3-deployment"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.s3-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS S3.
  * - 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.
@@ -46,14 +43,12 @@ const utils = __importStar(require("../../../utils"));
  *     this.s3Manager.createS3Bucket('MyBucket', this)
  *   }
  * }
- *
  * @see [CDK S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
  */
 class S3Manager {
     /**
      * @summary Method to determine S3 Bucket lifecycle properties
-     * @param {S3BucketProps} props bucket properties
-     * @private
+     * @param props bucket properties
      */
     determineBucketLifecycleRules(props) {
         if (!props.lifecycleRules)
@@ -61,37 +56,35 @@ class S3Manager {
         const bucketLifecycleRules = [];
         props.lifecycleRules.forEach(lifecycleRule => {
             bucketLifecycleRules.push({
-                id: lifecycleRule.id,
-                enabled: lifecycleRule.enabled,
                 abortIncompleteMultipartUploadAfter: lifecycleRule.abortIncompleteMultipartUploadAfter,
-                expirationDate: lifecycleRule.expirationDate,
+                enabled: lifecycleRule.enabled,
                 expiration: lifecycleRule.expirationInDays ? cdk.Duration.days(lifecycleRule.expirationInDays) : undefined,
+                expirationDate: lifecycleRule.expirationDate,
+                expiredObjectDeleteMarker: lifecycleRule.expiredObjectDeleteMarker,
+                id: lifecycleRule.id,
                 noncurrentVersionExpiration: lifecycleRule.noncurrentVersionExpirationInDays
                     ? cdk.Duration.days(lifecycleRule.noncurrentVersionExpirationInDays)
                     : undefined,
                 noncurrentVersionTransitions: lifecycleRule.noncurrentVersionTransitions,
-                transitions: lifecycleRule.transitions,
                 prefix: lifecycleRule.prefix,
                 tagFilters: lifecycleRule.tagFilters,
-                expiredObjectDeleteMarker: lifecycleRule.expiredObjectDeleteMarker,
+                transitions: lifecycleRule.transitions,
             });
         });
         return bucketLifecycleRules;
     }
     /**
      * @summary Method to determine the bucket name using account and region
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} bucketName the bucket name
-     * @protected
+     * @param scope scope in which this resource is defined
+     * @param bucketName the bucket name
      */
     static determineBucketNameByAccountAndRegion(scope, bucketName) {
         return `${bucketName}-${cdk.Stack.of(scope).account}-${scope.props.region}-${scope.props.stage}`;
     }
     /**
      * @summary Method to determine the bucket name using domain name
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} bucketName the bucket name
-     * @protected
+     * @param scope scope in which this resource is defined
+     * @param bucketName the bucket name
      */
     static determineBucketNameByDomainName(scope, bucketName) {
         return scope.isProductionStage()
@@ -100,9 +93,8 @@ class S3Manager {
     }
     /**
      * @summary Method to determine the bucket name
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} bucketName the bucket name
-     * @private
+     * @param scope scope in which this resource is defined
+     * @param bucketName the bucket name
      */
     static determineBucketName(scope, bucketName) {
         return scope.props.excludeDomainNameForBuckets
@@ -111,9 +103,9 @@ class S3Manager {
     }
     /**
      * @summary Method to create a s3 bucket
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {S3BucketProps} props bucket properties
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props bucket properties
      */
     createS3Bucket(id, scope, props) {
         if (!props)
@@ -144,10 +136,10 @@ class S3Manager {
                 removalPolicy: props.removalPolicy || cdk.RemovalPolicy.RETAIN,
                 serverAccessLogsBucket: logBucket,
                 serverAccessLogsPrefix: props.serverAccessLogsPrefix,
-                websiteIndexDocument: props.websiteIndexDocument,
+                versioned: props.versioned,
                 websiteErrorDocument: props.websiteErrorDocument,
+                websiteIndexDocument: props.websiteIndexDocument,
                 websiteRoutingRules: props.websiteRoutingRules,
-                versioned: props.versioned,
             });
             const cfnBucket = bucket.node.defaultChild;
             cfnBucket.notificationConfiguration = {
@@ -167,9 +159,9 @@ class S3Manager {
     }
     /**
      * @summary Method to create an iam bucket policy for cloudtrail
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {s3.IBucket} bucket
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param bucket
      */
     createBucketPolicyForCloudTrail(id, scope, bucket) {
         const bucketPolicyDocument = new iam.PolicyDocument({
@@ -197,13 +189,13 @@ class S3Manager {
     }
     /**
      * @summary Method to create a s3 bucket deployment
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {s3.IBucket} siteBucket
-     * @param {cloudfront.IDistribution} distribution
-     * @param {s3deploy.ISource[]} sources
-     * @param {string} prefix
-     * @param {boolean} prune
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param siteBucket
+     * @param distribution
+     * @param sources
+     * @param prefix
+     * @param prune
      */
     doBucketDeployment(id, scope, siteBucket, distribution, sources, prefix, prune) {
         new s3deploy.BucketDeployment(scope, `${id}`, {
@@ -219,10 +211,10 @@ class S3Manager {
     }
     /**
      *
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {s3.IBucket} bucket bucket to create the folders in
-     * @param {string[]} folders list of folder names to be created in the bucket
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param bucket bucket to create the folders in
+     * @param folders list of folder names to be created in the bucket
      */
     createBucketFolders(id, scope, bucket, folders) {
         if (!folders || folders.length == 0) {
@@ -232,8 +224,8 @@ class S3Manager {
             new s3deploy.BucketDeployment(scope, `${id}-${folder}`, {
                 destinationBucket: bucket,
                 destinationKeyPrefix: folder,
-                sources: [s3deploy.Source.data('README.md', `This is the ${folder} folder for ${id}`)],
                 prune: false,
+                sources: [s3deploy.Source.data('README.md', `This is the ${folder} folder for ${id}`)],
             });
         });
     }

package/dist/src/lib/services/aws/simple-storage-service/types.d.ts

@@ -2,30 +2,24 @@ import { TagProps } from '../../../types';
 import * as s3 from 'aws-cdk-lib/aws-s3';
 import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment';
 /**
- * @category cdk-utils.s3-manager
- * @subcategory Properties
  */
 export interface LifecycleRule extends s3.LifecycleRule {
     expirationInDays?: number;
     noncurrentVersionExpirationInDays?: number;
 }
 /**
- * @category cdk-utils.s3-manager
- * @subcategory Properties
  */
 export interface BucketDeploymentProps extends s3deploy.BucketDeploymentProps {
     expirationInDays?: number;
     noncurrentVersionExpirationInDays?: number;
 }
 /**
- * @category cdk-utils.s3-manager
- * @subcategory Properties
  */
 export interface S3BucketProps extends s3.BucketProps {
+    bucketName: string;
     enableEventBridge?: boolean;
+    existingBucket?: boolean;
     lifecycleRules?: LifecycleRule[];
-    bucketName: string;
     logBucketName?: string;
-    existingBucket?: boolean;
     tags?: TagProps[];
 }

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

@@ -10,9 +10,6 @@ import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
 import { CommonConstruct } from '../../../common';
 import { SfnCallApiGatewayRestApiEndpointProps, SfnChoiceProps, SfnDynamoDeleteItemProps, SfnDynamoGetItemProps, SfnDynamoPutItemProps, SfnFailProps, SfnLambdaInvokeProps, SfnMapProps, SfnParallelProps, SfnPassProps, SfnSqsSendMessageProps, SfnStartExecutionProps, SfnStateMachineProps, SfnSucceedProps, SfnWaitProps } from './types';
 /**
- * @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.
@@ -26,58 +23,57 @@ import { SfnCallApiGatewayRestApiEndpointProps, SfnChoiceProps, SfnDynamoDeleteI
  *     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 declare 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: string, scope: CommonConstruct, props: SfnSucceedProps): cdk.aws_stepfunctions.Succeed;
     /**
      * @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: string, scope: CommonConstruct, props: SfnFailProps): cdk.aws_stepfunctions.Fail;
     /**
      * @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: string, scope: CommonConstruct, props: SfnPassProps): cdk.aws_stepfunctions.Pass;
     /**
      * @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: string, scope: CommonConstruct, props: SfnParallelProps): cdk.aws_stepfunctions.Parallel;
     /**
      * @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: string, scope: CommonConstruct, props: SfnChoiceProps): cdk.aws_stepfunctions.Choice;
     /**
      * @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: string, scope: CommonConstruct, props: SfnWaitProps): cdk.aws_stepfunctions.Wait;
     /**
      * @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: string, scope: CommonConstruct, props: SfnDynamoGetItemProps, table: dynamodb.ITable, tableKey: {
@@ -85,10 +81,10 @@ export declare class SfnManager {
     }): cdk.aws_stepfunctions_tasks.DynamoGetItem;
     /**
      * @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: string, scope: CommonConstruct, props: SfnDynamoPutItemProps, table: dynamodb.ITable, tableItem: {
@@ -96,10 +92,10 @@ export declare class SfnManager {
     }): cdk.aws_stepfunctions_tasks.DynamoPutItem;
     /**
      * @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: string, scope: CommonConstruct, props: SfnDynamoDeleteItemProps, table: dynamodb.ITable, tableKey: {
@@ -107,51 +103,51 @@ export declare class SfnManager {
     }): cdk.aws_stepfunctions_tasks.DynamoDeleteItem;
     /**
      * @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: string, scope: CommonConstruct, props: SfnSqsSendMessageProps, queue: sqs.IQueue): cdk.aws_stepfunctions_tasks.SqsSendMessage;
     /**
      * @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: string, scope: CommonConstruct, props: SfnLambdaInvokeProps, lambdaFunction: lambda.IFunction): cdk.aws_stepfunctions_tasks.LambdaInvoke;
     /**
      * @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: string, scope: CommonConstruct, props: SfnCallApiGatewayRestApiEndpointProps, api: apig.IRestApi): cdk.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpoint;
     /**
      * @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: string, scope: CommonConstruct, props: SfnStartExecutionProps, stateMachine: sfn.IStateMachine): cdk.aws_stepfunctions_tasks.StepFunctionsStartExecution;
     /**
      * @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: string, scope: CommonConstruct, props: SfnMapProps): cdk.aws_stepfunctions.Map;
     /**
      * @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: string, scope: CommonConstruct, props: SfnStateMachineProps, definition: sfn.IChainable, logGroup: logs.ILogGroup, role?: iam.IRole): cdk.aws_stepfunctions.StateMachine;
 }