@umccr/htsget-lambda 0.9.6

package/lib/config.d.ts

@@ -0,0 +1,240 @@
+import { IVpc } from "aws-cdk-lib/aws-ec2";
+import { CorsHttpMethod, IHttpApi } from "aws-cdk-lib/aws-apigatewayv2";
+import { IRole } from "aws-cdk-lib/aws-iam";
+import { Duration } from "aws-cdk-lib";
+import { IHostedZone } from "aws-cdk-lib/aws-route53";
+/**
+ * Settings related to the htsget lambda construct props.
+ */
+export interface HtsgetLambdaProps {
+    /**
+     * The htsget-rs config options. Use this to specify any locations and htsget-rs options.
+     *
+     * @defaultValue undefined
+     */
+    htsgetConfig?: HtsgetConfig;
+    /**
+     * The domain name for the htsget server. This must be specified if `httpApi` is not set. This assumes
+     * that a `HostedZone` exists for this domain.
+     *
+     * @defaultValue undefined
+     */
+    domain?: string;
+    /**
+     * The domain name prefix to use for the htsget-rs server.
+     *
+     * @defaultValue "htsget"
+     */
+    subDomain?: string;
+    /**
+     * Whether this deployment is gated behind a JWT authorizer, or if its public.
+     *
+     * @defaultValue `undefined`, defaults to a public deployment
+     */
+    jwt?: JwtConfig;
+    /**
+     * CORS configuration for the htsget-rs server. Values here are propagated to CORS options in htsget-rs.
+     *
+     * @defaultValue same as the `CorsConfig` defaults
+     */
+    cors?: CorsConifg;
+    /**
+     * The git reference to fetch from the htsget-rs repo.
+     *
+     * @defaultValue "main"
+     */
+    gitReference?: string;
+    /**
+     * Whether to force a git clone for every build. If this is false, then the git repo is only cloned once
+     * for every git reference in a temporary directory. Otherwise, the repo is cloned every time.
+     *
+     * @defaultValue false
+     */
+    gitForceClone?: boolean;
+    /**
+     * Override any cargo lambda flags for the build. By default, features are resolved automatically based on the
+     * config and `HtsgetLocation[]`. This option overrides that and any automatically added flags.
+     *
+     * @defaultValue undefined
+     */
+    cargoLambdaFlags?: string[];
+    /**
+     * Copy the test data directory to a new bucket:
+     * https://github.com/umccr/htsget-rs/tree/main/data
+     *
+     * Also copies the Crypt4GH keys to Secrets Manager. Automatically the htsget-rs server access
+     * to the bucket and secrets using the locations config.
+     *
+     * @defaultValue false
+     */
+    copyTestData?: boolean;
+    /**
+     * The name of the bucket to create when using `copyTestData`. Defaults to the auto-generated CDK construct name.
+     *
+     * @defaultValue undefined
+     */
+    bucketName?: string;
+    /**
+     * The name of the Lambda function. Defaults to the auto-generated CDK construct name.
+     *
+     * @defaultValue undefined
+     */
+    functionName?: string;
+    /**
+     * Optionally specify a VPC for the Lambda function.
+     *
+     * @defaultValue undefined
+     */
+    vpc?: IVpc;
+    /**
+     * Manually specify an `HttpApi`. This will not create a `HostedZone`, any Route53 records, certificates,
+     * or authorizers, and will instead rely on the existing `HttpApi`.
+     *
+     * @defaultValue undefined
+     */
+    httpApi?: IHttpApi;
+    /**
+     * The arn of the certificate to use. This will not create a `Certificate` if specified, and will instead lookup
+     * an existing one.
+     *
+     * @defaultValue undefined
+     */
+    certificateArn?: string;
+    /**
+     * Use the provided hosted zone instead of looking it up from the domain name.
+     *
+     * @defaultValue undefined
+     */
+    hostedZone?: IHostedZone;
+    /**
+     * Use the provided role instead of creating one. This will ignore any configuration related to permissions for
+     * buckets and secrets, and rely on the existing role.
+     *
+     * @defaultValue undefined
+     */
+    role?: IRole;
+    /**
+     * The name of the role for the Lambda function. Defaults to the auto-generated CDK construct name.
+     *
+     * @defaultValue undefined
+     */
+    roleName?: string;
+    /**
+     * Override the environment variables used to build htsget. Note that this only adds environment variables that
+     * get used to build htsget-rs with `cargo`. It has no effect on the environment variables that htsget-rs has when
+     * the Lambda function is deployed. In general, leave this undefined unless there is a specific reason to override
+     * the build environment.
+     *
+     * @defaultValue undefined
+     */
+    buildEnvironment?: Record<string, string>;
+}
+/**
+ * JWT authorization settings.
+ */
+export interface JwtConfig {
+    /**
+     * The JWT audience.
+     *
+     * @defaultValue []
+     */
+    audience?: string[];
+    /**
+     * The cognito user pool id for the authorizer. If this is not set, then a new user pool is created.
+     *
+     * @defaultValue `undefined`, creates a new user pool
+     */
+    cogUserPoolId?: string;
+}
+/**
+ * CORS configuration for the htsget-rs server.
+ */
+export interface CorsConifg {
+    /**
+     * CORS allow credentials.
+     *
+     * @defaultValue false
+     */
+    allowCredentials?: boolean;
+    /**
+     * CORS allow headers.
+     *
+     * @defaultValue ["*"]
+     */
+    allowHeaders?: string[];
+    /**
+     * CORS allow methods.
+     *
+     * @defaultValue [CorsHttpMethod.ANY]
+     */
+    allowMethods?: CorsHttpMethod[];
+    /**
+     * CORS allow origins.
+     *
+     * @defaultValue ["*"]
+     */
+    allowOrigins?: string[];
+    /**
+     * CORS expose headers.
+     *
+     * @defaultValue ["*"]
+     */
+    exposeHeaders?: string[];
+    /**
+     * CORS max age.
+     *
+     * @defaultValue Duration.days(30)
+     */
+    maxAge?: Duration;
+}
+/**
+ * Configuration for the htsget-rs server. This allows specifying the options
+ * available in the htsget-rs config: https://github.com/umccr/htsget-rs/tree/main/htsget-config
+ */
+export interface HtsgetConfig {
+    /**
+     * The locations for the htsget-rs server. This is the same as the htsget-rs config locations:
+     * https://github.com/umccr/htsget-rs/tree/main/htsget-config#quickstart
+     *
+     * Any `s3://...` locations will automatically be added to the bucket access policy.
+     *
+     * @defaultValue []
+     */
+    locations?: HtsgetLocation[];
+    /**
+     * Service info fields to configure for the server. This is the same as the htsget-rs config service_info:
+     * https://github.com/umccr/htsget-rs/tree/main/htsget-config#service-info-config
+     *
+     * @defaultValue undefined
+     */
+    service_info?: Record<string, unknown>;
+    /**
+     * Any additional htsget-rs options can be specified here as environment variables. These will override
+     * any options set in this construct, and allows using advanced configuration. Options here should contain
+     * the `HTSGET_` prefix.
+     *
+     * @defaultValue undefined
+     */
+    environment_override?: Record<string, unknown>;
+}
+/**
+ * Config for locations.
+ */
+export interface HtsgetLocation {
+    /**
+     * The location string.
+     */
+    location: string;
+    /**
+     * Optional Crypt4GH private key secret ARN or name.
+     *
+     * @defaultValue undefined
+     */
+    private_key?: string;
+    /**
+     * Optional Crypt4GH public key secret ARN or name.
+     *
+     * @defaultValue undefined
+     */
+    public_key?: string;
+}

