@jaypie/constructs 1.1.53 → 1.1.54

package/dist/cjs/JaypieAccountLoggingBucket.d.ts

@@ -0,0 +1,60 @@
+import { BucketProps, IBucket } from "aws-cdk-lib/aws-s3";
+import { Construct } from "constructs";
+export interface JaypieAccountLoggingBucketProps extends BucketProps {
+    /**
+     * Optional construct ID
+     * @default "AccountLoggingBucket"
+     */
+    id?: string;
+    /**
+     * Bucket name
+     * @default `account-logging-stack-${PROJECT_NONCE}`
+     */
+    bucketName?: string;
+    /**
+     * The service tag value
+     * @default CDK.SERVICE.INFRASTRUCTURE
+     */
+    service?: string;
+    /**
+     * Optional project tag value
+     */
+    project?: string;
+    /**
+     * Number of days before logs expire
+     * @default 365
+     */
+    expirationDays?: number;
+    /**
+     * Number of days before transitioning to INFREQUENT_ACCESS storage
+     * @default 30
+     */
+    infrequentAccessTransitionDays?: number;
+    /**
+     * Number of days before transitioning to GLACIER storage
+     * @default 180
+     */
+    glacierTransitionDays?: number;
+    /**
+     * Whether to create CloudFormation output for bucket name
+     * @default true
+     */
+    createOutput?: boolean;
+    /**
+     * Custom export name for the bucket name output
+     * @default CDK.IMPORT.LOG_BUCKET
+     */
+    exportName?: string;
+    /**
+     * Description for the CloudFormation output
+     * @default "Account-wide logging bucket"
+     */
+    outputDescription?: string;
+}
+export declare class JaypieAccountLoggingBucket extends Construct {
+    readonly bucket: IBucket;
+    /**
+     * Create a new account-wide logging S3 bucket with lifecycle policies and export
+     */
+    constructor(scope: Construct, idOrProps?: string | JaypieAccountLoggingBucketProps, propsOrUndefined?: JaypieAccountLoggingBucketProps);
+}

package/dist/cjs/JaypieDatadogBucket.d.ts

@@ -0,0 +1,45 @@
+import { Policy } from "aws-cdk-lib/aws-iam";
+import { BucketProps, IBucket } from "aws-cdk-lib/aws-s3";
+import { Construct } from "constructs";
+export interface JaypieDatadogBucketProps extends BucketProps {
+    /**
+     * Optional construct ID
+     * @default "DatadogArchiveBucket"
+     */
+    id?: string;
+    /**
+     * The service tag value
+     * @default CDK.SERVICE.DATADOG
+     */
+    service?: string;
+    /**
+     * Optional project tag value
+     */
+    project?: string;
+    /**
+     * Whether to grant Datadog role access to this bucket
+     * Uses CDK_ENV_DATADOG_ROLE_ARN if set
+     * @default true
+     */
+    grantDatadogAccess?: boolean;
+}
+export declare class JaypieDatadogBucket extends Construct {
+    readonly bucket: IBucket;
+    readonly policy?: Policy;
+    /**
+     * Create a new S3 bucket for Datadog log archiving with automatic IAM permissions
+     */
+    constructor(scope: Construct, idOrProps?: string | JaypieDatadogBucketProps, propsOrUndefined?: JaypieDatadogBucketProps);
+    /**
+     * Grants the Datadog IAM role access to this bucket
+     *
+     * Checks for CDK_ENV_DATADOG_ROLE_ARN environment variable.
+     * If found, creates a custom policy with:
+     * - s3:ListBucket on bucket
+     * - s3:GetObject and s3:PutObject on bucket/*
+     *
+     * @param options - Configuration options
+     * @returns The created Policy, or undefined if CDK_ENV_DATADOG_ROLE_ARN is not set
+     */
+    private grantDatadogRoleBucketAccess;
+}

package/dist/cjs/JaypieDatadogForwarder.d.ts

