@gradientedge/cdk-utils 10.8.0 → 11.0.0

package/src/lib/aws/services/eventbridge/target.ts

@@ -1,84 +0,0 @@
-import { ArnFormat, Stack } from 'aws-cdk-lib'
-import { IRule, IRuleTarget, RuleTargetConfig, RuleTargetInput } from 'aws-cdk-lib/aws-events'
-import { TargetBaseProps, bindBaseTargetConfig } from 'aws-cdk-lib/aws-events-targets'
-import { ILogGroup } from 'aws-cdk-lib/aws-logs'
-import { CommonConstruct } from '../../common/index.js'
-
-/**
- * @classdesc Provides operations on AWS EventBridge Targets
- * - 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.eventTargetManager.createCloudWatchLogGroupNoPolicy('MyLogGrouptarget', this, myLogGroup)
- *   }
- * }
- * @see [CDK EventBridge Target Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets-readme.html}
- */
-export class EventTargetManager {
-  /**
-   * @summary Method to create a cloud watch log group target without a policy.
-   * - This method is created as a workaround for cdk issue - https://github.com/aws/aws-cdk/issues/17002
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param logGroup the log group
-   * @param props the log group target properties
-   */
-  public createCloudWatchLogGroupNoPolicy(
-    id: string,
-    scope: CommonConstruct,
-    logGroup: ILogGroup,
-    props?: LogGroupNoPolicyProps
-  ) {
-    return new CloudWatchLogGroupNoPolicy(logGroup, props)
-  }
-}
-
-/**
- * Customize the CloudWatch LogGroup Event Target
- */
-export interface LogGroupNoPolicyProps extends TargetBaseProps {
-  /**
-   * The event to send to the CloudWatch LogGroup
-   *
-   * This will be the event logged into the CloudWatch LogGroup
-   * @default - the entire EventBridge event
-   */
-  readonly event?: RuleTargetInput
-}
-
-/**
- * Use an AWS CloudWatch LogGroup as an event rule target, but don't apply a policy.
- */
-export class CloudWatchLogGroupNoPolicy implements IRuleTarget {
-  constructor(
-    private readonly logGroup: ILogGroup,
-    private readonly props: LogGroupNoPolicyProps = {}
-  ) {}
-
-  /**
-   * Returns a RuleTarget that can be used to log an event into a CloudWatch LogGroup
-   * @param _rule
-   * @param _id
-   */
-  public bind(_rule: IRule, _id?: string): RuleTargetConfig {
-    const logGroupStack = Stack.of(this.logGroup)
-
-    return {
-      ...bindBaseTargetConfig(this.props),
-      arn: logGroupStack.formatArn({
-        arnFormat: ArnFormat.COLON_RESOURCE_NAME,
-        resource: 'log-group',
-        resourceName: this.logGroup.logGroupName,
-        service: 'logs',
-      }),
-      input: this.props.event,
-      targetResource: this.logGroup,
-    }
-  }
-}

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

@@ -1,48 +0,0 @@
-import { CfnRuleProps, EventBusProps as EBProps, RuleProps as EBRuleProps } from 'aws-cdk-lib/aws-events'
-import { CfnPipeProps } from 'aws-cdk-lib/aws-pipes'
-import { TagProps } from '../../types/index.js'
-
-/**
- */
-export interface SqsToSfnPipeProps extends CfnPipeProps {
-  pipeFilterPattern?: any
-  sfnInputTemplate?: string
-  sfnInvocationType?: string
-  sqsBatchSize?: number
-  sqsMaximumBatchingWindowInSeconds?: number
-}
-
-/**
- */
-export interface SqsToLambdaPipeProps extends CfnPipeProps {
-  pipeFilterPattern?: any
-  sqsBatchSize?: number
-  lambdaInputTemplate?: string
-  sqsMaximumBatchingWindowInSeconds?: number
-}
-
-/**
- */
-export interface EventRuleProps extends EBRuleProps {
-  tags?: TagProps[]
-}
-
-/**
- */
-export interface RuleProps extends CfnRuleProps {
-  input?: string
-  tags?: TagProps[]
-}
-
-/**
- */
-export interface EventBusProps extends EBProps {}
-
-/**
- }
- */
-export interface DynamoDbToLambdaPipeProps extends CfnPipeProps {
-  pipeFilterPattern?: any
-  dynamoDbBatchSize?: number
-  dynamoDbStartingPosition: string
-}

package/src/lib/aws/services/evidently/index.ts

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

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