package/lib/config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"config.js","sourceRoot":"","sources":["config.ts"],"names":[],"mappings":"","sourcesContent":["import { IVpc } from \"aws-cdk-lib/aws-ec2\";\nimport { CorsHttpMethod, IHttpApi } from \"aws-cdk-lib/aws-apigatewayv2\";\nimport { IRole } from \"aws-cdk-lib/aws-iam\";\nimport { Duration } from \"aws-cdk-lib\";\nimport { IHostedZone } from \"aws-cdk-lib/aws-route53\";\n\n/**\n * Settings related to the htsget lambda construct props.\n */\nexport interface HtsgetLambdaProps {\n  /**\n   * The htsget-rs config options. Use this to specify any locations and htsget-rs options.\n   *\n   * @defaultValue undefined\n   */\n  htsgetConfig?: HtsgetConfig;\n\n  /**\n   * The domain name for the htsget server. This must be specified if `httpApi` is not set. This assumes\n   * that a `HostedZone` exists for this domain.\n   *\n   * @defaultValue undefined\n   */\n  domain?: string;\n\n  /**\n   * The domain name prefix to use for the htsget-rs server.\n   *\n   * @defaultValue \"htsget\"\n   */\n  subDomain?: string;\n\n  /**\n   * Whether this deployment is gated behind a JWT authorizer, or if its public.\n   *\n   * @defaultValue `undefined`, defaults to a public deployment\n   */\n  jwt?: JwtConfig;\n\n  /**\n   * CORS configuration for the htsget-rs server. Values here are propagated to CORS options in htsget-rs.\n   *\n   * @defaultValue same as the `CorsConfig` defaults\n   */\n  cors?: CorsConifg;\n\n  /**\n   * The git reference to fetch from the htsget-rs repo.\n   *\n   * @defaultValue \"main\"\n   */\n  gitReference?: string;\n\n  /**\n   * Whether to force a git clone for every build. If this is false, then the git repo is only cloned once\n   * for every git reference in a temporary directory. Otherwise, the repo is cloned every time.\n   *\n   * @defaultValue false\n   */\n  gitForceClone?: boolean;\n\n  /**\n   * Override any cargo lambda flags for the build. By default, features are resolved automatically based on the\n   * config and `HtsgetLocation[]`. This option overrides that and any automatically added flags.\n   *\n   * @defaultValue undefined\n   */\n  cargoLambdaFlags?: string[];\n\n  /**\n   * Copy the test data directory to a new bucket:\n   * https://github.com/umccr/htsget-rs/tree/main/data\n   *\n   * Also copies the Crypt4GH keys to Secrets Manager. Automatically the htsget-rs server access\n   * to the bucket and secrets using the locations config.\n   *\n   * @defaultValue false\n   */\n  copyTestData?: boolean;\n\n  /**\n   * The name of the bucket to create when using `copyTestData`. Defaults to the auto-generated CDK construct name.\n   *\n   * @defaultValue undefined\n   */\n  bucketName?: string;\n\n  /**\n   * The name of the Lambda function. Defaults to the auto-generated CDK construct name.\n   *\n   * @defaultValue undefined\n   */\n  functionName?: string;\n\n  /**\n   * Optionally specify a VPC for the Lambda function.\n   *\n   * @defaultValue undefined\n   */\n  vpc?: IVpc;\n\n  /**\n   * Manually specify an `HttpApi`. This will not create a `HostedZone`, any Route53 records, certificates,\n   * or authorizers, and will instead rely on the existing `HttpApi`.\n   *\n   * @defaultValue undefined\n   */\n  httpApi?: IHttpApi;\n\n  /**\n   * The arn of the certificate to use. This will not create a `Certificate` if specified, and will instead lookup\n   * an existing one.\n   *\n   * @defaultValue undefined\n   */\n  certificateArn?: string;\n\n  /**\n   * Use the provided hosted zone instead of looking it up from the domain name.\n   *\n   * @defaultValue undefined\n   */\n  hostedZone?: IHostedZone;\n\n  /**\n   * Use the provided role instead of creating one. This will ignore any configuration related to permissions for\n   * buckets and secrets, and rely on the existing role.\n   *\n   * @defaultValue undefined\n   */\n  role?: IRole;\n\n  /**\n   * The name of the role for the Lambda function. Defaults to the auto-generated CDK construct name.\n   *\n   * @defaultValue undefined\n   */\n  roleName?: string;\n\n  /**\n   * Override the environment variables used to build htsget. Note that this only adds environment variables that\n   * get used to build htsget-rs with `cargo`. It has no effect on the environment variables that htsget-rs has when\n   * the Lambda function is deployed. In general, leave this undefined unless there is a specific reason to override\n   * the build environment.\n   *\n   * @defaultValue undefined\n   */\n  buildEnvironment?: Record<string, string>;\n}\n\n/**\n * JWT authorization settings.\n */\nexport interface JwtConfig {\n  /**\n   * The JWT audience.\n   *\n   * @defaultValue []\n   */\n  audience?: string[];\n\n  /**\n   * The cognito user pool id for the authorizer. If this is not set, then a new user pool is created.\n   *\n   * @defaultValue `undefined`, creates a new user pool\n   */\n  cogUserPoolId?: string;\n}\n\n/**\n * CORS configuration for the htsget-rs server.\n */\nexport interface CorsConifg {\n  /**\n   * CORS allow credentials.\n   *\n   * @defaultValue false\n   */\n  allowCredentials?: boolean;\n\n  /**\n   * CORS allow headers.\n   *\n   * @defaultValue [\"*\"]\n   */\n  allowHeaders?: string[];\n\n  /**\n   * CORS allow methods.\n   *\n   * @defaultValue [CorsHttpMethod.ANY]\n   */\n  allowMethods?: CorsHttpMethod[];\n\n  /**\n   * CORS allow origins.\n   *\n   * @defaultValue [\"*\"]\n   */\n  allowOrigins?: string[];\n\n  /**\n   * CORS expose headers.\n   *\n   * @defaultValue [\"*\"]\n   */\n  exposeHeaders?: string[];\n\n  /**\n   * CORS max age.\n   *\n   * @defaultValue Duration.days(30)\n   */\n  maxAge?: Duration;\n}\n\n/**\n * Configuration for the htsget-rs server. This allows specifying the options\n * available in the htsget-rs config: https://github.com/umccr/htsget-rs/tree/main/htsget-config\n */\nexport interface HtsgetConfig {\n  /**\n   * The locations for the htsget-rs server. This is the same as the htsget-rs config locations:\n   * https://github.com/umccr/htsget-rs/tree/main/htsget-config#quickstart\n   *\n   * Any `s3://...` locations will automatically be added to the bucket access policy.\n   *\n   * @defaultValue []\n   */\n  locations?: HtsgetLocation[];\n\n  /**\n   * Service info fields to configure for the server. This is the same as the htsget-rs config service_info:\n   * https://github.com/umccr/htsget-rs/tree/main/htsget-config#service-info-config\n   *\n   * @defaultValue undefined\n   */\n  service_info?: Record<string, unknown>;\n\n  /**\n   * Any additional htsget-rs options can be specified here as environment variables. These will override\n   * any options set in this construct, and allows using advanced configuration. Options here should contain\n   * the `HTSGET_` prefix.\n   *\n   * @defaultValue undefined\n   */\n  environment_override?: Record<string, unknown>;\n}\n\n/**\n * Config for locations.\n */\nexport interface HtsgetLocation {\n  /**\n   * The location string.\n   */\n  location: string;\n  /**\n   * Optional Crypt4GH private key secret ARN or name.\n   *\n   * @defaultValue undefined\n   */\n  private_key?: string;\n  /**\n   * Optional Crypt4GH public key secret ARN or name.\n   *\n   * @defaultValue undefined\n   */\n  public_key?: string;\n}\n"]}