@@ -0,0 +1,76 @@
+import { CfnStack } from "aws-cdk-lib";
+import { Rule } from "aws-cdk-lib/aws-events";
+import { IFunction } from "aws-cdk-lib/aws-lambda";
+import { Construct } from "constructs";
+export interface JaypieDatadogForwarderProps {
+    /**
+     * Optional construct ID
+     * @default "DatadogForwarder"
+     */
+    id?: string;
+    /**
+     * Datadog API key
+     * @default process.env.CDK_ENV_DATADOG_API_KEY
+     */
+    datadogApiKey?: string;
+    /**
+     * Account identifier for Datadog tags
+     * @default process.env.CDK_ENV_ACCOUNT
+     */
+    account?: string;
+    /**
+     * Reserved concurrency for the forwarder Lambda
+     * Must be a string as required by the CloudFormation template
+     * @default "10"
+     */
+    reservedConcurrency?: string;
+    /**
+     * Additional Datadog tags (comma-separated)
+     * Will be appended to account tag
+     */
+    additionalTags?: string;
+    /**
+     * The service tag value
+     * @default CDK.VENDOR.DATADOG
+     */
+    service?: string;
+    /**
+     * Optional project tag value
+     */
+    project?: string;
+    /**
+     * Whether to create CloudFormation events rule
+     * @default true
+     */
+    enableCloudFormationEvents?: boolean;
+    /**
+     * Whether to extend Datadog role with custom permissions
+     * Uses CDK_ENV_DATADOG_ROLE_ARN if set
+     * @default true
+     */
+    enableRoleExtension?: boolean;
+    /**
+     * Whether to create CloudFormation output for forwarder ARN
+     * @default true
+     */
+    createOutput?: boolean;
+    /**
+     * Custom export name for the forwarder ARN output
+     * @default CDK.IMPORT.DATADOG_LOG_FORWARDER
+     */
+    exportName?: string;
+    /**
+     * URL to Datadog forwarder CloudFormation template
+     * @default "https://datadog-cloudformation-template.s3.amazonaws.com/aws/forwarder/latest.yaml"
+     */
+    templateUrl?: string;
+}
+export declare class JaypieDatadogForwarder extends Construct {
+    readonly cfnStack: CfnStack;
+    readonly forwarderFunction: IFunction;
+    readonly eventsRule?: Rule;
+    /**
+     * Create a new Datadog forwarder with CloudFormation nested stack
+     */
+    constructor(scope: Construct, idOrProps?: string | JaypieDatadogForwarderProps, propsOrUndefined?: JaypieDatadogForwarderProps);
+}

package/dist/cjs/JaypieEventsRule.d.ts

@@ -0,0 +1,45 @@
+import { Rule, RuleProps } from "aws-cdk-lib/aws-events";
+import { IFunction } from "aws-cdk-lib/aws-lambda";
+import { Construct } from "constructs";
+export interface JaypieEventsRuleProps extends Omit<RuleProps, "targets"> {
+    /**
+     * Optional construct ID
+     * @default Generated from source or "EventsRule"
+     */
+    id?: string;
+    /**
+     * Event source(s) to match
+     * @default undefined
+     */
+    source?: string | string[];
+    /**
+     * Lambda function to target
+     * Can be:
+     * - An IFunction instance
+     * - undefined (will resolve Datadog forwarder)
+     * @default Resolves Datadog forwarder via resolveDatadogForwarderFunction
+     */
+    targetFunction?: IFunction;
+    /**
+     * The service tag value
+     * @default CDK.SERVICE.DATADOG
+     */
+    service?: string;
+    /**
+     * The vendor tag value
+     * @default CDK.VENDOR.DATADOG
+     */
+    vendor?: string;
+    /**
+     * Optional project tag value
+     */
+    project?: string;
+}
+export declare class JaypieEventsRule extends Construct {
+    readonly rule: Rule;
+    readonly targetFunction: IFunction;
+    /**
+     * Create a new EventBridge rule that targets a Lambda function
+     */
+    constructor(scope: Construct, idOrSourceOrProps?: string | JaypieEventsRuleProps, propsOrUndefined?: JaypieEventsRuleProps);
+}

package/dist/cjs/JaypieOrganizationTrail.d.ts

