htsget-lambda
Defined in: lib/config.ts:126
CORS configuration for the htsget-rs server.
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
allowCredentials? |
boolean |
false |
CORS allow credentials. | lib/config.ts:132 |
allowHeaders? |
string[] |
["*"] |
CORS allow headers. | lib/config.ts:139 |
allowMethods? |
CorsHttpMethod[] |
[CorsHttpMethod.ANY] |
CORS allow methods. | lib/config.ts:146 |
allowOrigins? |
string[] |
["*"] |
CORS allow origins. | lib/config.ts:153 |
exposeHeaders? |
string[] |
["*"] |
CORS expose headers. | lib/config.ts:160 |
maxAge? |
Duration |
Duration.days(30) |
CORS max age. | lib/config.ts:167 |
Defined in: lib/config.ts:174
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
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
environment_override? |
Record<string, unknown> |
undefined |
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. |
lib/config.ts:200 |
locations? |
HtsgetLocation[] |
[] |
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. |
lib/config.ts:183 |
service_info? |
Record<string, unknown> |
undefined |
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 | lib/config.ts:191 |
Defined in: lib/config.ts:10
Settings related to the htsget lambda construct props.
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
cargoLambdaFlags? |
string[] |
undefined |
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. |
lib/config.ts:60 |
copyTestData? |
boolean |
false |
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. | lib/config.ts:71 |
cors? |
CorsConifg |
same as the CorsConfig defaults |
CORS configuration for the htsget-rs server. Values here are propagated to CORS options in htsget-rs. | lib/config.ts:45 |
domain? |
string |
undefined |
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. |
lib/config.ts:24 |
gitReference? |
string |
"main" |
The git reference to fetch from the htsget-rs repo. | lib/config.ts:52 |
hostedZone? |
HostedZone |
undefined |
Use the provided hosted zone instead of looking it up from the domain name. | lib/config.ts:93 |
htsgetConfig? |
HtsgetConfig |
undefined |
The htsget-rs config options. Use this to specify any locations and htsget-rs options. | lib/config.ts:16 |
httpApi? |
HttpApi |
undefined |
Manually specify an HttpApi. This will not create a HostedZone, any Route53 records, certificates, or authorizers, and will instead rely on the existing HttpApi. |
lib/config.ts:86 |
jwt? |
JwtConfig |
undefined, defaults to a public deployment |
Whether this deployment is gated behind a JWT authorizer, or if its public. | lib/config.ts:38 |
role? |
Role |
undefined |
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. | lib/config.ts:101 |
subDomain? |
string |
"htsget" |
The domain name prefix to use for the htsget-rs server. | lib/config.ts:31 |
vpc? |
IVpc |
undefined |
Optionally specify a VPC for the Lambda function. | lib/config.ts:78 |
Defined in: lib/config.ts:206
Config for locations.
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
location |
string |
undefined |
The location string. | lib/config.ts:210 |
private_key? |
string |
undefined |
Optional Crypt4GH private key secret ARN or name. | lib/config.ts:216 |
public_key? |
string |
undefined |
Optional Crypt4GH public key secret ARN or name. | lib/config.ts:222 |
Defined in: lib/config.ts:107
JWT authorization settings.
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
audience? |
string[] |
[] |
The JWT audience. | lib/config.ts:113 |
cogUserPoolId? |
string |
undefined, creates a new user pool |
The cognito user pool id for the authorizer. If this is not set, then a new user pool is created. | lib/config.ts:120 |