package/lib/config.ts

@@ -0,0 +1,270 @@
+import { IVpc } from "aws-cdk-lib/aws-ec2";
+import { CorsHttpMethod, IHttpApi } from "aws-cdk-lib/aws-apigatewayv2";
+import { IRole } from "aws-cdk-lib/aws-iam";
+import { Duration } from "aws-cdk-lib";
+import { IHostedZone } from "aws-cdk-lib/aws-route53";
+
+/**
+ * Settings related to the htsget lambda construct props.
+ */
+export interface HtsgetLambdaProps {
+  /**
+   * The htsget-rs config options. Use this to specify any locations and htsget-rs options.
+   *
+   * @defaultValue undefined
+   */
+  htsgetConfig?: HtsgetConfig;
+
+  /**
+   * The domain name for the htsget server. This must be specified if `httpApi` is not set. This assumes
+   * that a `HostedZone` exists for this domain.
+   *
+   * @defaultValue undefined
+   */
+  domain?: string;
+
+  /**
+   * The domain name prefix to use for the htsget-rs server.
+   *
+   * @defaultValue "htsget"
+   */
+  subDomain?: string;
+
+  /**
+   * Whether this deployment is gated behind a JWT authorizer, or if its public.
+   *
+   * @defaultValue `undefined`, defaults to a public deployment
+   */
+  jwt?: JwtConfig;
+
+  /**
+   * CORS configuration for the htsget-rs server. Values here are propagated to CORS options in htsget-rs.
+   *
+   * @defaultValue same as the `CorsConfig` defaults
+   */
+  cors?: CorsConifg;
+
+  /**
+   * The git reference to fetch from the htsget-rs repo.
+   *
+   * @defaultValue "main"
+   */
+  gitReference?: string;
+
+  /**
+   * Whether to force a git clone for every build. If this is false, then the git repo is only cloned once
+   * for every git reference in a temporary directory. Otherwise, the repo is cloned every time.
+   *
+   * @defaultValue false
+   */
+  gitForceClone?: boolean;
+
+  /**
+   * Override any cargo lambda flags for the build. By default, features are resolved automatically based on the
+   * config and `HtsgetLocation[]`. This option overrides that and any automatically added flags.
+   *
+   * @defaultValue undefined
+   */
+  cargoLambdaFlags?: string[];
+
+  /**
+   * Copy the test data directory to a new bucket:
+   * https://github.com/umccr/htsget-rs/tree/main/data
+   *
+   * Also copies the Crypt4GH keys to Secrets Manager. Automatically the htsget-rs server access
+   * to the bucket and secrets using the locations config.
+   *
+   * @defaultValue false
+   */
+  copyTestData?: boolean;
+
+  /**
+   * The name of the bucket to create when using `copyTestData`. Defaults to the auto-generated CDK construct name.
+   *
+   * @defaultValue undefined
+   */
+  bucketName?: string;
+
+  /**
+   * The name of the Lambda function. Defaults to the auto-generated CDK construct name.
+   *
+   * @defaultValue undefined
+   */
+  functionName?: string;
+
+  /**
+   * Optionally specify a VPC for the Lambda function.
+   *
+   * @defaultValue undefined
+   */
+  vpc?: IVpc;
+
+  /**
+   * Manually specify an `HttpApi`. This will not create a `HostedZone`, any Route53 records, certificates,
+   * or authorizers, and will instead rely on the existing `HttpApi`.
+   *
+   * @defaultValue undefined
+   */
+  httpApi?: IHttpApi;
+
+  /**
+   * The arn of the certificate to use. This will not create a `Certificate` if specified, and will instead lookup
+   * an existing one.
+   *
+   * @defaultValue undefined
+   */
+  certificateArn?: string;
+
+  /**
+   * Use the provided hosted zone instead of looking it up from the domain name.
+   *
+   * @defaultValue undefined
+   */
+  hostedZone?: IHostedZone;
+
+  /**
+   * Use the provided role instead of creating one. This will ignore any configuration related to permissions for
+   * buckets and secrets, and rely on the existing role.
+   *
+   * @defaultValue undefined
+   */
+  role?: IRole;
+
+  /**
+   * The name of the role for the Lambda function. Defaults to the auto-generated CDK construct name.
+   *
+   * @defaultValue undefined
+   */
+  roleName?: string;
+
+  /**
+   * Override the environment variables used to build htsget. Note that this only adds environment variables that
+   * get used to build htsget-rs with `cargo`. It has no effect on the environment variables that htsget-rs has when
+   * the Lambda function is deployed. In general, leave this undefined unless there is a specific reason to override
+   * the build environment.
+   *
+   * @defaultValue undefined
+   */
+  buildEnvironment?: Record<string, string>;
+}
+
+/**
+ * JWT authorization settings.
+ */
+export interface JwtConfig {
+  /**
+   * The JWT audience.
+   *
+   * @defaultValue []
+   */
+  audience?: string[];
+
+  /**
+   * The cognito user pool id for the authorizer. If this is not set, then a new user pool is created.
+   *
+   * @defaultValue `undefined`, creates a new user pool
+   */
+  cogUserPoolId?: string;
+}
+
+/**
+ * CORS configuration for the htsget-rs server.
+ */
+export interface CorsConifg {
+  /**
+   * CORS allow credentials.
+   *
+   * @defaultValue false
+   */
+  allowCredentials?: boolean;
+
+  /**
+   * CORS allow headers.
+   *
+   * @defaultValue ["*"]
+   */
+  allowHeaders?: string[];
+
+  /**
+   * CORS allow methods.
+   *
+   * @defaultValue [CorsHttpMethod.ANY]
+   */
+  allowMethods?: CorsHttpMethod[];
+
+  /**
+   * CORS allow origins.
+   *
+   * @defaultValue ["*"]
+   */
+  allowOrigins?: string[];
+
+  /**
+   * CORS expose headers.
+   *
+   * @defaultValue ["*"]
+   */
+  exposeHeaders?: string[];
+
+  /**
+   * CORS max age.
+   *
+   * @defaultValue Duration.days(30)
+   */
+  maxAge?: Duration;
+}
+
+/**
+ * Configuration for the htsget-rs server. This allows specifying the options
+ * available in the htsget-rs config: https://github.com/umccr/htsget-rs/tree/main/htsget-config
+ */
+export interface HtsgetConfig {
+  /**
+   * The locations for the htsget-rs server. This is the same as the htsget-rs config locations:
+   * https://github.com/umccr/htsget-rs/tree/main/htsget-config#quickstart
+   *
+   * Any `s3://...` locations will automatically be added to the bucket access policy.
+   *
+   * @defaultValue []
+   */
+  locations?: HtsgetLocation[];
+
+  /**
+   * Service info fields to configure for the server. This is the same as the htsget-rs config service_info:
+   * https://github.com/umccr/htsget-rs/tree/main/htsget-config#service-info-config
+   *
+   * @defaultValue undefined
+   */
+  service_info?: Record<string, unknown>;
+
+  /**
+   * Any additional htsget-rs options can be specified here as environment variables. These will override
+   * any options set in this construct, and allows using advanced configuration. Options here should contain
+   * the `HTSGET_` prefix.
+   *
+   * @defaultValue undefined
+   */
+  environment_override?: Record<string, unknown>;
+}
+
+/**
+ * Config for locations.
+ */
+export interface HtsgetLocation {
+  /**
+   * The location string.
+   */
+  location: string;
+  /**
+   * Optional Crypt4GH private key secret ARN or name.
+   *
+   * @defaultValue undefined
+   */
+  private_key?: string;
+  /**
+   * Optional Crypt4GH public key secret ARN or name.
+   *
+   * @defaultValue undefined
+   */
+  public_key?: string;
+}