@@ -0,0 +1,62 @@
+import { IBucket } from "aws-cdk-lib/aws-s3";
+import { Trail } from "aws-cdk-lib/aws-cloudtrail";
+import { Construct } from "constructs";
+export interface JaypieOrganizationTrailProps {
+    /**
+     * Optional construct ID
+     * @default Generated from trail name
+     */
+    id?: string;
+    /**
+     * The name of the CloudTrail trail
+     * @default Uses PROJECT_NONCE: `organization-cloudtrail-${PROJECT_NONCE}`
+     */
+    trailName?: string;
+    /**
+     * The name of the S3 bucket for CloudTrail logs
+     * @default Uses PROJECT_NONCE: `organization-cloudtrail-${PROJECT_NONCE}`
+     */
+    bucketName?: string;
+    /**
+     * The service tag value
+     * @default CDK.SERVICE.INFRASTRUCTURE
+     */
+    service?: string;
+    /**
+     * Optional project tag value
+     */
+    project?: string;
+    /**
+     * Whether to enable file validation for the trail
+     * @default false
+     */
+    enableFileValidation?: boolean;
+    /**
+     * Number of days before logs expire
+     * @default 365
+     */
+    expirationDays?: number;
+    /**
+     * Number of days before transitioning to INFREQUENT_ACCESS storage
+     * @default 30
+     */
+    infrequentAccessTransitionDays?: number;
+    /**
+     * Number of days before transitioning to GLACIER storage
+     * @default 180
+     */
+    glacierTransitionDays?: number;
+    /**
+     * Whether to send S3 notifications to Datadog forwarder
+     * @default true
+     */
+    enableDatadogNotifications?: boolean;
+}
+export declare class JaypieOrganizationTrail extends Construct {
+    readonly bucket: IBucket;
+    readonly trail: Trail;
+    /**
+     * Create a new organization CloudTrail with S3 bucket and lifecycle policies
+     */
+    constructor(scope: Construct, idOrProps?: string | JaypieOrganizationTrailProps, propsOrUndefined?: JaypieOrganizationTrailProps);
+}

package/dist/cjs/constants.d.ts

@@ -0,0 +1,151 @@
+export declare const CDK: {
+    ACCOUNT: {
+        DEVELOPMENT: string;
+        MANAGEMENT: string;
+        OPERATIONS: string;
+        PRODUCTION: string;
+        SANDBOX: string;
+        SECURITY: string;
+        STAGE: string;
+    };
+    BUILD: {
+        CONFIG: {
+            ALL: string;
+            API: string;
+            INFRASTRUCTURE: string;
+            NONE: string;
+            WEB: string;
+        };
+        PERSONAL: string;
+        /**
+         * @deprecated rename "ephemeral" to "personal" (since 2/24/2025)
+         */
+        EPHEMERAL: string;
+        /**
+         * @deprecated as even "ephemeral" builds have static assets (since 7/6/2024)
+         */
+        STATIC: string;
+    };
+    CREATION: {
+        CDK: string;
+        CLOUDFORMATION_TEMPLATE: string;
+        MANUAL: string;
+    };
+    DATADOG: {
+        SITE: string;
+        LAYER: {
+            NODE: number;
+            EXTENSION: number;
+        };
+    };
+    DEFAULT: {
+        REGION: string;
+    };
+    DNS: {
+        CONFIG: {
+            TTL: number;
+        };
+        RECORD: {
+            A: string;
+            CNAME: string;
+            MX: string;
+            NS: string;
+            TXT: string;
+        };
+    };
+    DURATION: {
+        EXPRESS_API: number;
+        LAMBDA_MAXIMUM: number;
+        LAMBDA_WORKER: number;
+    };
+    ENV: {
+        DEMO: string;
+        DEVELOPMENT: string;
+        /** @deprecated */ EPHEMERAL: string;
+        LOCAL: string;
+        /** @deprecated */ MAIN: string;
+        META: string;
+        PERSONAL: string;
+        PREVIEW: string;
+        PRODUCTION: string;
+        RELEASE: string;
+        REVIEW: string;
+        SANDBOX: string;
+        TRAINING: string;
+    };
+    HOST: {
+        APEX: string;
+    };
+    IMPORT: {
+        DATADOG_LOG_FORWARDER: string;
+        DATADOG_ROLE: string;
+        DATADOG_SECRET: string;
+        LOG_BUCKET: string;
+        OIDC_PROVIDER: string;
+    };
+    LAMBDA: {
+        LOG_RETENTION: number;
+        MEMORY_SIZE: number;
+    };
+    PRINCIPAL: {
+        ROUTE53: string;
+    };
+    PRINCIPAL_TYPE: {
+        GROUP: string;
+        USER: string;
+    };
+    PROJECT: {
+        INFRASTRUCTURE: string;
+    };
+    ROLE: {
+        API: string;
+        DEPLOY: string;
+        HOSTING: string;
+        MONITORING: string;
+        NETWORKING: string;
+        PROCESSING: string;
+        SECURITY: string;
+        STACK: string;
+        STORAGE: string;
+        TOY: string;
+    };
+    SERVICE: {
+        DATADOG: string;
+        INFRASTRUCTURE: string;
+        LIBRARIES: string;
+        NONE: string;
+        SSO: string;
+        TRACE: string;
+    };
+    TAG: {
+        BUILD_DATE: string;
+        BUILD_HEX: string;
+        BUILD_NUMBER: string;
+        BUILD_TIME: string;
+        BUILD_TYPE: string;
+        COMMIT: string;
+        CREATION: string;
+        ENV: string;
+        NONCE: string;
+        PROJECT: string;
+        ROLE: string;
+        SERVICE: string;
+        SPONSOR: string;
+        STACK: string;
+        STACK_SHA: string;
+        VENDOR: string;
+        VERSION: string;
+    };
+    TARGET_TYPE: {
+        AWS_ACCOUNT: string;
+    };
+    VENDOR: {
+        ANTHROPIC: string;
+        AUTH0: string;
+        DATADOG: string;
+        KNOWTRACE: string;
+        MONGODB: string;
+        OPENAI: string;
+        SPLINTERLANDS: string;
+    };
+};

