@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/src/lib/services/aws/cloudfront/main.ts

@@ -14,9 +14,6 @@ import { CloudfrontFunctionProps, CloudFrontProps, DistributionProps } from './t
 import { LambdaEdgeProps } from '../lambda'
 
 /**
- * @stability stable
- * @category cdk-utils.cloudfront-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS CloudFront.
  * - 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.
@@ -37,7 +34,6 @@ import { LambdaEdgeProps } from '../lambda'
  *     )
  *   }
  * }
- *
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
  */
 export class CloudFrontManager {
@@ -52,14 +48,14 @@ export class CloudFrontManager {
 
   /**
    * @summary Method to create a cloudfront distribution
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudFrontProps} props distribution properties
-   * @param {s3.IBucket?} siteBucket
-   * @param {s3.IBucket?} logBucket
-   * @param {cloudfront.OriginAccessIdentity?} oai
-   * @param {acm.ICertificate?} certificate
-   * @param {string[]?} aliases
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props distribution properties
+   * @param siteBucket
+   * @param logBucket
+   * @param oai
+   * @param certificate
+   * @param aliases
    */
   public createCloudFrontDistribution(
     id: string,
@@ -78,8 +74,8 @@ export class CloudFrontManager {
     const distribution = new cloudfront.CloudFrontWebDistribution(scope, `${id}`, {
       comment: `${id} - ${scope.props.stage} stage`,
       defaultRootObject: props.defaultRootObject,
-      enabled: props.enabled ?? true,
       enableIpV6: props.enableIpV6,
+      enabled: props.enabled ?? true,
       errorConfigurations: props.errorConfigurations,
       geoRestriction: props.geoRestriction,
       httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
@@ -89,11 +85,11 @@ export class CloudFrontManager {
       },
       originConfigs: [
         {
+          behaviors: [{ isDefaultBehavior: true }],
           s3OriginSource: {
-            s3BucketSource: siteBucket,
             originAccessIdentity: oai,
+            s3BucketSource: siteBucket,
           },
-          behaviors: [{ isDefaultBehavior: true }],
         },
       ],
       priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
@@ -119,16 +115,16 @@ export class CloudFrontManager {
 
   /**
    * Method to create a CloudFront distribution with S3 Origin
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {DistributionProps} props distribution properties
-   * @param {origins.S3Origin} origin
-   * @param {s3.IBucket} siteBucket
-   * @param {s3.IBucket?} logBucket
-   * @param {cloudfront.OriginAccessIdentity?} oai
-   * @param {acm.ICertificate?} certificate
-   * @param {string[]?} aliases
-   * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props distribution properties
+   * @param origin
+   * @param siteBucket
+   * @param logBucket
+   * @param oai
+   * @param certificate
+   * @param aliases
+   * @param defaultFunctionAssociations
    */
   public createDistributionWithS3Origin(
     id: string,
@@ -143,28 +139,28 @@ export class CloudFrontManager {
     defaultFunctionAssociations?: cloudfront.FunctionAssociation[]
   ) {
     const distribution = new cloudfront.Distribution(scope, `${id}`, {
+      additionalBehaviors: props.additionalBehaviors,
       certificate: certificate,
       comment: `${id} - ${scope.props.stage} stage`,
       defaultBehavior: {
         cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
+        edgeLambdas: props.defaultBehavior ? props.defaultBehavior.edgeLambdas : undefined,
+        functionAssociations: defaultFunctionAssociations ?? undefined,
         origin: origin,
         originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
-        functionAssociations: defaultFunctionAssociations ?? undefined,
         viewerProtocolPolicy: props.defaultBehavior ? props.defaultBehavior.viewerProtocolPolicy : undefined,
-        edgeLambdas: props.defaultBehavior ? props.defaultBehavior.edgeLambdas : undefined,
       },
-      additionalBehaviors: props.additionalBehaviors,
       defaultRootObject: props.defaultRootObject,
       domainNames: aliases,
-      enabled: props.enabled ?? true,
       enableIpv6: props.enableIpv6,
       enableLogging: props.enableLogging ?? true,
+      enabled: props.enabled ?? true,
       errorResponses: props.errorResponses,
       geoRestriction: props.geoRestriction,
       httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
       logBucket: logBucket,
-      logIncludesCookies: props.logIncludesCookies ?? true,
       logFilePrefix: props.logFilePrefix ?? `edge/`,
+      logIncludesCookies: props.logIncludesCookies ?? true,
       minimumProtocolVersion: props.minimumProtocolVersion ?? cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
       priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
       webAclId: props.webAclId,
@@ -184,15 +180,15 @@ export class CloudFrontManager {
 
   /**
    * Method to create a CloudFront distribution with HTTP Origin
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {DistributionProps} props distribution properties
-   * @param {origins.S3Origin} origin
-   * @param {string[]} domainNames
-   * @param {s3.IBucket?} logBucket
-   * @param {acm.ICertificate?} certificate
-   * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
-   * @param {cloudfront.IResponseHeadersPolicy?} responseHeadersPolicy
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props distribution properties
+   * @param origin
+   * @param domainNames
+   * @param logBucket
+   * @param certificate
+   * @param defaultFunctionAssociations
+   * @param responseHeadersPolicy
    */
   public createDistributionWithHttpOrigin(
     id: string,
@@ -206,29 +202,29 @@ export class CloudFrontManager {
     responseHeadersPolicy?: cloudfront.IResponseHeadersPolicy
   ) {
     const distribution = new cloudfront.Distribution(scope, `${id}`, {
+      additionalBehaviors: props.additionalBehaviors,
       certificate: certificate,
       comment: `${id} - ${scope.props.stage} stage`,
       defaultBehavior: {
         cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
+        edgeLambdas: props.defaultBehavior ? props.defaultBehavior.edgeLambdas : undefined,
+        functionAssociations: defaultFunctionAssociations ?? undefined,
         origin: origin,
         originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
-        functionAssociations: defaultFunctionAssociations ?? undefined,
-        viewerProtocolPolicy: props.defaultBehavior ? props.defaultBehavior.viewerProtocolPolicy : undefined,
         responseHeadersPolicy: responseHeadersPolicy ?? undefined,
-        edgeLambdas: props.defaultBehavior ? props.defaultBehavior.edgeLambdas : undefined,
+        viewerProtocolPolicy: props.defaultBehavior ? props.defaultBehavior.viewerProtocolPolicy : undefined,
       },
-      additionalBehaviors: props.additionalBehaviors,
       defaultRootObject: props.defaultRootObject,
       domainNames: domainNames,
-      enabled: props.enabled ?? true,
       enableIpv6: props.enableIpv6,
       enableLogging: props.enableLogging ?? true,
+      enabled: props.enabled ?? true,
       errorResponses: props.errorResponses,
       geoRestriction: props.geoRestriction,
       httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
       logBucket: logBucket,
-      logIncludesCookies: props.logIncludesCookies ?? true,
       logFilePrefix: props.logFilePrefix ?? `edge/`,
+      logIncludesCookies: props.logIncludesCookies ?? true,
       minimumProtocolVersion: props.minimumProtocolVersion ?? cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
       priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
       webAclId: props.webAclId,
@@ -248,18 +244,17 @@ export class CloudFrontManager {
 
   /**
    * @summary Method to provision a Lambda@Edge function
-   *
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LambdaEdgeProps} props lambda@edge properties
-   * @param {lambda.ILayerVersion[]} layers
-   * @param {lambda.AssetCode} code
-   * @param {iam.Role} role
-   * @param {Map<string, string>} environment
-   * @param {ec2.IVpc} vpc
-   * @param {ec2.ISecurityGroup[]} securityGroups
-   * @param {efs.IAccessPoint} accessPoint
-   * @param {string} mountPath
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props lambda@edge properties
+   * @param layers
+   * @param code
+   * @param role
+   * @param environment
+   * @param vpc
+   * @param securityGroups
+   * @param accessPoint
+   * @param mountPath
    */
   public createEdgeFunction(
     id: string,
@@ -327,7 +322,6 @@ export class CloudFrontManager {
   ) {
     new cr.AwsCustomResource(scope, `${id}-trigger-codebuild-${new Date().getTime()}`, {
       onCreate: {
-        service: 'CodeBuild',
         action: 'startBuild',
         parameters: {
           projectName: scope.codeBuildManager.createProjectForCloudfrontInvalidation(
@@ -339,6 +333,7 @@ export class CloudFrontManager {
           ).projectName,
         },
         physicalResourceId: cr.PhysicalResourceId.fromResponse('build.id'),
+        service: 'CodeBuild',
       },
       policy: cr.AwsCustomResourcePolicy.fromSdkCalls({ resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE }),
     })
@@ -346,10 +341,9 @@ export class CloudFrontManager {
 
   /**
    * @summary Method to provision a Cloudfront function
-   *
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudfrontFunctionProps} props
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props
    */
   public createCloudfrontFunction(id: string, scope: CommonConstruct, props: CloudfrontFunctionProps) {
     const cloudfrontFunction = new cloudfront.Function(scope, `${id}`, {

package/src/lib/services/aws/cloudfront/types.ts

@@ -3,26 +3,20 @@ import * as cf from 'aws-cdk-lib/aws-cloudfront'
 import { CloudFrontWebDistributionProps, FunctionProps } from 'aws-cdk-lib/aws-cloudfront'
 
 /**
- * @category cdk-utils.cloudfront-manager
- * @subcategory Properties
  */
 export interface CloudFrontProps extends CloudFrontWebDistributionProps {
   tags?: TagProps[]
 }
 
 /**
- * @category cdk-utils.cloudfront-manager
- * @subcategory Properties
  */
 export interface DistributionProps extends cf.DistributionProps {
   tags?: TagProps[]
 }
 
 /**
- * @category cdk-utils.cloudfront-manager
- * @subcategory Properties
  */
 export interface CloudfrontFunctionProps extends FunctionProps {
-  functionFilePath: string
   eventType: string
+  functionFilePath: string
 }

package/src/lib/services/aws/cloudtrail/main.ts

@@ -6,9 +6,6 @@ import { CommonConstruct } from '../../../common'
 import { CloudTrailProps } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.cloudtrail-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS CloudTrail.
  * - 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.
@@ -29,19 +26,18 @@ import { CloudTrailProps } from './types'
  *     )
  *   }
  * }
- *
  * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudtrail-readme.html}
  */
 export class CloudTrailManager {
   /**
    * @summary Method to create a cloud trail
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudTrailProps} props
-   * @param {logs.CfnLogGroup} logGroup
-   * @param {s3.IBucket} dataBucket
-   * @param {s3.IBucket} logBucket
-   * @param {s3.CfnBucketPolicy} logBucketPolicy
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props
+   * @param logGroup
+   * @param dataBucket
+   * @param logBucket
+   * @param logBucketPolicy
    */
   public createCloudTrail(
     id: string,
@@ -88,6 +84,6 @@ export class CloudTrailManager {
     utils.createCfnOutput(`${id}-trailName`, scope, cloudTrail.trailName)
     utils.createCfnOutput(`${id}-trailArn`, scope, cloudTrail.attrArn)
 
-    return { cloudTrailRole: role, cloudTrail }
+    return { cloudTrail, cloudTrailRole: role }
   }
 }

package/src/lib/services/aws/cloudtrail/types.ts

@@ -1,7 +1,5 @@
 import { CfnTrailProps } from 'aws-cdk-lib/aws-cloudtrail'
 
 /**
- * @category cdk-utils.cloudtrail-manager
- * @subcategory Properties
  */
 export interface CloudTrailProps extends CfnTrailProps {}

package/src/lib/services/aws/cloudwatch/logs.ts

@@ -5,9 +5,6 @@ import { CommonConstruct } from '../../../common'
 import { LogProps, MetricFilterProps } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.cloudwatch-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS CloudWatch.
  * - 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.
@@ -21,45 +18,44 @@ import { LogProps, MetricFilterProps } from './types'
  *     this.logsManager.createMetricFilter('MyMetricFilter', this, logGroup)
  *   }
  * }
- *
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
  */
 export class LogManager {
   /**
    * @summary Method to create a cloudwatch metric filter
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {MetricFilterProps} props
-   * @param {logs.ILogGroup} logGroup
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props
+   * @param logGroup
    */
   public createMetricFilter(id: string, scope: CommonConstruct, props: MetricFilterProps, logGroup: logs.ILogGroup) {
     if (!props) throw `MetricFilter props undefined for ${id}`
 
     const metricFilter = new logs.MetricFilter(scope, `${id}`, {
+      defaultValue: props.defaultValue,
+      filterPattern: props.filterPattern,
       logGroup: logGroup,
       metricName: props.metricName,
       metricNamespace: props.metricNamespace,
       metricValue: props.metricValue,
-      defaultValue: props.defaultValue,
-      filterPattern: props.filterPattern,
     })
 
     const metric = props.options
       ? metricFilter.metric({
           dimensionsMap: props.options.dimensionsMap,
-          statistic: props.options.statistic,
           period: props.periodInSecs ? cdk.Duration.seconds(props.periodInSecs) : cdk.Duration.minutes(5),
+          statistic: props.options.statistic,
         })
       : metricFilter.metric()
 
-    return { metricFilter, metric }
+    return { metric, metricFilter }
   }
 
   /**
    * @summary Method to create a cloudwatch log group (cfn)
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LogProps} props
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props
    */
   public createCfnLogGroup(id: string, scope: CommonConstruct, props: LogProps) {
     if (!props) throw `Logs props undefined for ${id}`
@@ -83,9 +79,9 @@ export class LogManager {
 
   /**
    * @summary Method to create a cloudwatch log group
-   * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LogProps} props
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props
    */
   public createLogGroup(id: string, scope: CommonConstruct, props: LogProps) {
     if (!props) throw `Logs props undefined for ${id}`
@@ -93,8 +89,8 @@ export class LogManager {
     const logGroup = new logs.LogGroup(scope, `${id}`, {
       ...props,
       logGroupName: `${props.logGroupName}-${scope.props.stage}`,
-      retention: props.retention,
       removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
+      retention: props.retention,
     })
 
     if (props.tags && props.tags.length > 0) {