@@ -1,123 +0,0 @@
-import { CfnExperiment, CfnFeature, CfnLaunch, CfnProject, CfnSegment } from 'aws-cdk-lib/aws-evidently'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import {
-  EvidentlyExperimentProps,
-  EvidentlyFeatureProps,
-  EvidentlyLaunchProps,
-  EvidentlyProjectProps,
-  EvidentlySegmentProps,
-} from './types.js'
-
-/**
- * @classdesc Provides operations on AWS Evidently
- * - 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.evidentlyManager.createProject('MyNewProhect', this, props)
- *   }
- * }
- * @see [CDK Evidently Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_evidently-readme.html}
- */
-export class EvidentlyManager {
-  /**
-   * @summary Method to create a project
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props the project properties
-   */
-  public createProject(id: string, scope: CommonConstruct, props: EvidentlyProjectProps) {
-    if (!props) throw `EvidentlyProject props undefined for ${id}`
-    if (!props.name) throw `EvidentlyProject name undefined for ${id}`
-
-    const project = new CfnProject(scope, `${id}`, {
-      ...props,
-      description: `${props.description} ${scope.props.stage}`,
-      name: scope.resourceNameFormatter.format(props.name, scope.props.resourceNameOptions?.evidentlyProject),
-    })
-    createCfnOutput(`${id}-projectArn`, scope, project.attrArn)
-    createCfnOutput(`${id}-projectName`, scope, project.name)
-    return project
-  }
-
-  /**
-   * @summary Method to create a feature
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props the feature properties
-   */
-  public createFeature(id: string, scope: CommonConstruct, props: EvidentlyFeatureProps) {
-    if (!props) throw `EvidentlyFeature props undefined for ${id}`
-
-    const feature = new CfnFeature(scope, `${id}`, props)
-    createCfnOutput(`${id}-featureArn`, scope, feature.attrArn)
-    createCfnOutput(`${id}-featureName`, scope, feature.name)
-    return feature
-  }
-
-  /**
-   * @summary Method to create a launch
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props the launch properties
-   */
-  public createLaunch(id: string, scope: CommonConstruct, props: EvidentlyLaunchProps) {
-    if (!props) throw `EvidentlyLaunch props undefined for ${id}`
-    if (!props.name) throw `EvidentlyLaunch name undefined for ${id}`
-
-    const launch = new CfnLaunch(scope, `${id}`, {
-      ...props,
-      description: `${props.description} ${scope.props.stage}`,
-      name: scope.resourceNameFormatter.format(props.name, scope.props.resourceNameOptions?.evidentlyLaunch),
-    })
-    createCfnOutput(`${id}-launchArn`, scope, launch.attrArn)
-    createCfnOutput(`${id}-launchName`, scope, launch.name)
-    return launch
-  }
-
-  /**
-   * @summary Method to create an experiment
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props the experiment properties
-   */
-  public createExperiment(id: string, scope: CommonConstruct, props: EvidentlyExperimentProps) {
-    if (!props) throw `EvidentlyExperiment props undefined for ${id}`
-    if (!props.name) throw `EvidentlyExperiment name undefined for ${id}`
-
-    const experiment = new CfnExperiment(scope, `${id}`, {
-      ...props,
-      description: `${props.description} ${scope.props.stage}`,
-      name: scope.resourceNameFormatter.format(props.name, scope.props.resourceNameOptions?.evidentlyExperiment),
-    })
-    createCfnOutput(`${id}-experimentArn`, scope, experiment.attrArn)
-    createCfnOutput(`${id}-experimentName`, scope, experiment.name)
-    return experiment
-  }
-
-  /**
-   * @summary Method to create a segment
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props the segment properties
-   */
-  public createSegment(id: string, scope: CommonConstruct, props: EvidentlySegmentProps) {
-    if (!props) throw `EvidentlySegment props undefined for ${id}`
-    if (!props.name) throw `EvidentlySegment name undefined for ${id}`
-
-    const segment = new CfnSegment(scope, `${id}`, {
-      ...props,
-      description: `${props.description} ${scope.props.stage}`,
-      name: scope.resourceNameFormatter.format(props.name, scope.props.resourceNameOptions?.evidentlySegment),
-    })
-    createCfnOutput(`${id}-segmentArn`, scope, segment.attrArn)
-    createCfnOutput(`${id}-segmentName`, scope, segment.name)
-    return segment
-  }
-}

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

@@ -1,27 +0,0 @@
-import {
-  CfnExperimentProps,
-  CfnFeatureProps,
-  CfnLaunchProps,
-  CfnProjectProps,
-  CfnSegmentProps,
-} from 'aws-cdk-lib/aws-evidently'
-
-/**
- */
-export interface EvidentlyProjectProps extends CfnProjectProps {}
-
-/**
- */
-export interface EvidentlyFeatureProps extends CfnFeatureProps {}
-
-/**
- */
-export interface EvidentlyLaunchProps extends CfnLaunchProps {}
-
-/**
- */
-export interface EvidentlyExperimentProps extends CfnExperimentProps {}
-
-/**
- */
-export interface EvidentlySegmentProps extends CfnSegmentProps {}

package/src/lib/aws/services/identity-access-management/index.ts

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