package/lib/htsget-lambda.d.ts

@@ -0,0 +1,36 @@
+import { Construct } from "constructs";
+import { Role } from "aws-cdk-lib/aws-iam";
+import { Bucket } from "aws-cdk-lib/aws-s3";
+import { Secret } from "aws-cdk-lib/aws-secretsmanager";
+import { CorsConifg, HtsgetConfig, HtsgetLambdaProps } from "./config";
+/**
+ * @ignore
+ * Construct used to deploy htsget-lambda.
+ */
+export declare class HtsgetLambda extends Construct {
+    constructor(scope: Construct, id: string, props: HtsgetLambdaProps);
+    /**
+     * Determine the correct features based on the locations.
+     */
+    static resolveFeatures(config: HtsgetConfig, bucketSetup: boolean): string;
+    /**
+     * Create a bucket and copy test data if configured.
+     */
+    private setupTestData;
+    /**
+     * Set permissions for the Lambda role.
+     */
+    static setPermissions(role: Role, config: HtsgetConfig, bucket?: Bucket, privateKey?: Secret, publicKey?: Secret): void;
+    /**
+     * Creates a lambda role with the configured permissions.
+     */
+    static createRole(scope: Construct, id: string, roleName?: string): Role;
+    /**
+     * Create stateful config related to the httpApi and the API itself.
+     */
+    private createHttpApi;
+    /**
+     * Convert JSON config to htsget-rs env representation.
+     */
+    static configToEnv(config: HtsgetConfig, corsConfig?: CorsConifg, bucket?: Bucket, privateKey?: Secret, publicKey?: Secret): Record<string, string>;
+}