package/dist/cjs/helpers/extendDatadogRole.d.ts

@@ -0,0 +1,31 @@
+import { Policy } from "aws-cdk-lib/aws-iam";
+import { Construct } from "constructs";
+export interface ExtendDatadogRoleOptions {
+    /**
+     * Optional construct ID for the policy
+     * @default "DatadogCustomPolicy"
+     */
+    id?: string;
+    /**
+     * The service tag value
+     * @default CDK.SERVICE.DATADOG
+     */
+    service?: string;
+    /**
+     * Optional project tag value
+     */
+    project?: string;
+}
+/**
+ * Extends the Datadog IAM role with additional permissions
+ *
+ * Checks for CDK_ENV_DATADOG_ROLE_ARN environment variable.
+ * If found, creates a custom policy with:
+ * - budgets:ViewBudget
+ * - logs:DescribeLogGroups
+ *
+ * @param scope - The construct scope
+ * @param options - Configuration options
+ * @returns The created Policy, or undefined if CDK_ENV_DATADOG_ROLE_ARN is not set
+ */
+export declare function extendDatadogRole(scope: Construct, options?: ExtendDatadogRoleOptions): Policy | undefined;

package/dist/cjs/helpers/index.d.ts

@@ -3,8 +3,12 @@ export { constructEnvName } from "./constructEnvName";
 export { constructStackName } from "./constructStackName";
 export { constructTagger } from "./constructTagger";
 export { envHostname } from "./envHostname";
+export { extendDatadogRole, ExtendDatadogRoleOptions } from "./extendDatadogRole";
 export { isEnv, isProductionEnv, isSandboxEnv } from "./isEnv";
+export { isValidHostname } from "./isValidHostname";
+export { isValidSubdomain } from "./isValidSubdomain";
 export { jaypieLambdaEnv } from "./jaypieLambdaEnv";
+export { mergeDomain } from "./mergeDomain";
 export { resolveDatadogForwarderFunction } from "./resolveDatadogForwarderFunction";
 export { resolveDatadogLayers } from "./resolveDatadogLayers";
 export { resolveDatadogLoggingDestination } from "./resolveDatadogLoggingDestination";

package/dist/cjs/helpers/isValidHostname.d.ts

@@ -0,0 +1 @@
+export declare function isValidHostname(hostname: string): boolean;

package/dist/cjs/helpers/isValidSubdomain.d.ts

@@ -0,0 +1 @@
+export declare function isValidSubdomain(subdomain: string): boolean;

package/dist/cjs/helpers/mergeDomain.d.ts

@@ -0,0 +1 @@
+export declare function mergeDomain(subDomain: string, hostedZone: string): string;