eoapi-cdk

API Reference

Constructs

BastionHost

The database is located in an isolated subnet, meaning that it is not accessible from the public internet.

As such, to interact with the database directly, a user must tunnel through a bastion host.

Configuring

This codebase controls who is allowed to connect to the bastion host. This requires two steps:

1. Adding the IP address from which you are connecting to the ipv4Allowlist array
2. Creating a bastion host system user by adding the user’s configuration inform to userdata.yaml

Adding an IP address to the ipv4Allowlist array

The BastionHost construct takes in an ipv4Allowlist array as an argument. Find your IP address (eg curl api.ipify.org) and add that to the array along with the trailing CIDR block (likely /32 to indicate that you are adding a single IP address).

Creating a user via userdata.yaml

Add an entry to the users array with a username (likely matching your local systems username, which you can get by running the whoami command in your terminal) and a public key (likely your default public key, which you can get by running cat ~/.ssh/id_*.pub in your terminal).

Tips & Tricks when using the Bastion Host

Connecting to RDS Instance via SSM

aws ssm start-session --target $INSTANCE_ID \
--document-name AWS-StartPortForwardingSessionToRemoteHost \
--parameters '{
"host": [
"example-db.c5abcdefghij.us-west-2.rds.amazonaws.com"
],
"portNumber": [
"5432"
],
"localPortNumber": [
"9999"
]
}' \
--profile $AWS_PROFILE

psql -h localhost -p 9999 # continue adding username (-U) and db (-d) here...

Connect directly to Bastion Host:

aws ssm start-session --target $INSTANCE_ID --profile $AWS_PROFILE

Setting up an SSH tunnel

In your ~/.ssh/config file, add an entry like:

Host db-tunnel
Hostname {the-bastion-host-address}
LocalForward 9999 {the-db-hostname}:5432

Then a tunnel can be opened via:

ssh -N db-tunnel

And a connection to the DB can be made via:

psql -h 127.0.0.1 -p 9999 -U {username} -d {database}

Handling REMOTE HOST IDENTIFICATION HAS CHANGED! error

If you’ve redeployed a bastion host that you’ve previously connected to, you may see an error like:

#### Initializers <a name="Initializers" id="eoapi-cdk.BastionHost.Initializer"></a>

```typescript
import { BastionHost } from 'eoapi-cdk'

new BastionHost(scope: Construct, id: string, props: BastionHostProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	BastionHostProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: BastionHostProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { BastionHost } from 'eoapi-cdk'

BastionHost.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
instance	aws-cdk-lib.aws_ec2.Instance	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

instance^Required

public readonly instance: Instance;

• Type: aws-cdk-lib.aws_ec2.Instance

---

PgStacApiLambda

Initializers

import { PgStacApiLambda } from 'eoapi-cdk'

new PgStacApiLambda(scope: Construct, id: string, props: PgStacApiLambdaProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	PgStacApiLambdaProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: PgStacApiLambdaProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { PgStacApiLambda } from 'eoapi-cdk'

PgStacApiLambda.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
url	string	No description.
stacApiLambdaFunction	aws-cdk-lib.aws_lambda.Function	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

url^Required

public readonly url: string;

• Type: string

---

stacApiLambdaFunction^Required

public readonly stacApiLambdaFunction: Function;

• Type: aws-cdk-lib.aws_lambda.Function

---

PgStacDatabase

An RDS instance with pgSTAC installed.

This is a wrapper around the rds.DatabaseInstance higher-level construct making use of the BootstrapPgStac construct.

Initializers

import { PgStacDatabase } from 'eoapi-cdk'

new PgStacDatabase(scope: Construct, id: string, props: PgStacDatabaseProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	PgStacDatabaseProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: PgStacDatabaseProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
getParameters	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

getParameters

public getParameters(instanceType: string, parameters?: {[ key: string ]: string}): DatabaseParameters

instanceType^Required

• Type: string

---

parameters^Optional

• Type: {[ key: string ]: string}

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { PgStacDatabase } from 'eoapi-cdk'

PgStacDatabase.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
db	aws-cdk-lib.aws_rds.DatabaseInstance	No description.
pgstacSecret	aws-cdk-lib.aws_secretsmanager.ISecret	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

db^Required

public readonly db: DatabaseInstance;

• Type: aws-cdk-lib.aws_rds.DatabaseInstance

---

pgstacSecret^Required

public readonly pgstacSecret: ISecret;

• Type: aws-cdk-lib.aws_secretsmanager.ISecret

---

StacBrowser

Initializers

import { StacBrowser } from 'eoapi-cdk'

new StacBrowser(scope: Construct, id: string, props: StacBrowserProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	StacBrowserProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: StacBrowserProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { StacBrowser } from 'eoapi-cdk'

StacBrowser.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
bucket	aws-cdk-lib.aws_s3.IBucket	No description.
bucketDeployment	aws-cdk-lib.aws_s3_deployment.BucketDeployment	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

bucket^Required

public readonly bucket: IBucket;

• Type: aws-cdk-lib.aws_s3.IBucket

---

bucketDeployment^Required

public readonly bucketDeployment: BucketDeployment;

• Type: aws-cdk-lib.aws_s3_deployment.BucketDeployment

---

StacIngestor

Initializers

import { StacIngestor } from 'eoapi-cdk'

new StacIngestor(scope: Construct, id: string, props: StacIngestorProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	StacIngestorProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: StacIngestorProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { StacIngestor } from 'eoapi-cdk'

StacIngestor.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
handlerRole	aws-cdk-lib.aws_iam.Role	No description.
table	aws-cdk-lib.aws_dynamodb.Table	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

handlerRole^Required

public readonly handlerRole: Role;

• Type: aws-cdk-lib.aws_iam.Role

---

table^Required

public readonly table: Table;

• Type: aws-cdk-lib.aws_dynamodb.Table

---

TiPgApiLambda

Initializers

import { TiPgApiLambda } from 'eoapi-cdk'

new TiPgApiLambda(scope: Construct, id: string, props: TiPgApiLambdaProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	TiPgApiLambdaProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: TiPgApiLambdaProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { TiPgApiLambda } from 'eoapi-cdk'

TiPgApiLambda.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
url	string	No description.
tiPgLambdaFunction	aws-cdk-lib.aws_lambda.Function	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

url^Required

public readonly url: string;

• Type: string

---

tiPgLambdaFunction^Required

public readonly tiPgLambdaFunction: Function;

• Type: aws-cdk-lib.aws_lambda.Function

---

TitilerPgstacApiLambda

Initializers

import { TitilerPgstacApiLambda } from 'eoapi-cdk'

new TitilerPgstacApiLambda(scope: Construct, id: string, props: TitilerPgStacApiLambdaProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	TitilerPgStacApiLambdaProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: TitilerPgStacApiLambdaProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { TitilerPgstacApiLambda } from 'eoapi-cdk'

TitilerPgstacApiLambda.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
url	string	No description.
titilerPgstacLambdaFunction	aws-cdk-lib.aws_lambda.Function	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

url^Required

public readonly url: string;

• Type: string

---

titilerPgstacLambdaFunction^Required

public readonly titilerPgstacLambdaFunction: Function;

• Type: aws-cdk-lib.aws_lambda.Function

---

Structs

BastionHostProps

Initializer

import { BastionHostProps } from 'eoapi-cdk'

const bastionHostProps: BastionHostProps = { ... }

Properties

Name	Type	Description
db	aws-cdk-lib.aws_rds.IDatabaseInstance	No description.
ipv4Allowlist	string[]	No description.
userData	aws-cdk-lib.aws_ec2.UserData	No description.
vpc	aws-cdk-lib.aws_ec2.IVpc	No description.
createElasticIp	boolean	Whether or not an elastic IP should be created for the bastion host.
sshPort	number	No description.

---

db^Required

public readonly db: IDatabaseInstance;

• Type: aws-cdk-lib.aws_rds.IDatabaseInstance

---

ipv4Allowlist^Required

public readonly ipv4Allowlist: string[];

• Type: string[]

---

userData^Required

public readonly userData: UserData;

• Type: aws-cdk-lib.aws_ec2.UserData

---

vpc^Required

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

---

createElasticIp^Optional

public readonly createElasticIp: boolean;

• Type: boolean
• Default: false

Whether or not an elastic IP should be created for the bastion host.

---

sshPort^Optional

public readonly sshPort: number;

• Type: number

---

DatabaseParameters

Initializer

import { DatabaseParameters } from 'eoapi-cdk'

const databaseParameters: DatabaseParameters = { ... }

Properties

Name	Type	Description
effectiveCacheSize	string	No description.
maintenanceWorkMem	string	No description.
maxConnections	string	No description.
maxLocksPerTransaction	string	No description.
randomPageCost	string	No description.
seqPageCost	string	No description.
sharedBuffers	string	Note: This value is measured in 8KB blocks.
tempBuffers	string	No description.
workMem	string	No description.

---

effectiveCacheSize^Required

public readonly effectiveCacheSize: string;

• Type: string
• Default: 75% of instance memory

---

maintenanceWorkMem^Required

public readonly maintenanceWorkMem: string;

• Type: string
• Default: 25% of shared buffers

---

maxConnections^Required

public readonly maxConnections: string;

• Type: string
• Default: LEAST({DBInstanceClassMemory/9531392}, 5000)

---

maxLocksPerTransaction^Required

public readonly maxLocksPerTransaction: string;

• Type: string
• Default: 1024

---

randomPageCost^Required

public readonly randomPageCost: string;

• Type: string
• Default: 1.1

---

seqPageCost^Required

public readonly seqPageCost: string;

• Type: string
• Default: 1

---

sharedBuffers^Required

public readonly sharedBuffers: string;

• Type: string
• Default: ‘{DBInstanceClassMemory/32768}’ 25% of instance memory, ie {(DBInstanceClassMemory/(1024*8)) * 0.25}

Note: This value is measured in 8KB blocks.

---

tempBuffers^Required

public readonly tempBuffers: string;

• Type: string
• Default: 131172 (128 * 1024)

---

workMem^Required

public readonly workMem: string;

• Type: string
• Default: shared buffers divided by max connections

---

PgStacApiLambdaProps

Initializer

import { PgStacApiLambdaProps } from 'eoapi-cdk'

const pgStacApiLambdaProps: PgStacApiLambdaProps = { ... }

Properties

Name	Type	Description
db	aws-cdk-lib.aws_rds.IDatabaseInstance	RDS Instance with installed pgSTAC.
dbSecret	aws-cdk-lib.aws_secretsmanager.ISecret	Secret containing connection information for pgSTAC database.
apiEnv	{[ key: string ]: string}	Customized environment variables to send to fastapi-pgstac runtime.
lambdaFunctionOptions	any	Can be used to override the default lambda function properties.
stacApiDomainName	@aws-cdk/aws-apigatewayv2-alpha.IDomainName	Custom Domain Name Options for STAC API,.
subnetSelection	aws-cdk-lib.aws_ec2.SubnetSelection	Subnet into which the lambda should be deployed.
vpc	aws-cdk-lib.aws_ec2.IVpc	VPC into which the lambda should be deployed.

---

db^Required

public readonly db: IDatabaseInstance;

• Type: aws-cdk-lib.aws_rds.IDatabaseInstance

RDS Instance with installed pgSTAC.

---

dbSecret^Required

public readonly dbSecret: ISecret;

• Type: aws-cdk-lib.aws_secretsmanager.ISecret

Secret containing connection information for pgSTAC database.

---

apiEnv^Optional

public readonly apiEnv: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Customized environment variables to send to fastapi-pgstac runtime.

---

lambdaFunctionOptions^Optional

public readonly lambdaFunctionOptions: any;

• Type: any
• Default: defined in the construct.

Can be used to override the default lambda function properties.

---

stacApiDomainName^Optional

public readonly stacApiDomainName: IDomainName;

• Type: @aws-cdk/aws-apigatewayv2-alpha.IDomainName

Custom Domain Name Options for STAC API,.

---

subnetSelection^Optional

public readonly subnetSelection: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection

Subnet into which the lambda should be deployed.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

VPC into which the lambda should be deployed.

---

PgStacDatabaseProps

Initializer

import { PgStacDatabaseProps } from 'eoapi-cdk'

const pgStacDatabaseProps: PgStacDatabaseProps = { ... }

Properties

Name	Type	Description
vpc	aws-cdk-lib.aws_ec2.IVpc	The VPC network where the DB subnet group should be created.
autoMinorVersionUpgrade	boolean	Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
availabilityZone	string	The name of the Availability Zone where the DB instance will be located.
backupRetention	aws-cdk-lib.Duration	The number of days during which automatic DB snapshots are retained.
caCertificate	aws-cdk-lib.aws_rds.CaCertificate	The identifier of the CA certificate for this DB instance.
cloudwatchLogsExports	string[]	The list of log types that need to be enabled for exporting to CloudWatch Logs.
cloudwatchLogsRetention	aws-cdk-lib.aws_logs.RetentionDays	The number of days log events are kept in CloudWatch Logs.
cloudwatchLogsRetentionRole	aws-cdk-lib.aws_iam.IRole	The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
copyTagsToSnapshot	boolean	Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
deleteAutomatedBackups	boolean	Indicates whether automated backups should be deleted or retained when you delete a DB instance.
deletionProtection	boolean	Indicates whether the DB instance should have deletion protection enabled.
domain	string	The Active Directory directory ID to create the DB instance in.
domainRole	aws-cdk-lib.aws_iam.IRole	The IAM role to be used when making API calls to the Directory Service.
enablePerformanceInsights	boolean	Whether to enable Performance Insights for the DB instance.
iamAuthentication	boolean	Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
instanceIdentifier	string	A name for the DB instance.
iops	number	The number of I/O operations per second (IOPS) that the database provisions.
maxAllocatedStorage	number	Upper limit to which RDS can scale the storage in GiB(Gibibyte).
monitoringInterval	aws-cdk-lib.Duration	The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
monitoringRole	aws-cdk-lib.aws_iam.IRole	Role that will be used to manage DB instance monitoring.
multiAz	boolean	Specifies if the database instance is a multiple Availability Zone deployment.
networkType	aws-cdk-lib.aws_rds.NetworkType	The network type of the DB instance.
optionGroup	aws-cdk-lib.aws_rds.IOptionGroup	The option group to associate with the instance.
parameterGroup	aws-cdk-lib.aws_rds.IParameterGroup	The DB parameter group to associate with the instance.
performanceInsightEncryptionKey	aws-cdk-lib.aws_kms.IKey	The AWS KMS key for encryption of Performance Insights data.
performanceInsightRetention	aws-cdk-lib.aws_rds.PerformanceInsightRetention	The amount of time, in days, to retain Performance Insights data.
port	number	The port for the instance.
preferredBackupWindow	string	The daily time range during which automated backups are performed.
preferredMaintenanceWindow	string	The weekly time range (in UTC) during which system maintenance can occur.
processorFeatures	aws-cdk-lib.aws_rds.ProcessorFeatures	The number of CPU cores and the number of threads per core.
publiclyAccessible	boolean	Indicates whether the DB instance is an internet-facing instance.
removalPolicy	aws-cdk-lib.RemovalPolicy	The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
s3ExportBuckets	aws-cdk-lib.aws_s3.IBucket[]	S3 buckets that you want to load data into.
s3ExportRole	aws-cdk-lib.aws_iam.IRole	Role that will be associated with this DB instance to enable S3 export.
s3ImportBuckets	aws-cdk-lib.aws_s3.IBucket[]	S3 buckets that you want to load data from.
s3ImportRole	aws-cdk-lib.aws_iam.IRole	Role that will be associated with this DB instance to enable S3 import.
securityGroups	aws-cdk-lib.aws_ec2.ISecurityGroup[]	The security groups to assign to the DB instance.
storageThroughput	number	The storage throughput, specified in mebibytes per second (MiBps).
storageType	aws-cdk-lib.aws_rds.StorageType	The storage type.
subnetGroup	aws-cdk-lib.aws_rds.ISubnetGroup	Existing subnet group for the instance.
vpcSubnets	aws-cdk-lib.aws_ec2.SubnetSelection	The type of subnets to add to the created DB subnet group.
engine	aws-cdk-lib.aws_rds.IInstanceEngine	The database engine.
allocatedStorage	number	The allocated storage size, specified in gibibytes (GiB).
allowMajorVersionUpgrade	boolean	Whether to allow major version upgrades.
databaseName	string	The name of the database.
instanceType	aws-cdk-lib.aws_ec2.InstanceType	The name of the compute and memory capacity for the instance.
licenseModel	aws-cdk-lib.aws_rds.LicenseModel	The license model.
parameters	{[ key: string ]: string}	The parameters in the DBParameterGroup to create automatically.
timezone	string	The time zone of the instance.
characterSetName	string	For supported engines, specifies the character set to associate with the DB instance.
credentials	aws-cdk-lib.aws_rds.Credentials	Credentials for the administrative user.
storageEncrypted	boolean	Indicates whether the DB instance is encrypted.
storageEncryptionKey	aws-cdk-lib.aws_kms.IKey	The KMS key that’s used to encrypt the DB instance.
bootstrapperLambdaFunctionOptions	any	Can be used to override the default lambda function properties.
customResourceProperties	{[ key: string ]: any}	Lambda function Custom Resource properties.
pgstacDbName	string	Name of database that is to be created and onto which pgSTAC will be installed.
pgstacUsername	string	Name of user that will be generated for connecting to the pgSTAC database.
secretsPrefix	string	Prefix to assign to the generated secrets_manager.Secret.

---

vpc^Required

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

The VPC network where the DB subnet group should be created.

---

autoMinorVersionUpgrade^Optional

public readonly autoMinorVersionUpgrade: boolean;

• Type: boolean
• Default: true

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

---

availabilityZone^Optional

public readonly availabilityZone: string;

• Type: string
• Default: no preference

The name of the Availability Zone where the DB instance will be located.

---

backupRetention^Optional

public readonly backupRetention: Duration;

• Type: aws-cdk-lib.Duration
• Default: Duration.days(1) for source instances, disabled for read replicas

The number of days during which automatic DB snapshots are retained.

Set to zero to disable backups. When creating a read replica, you must enable automatic backups on the source database instance by setting the backup retention to a value other than zero.

---

caCertificate^Optional

public readonly caCertificate: CaCertificate;

• Type: aws-cdk-lib.aws_rds.CaCertificate
• Default: RDS will choose a certificate authority

The identifier of the CA certificate for this DB instance.

Specifying or updating this property triggers a reboot.

For RDS DB engines:

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html

---

cloudwatchLogsExports^Optional

public readonly cloudwatchLogsExports: string[];

• Type: string[]
• Default: no log exports

The list of log types that need to be enabled for exporting to CloudWatch Logs.

---

cloudwatchLogsRetention^Optional

public readonly cloudwatchLogsRetention: RetentionDays;

• Type: aws-cdk-lib.aws_logs.RetentionDays
• Default: logs never expire

The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn’t remove the log retention policy. To remove the retention policy, set the value to Infinity.

---

cloudwatchLogsRetentionRole^Optional

public readonly cloudwatchLogsRetentionRole: IRole;

• Type: aws-cdk-lib.aws_iam.IRole
• Default: a new role is created.

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

---

copyTagsToSnapshot^Optional

public readonly copyTagsToSnapshot: boolean;

• Type: boolean
• Default: true

Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.

---

deleteAutomatedBackups^Optional

public readonly deleteAutomatedBackups: boolean;

• Type: boolean
• Default: true

Indicates whether automated backups should be deleted or retained when you delete a DB instance.

---

deletionProtection^Optional

public readonly deletionProtection: boolean;

• Type: boolean
• Default: true if removalPolicy is RETAIN, false otherwise

Indicates whether the DB instance should have deletion protection enabled.

---

domain^Optional

public readonly domain: string;

• Type: string
• Default: Do not join domain

The Active Directory directory ID to create the DB instance in.

---

domainRole^Optional

public readonly domainRole: IRole;

• Type: aws-cdk-lib.aws_iam.IRole
• Default: The role will be created for you if DatabaseInstanceNewProps#domain is specified

The IAM role to be used when making API calls to the Directory Service.

The role needs the AWS-managed policy AmazonRDSDirectoryServiceAccess or equivalent.

---

enablePerformanceInsights^Optional

public readonly enablePerformanceInsights: boolean;

• Type: boolean
• Default: false, unless performanceInsightRetention or performanceInsightEncryptionKey is set.

Whether to enable Performance Insights for the DB instance.

---

iamAuthentication^Optional

public readonly iamAuthentication: boolean;

• Type: boolean
• Default: false

Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

---

instanceIdentifier^Optional

public readonly instanceIdentifier: string;

• Type: string
• Default: a CloudFormation generated name

A name for the DB instance.

If you specify a name, AWS CloudFormation converts it to lowercase.

---

iops^Optional

public readonly iops: number;

• Type: number
• Default: no provisioned iops if storage type is not specified. For GP3: 3,000 IOPS if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 12,000 IOPS otherwise (except for SQL Server where the default is always 3,000 IOPS).

The number of I/O operations per second (IOPS) that the database provisions.

The value must be equal to or greater than 1000.

---

maxAllocatedStorage^Optional

public readonly maxAllocatedStorage: number;

• Type: number
• Default: No autoscaling of RDS instance

Upper limit to which RDS can scale the storage in GiB(Gibibyte).

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling

---

monitoringInterval^Optional

public readonly monitoringInterval: Duration;

• Type: aws-cdk-lib.Duration
• Default: no enhanced monitoring

The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.

---

monitoringRole^Optional

public readonly monitoringRole: IRole;

• Type: aws-cdk-lib.aws_iam.IRole
• Default: A role is automatically created for you

Role that will be used to manage DB instance monitoring.

---

multiAz^Optional

public readonly multiAz: boolean;

• Type: boolean
• Default: false

Specifies if the database instance is a multiple Availability Zone deployment.

---

networkType^Optional

public readonly networkType: NetworkType;

• Type: aws-cdk-lib.aws_rds.NetworkType
• Default: IPV4

The network type of the DB instance.

---

optionGroup^Optional

public readonly optionGroup: IOptionGroup;

• Type: aws-cdk-lib.aws_rds.IOptionGroup
• Default: no option group

The option group to associate with the instance.

---

parameterGroup^Optional

public readonly parameterGroup: IParameterGroup;

• Type: aws-cdk-lib.aws_rds.IParameterGroup
• Default: no parameter group

The DB parameter group to associate with the instance.

---

performanceInsightEncryptionKey^Optional

public readonly performanceInsightEncryptionKey: IKey;

• Type: aws-cdk-lib.aws_kms.IKey
• Default: default master key

The AWS KMS key for encryption of Performance Insights data.

---

performanceInsightRetention^Optional

public readonly performanceInsightRetention: PerformanceInsightRetention;

• Type: aws-cdk-lib.aws_rds.PerformanceInsightRetention
• Default: 7 this is the free tier

The amount of time, in days, to retain Performance Insights data.

---

port^Optional

public readonly port: number;

• Type: number
• Default: the default port for the chosen engine.

The port for the instance.

---

preferredBackupWindow^Optional

public readonly preferredBackupWindow: string;

• Type: string
• Default: a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

The daily time range during which automated backups are performed.

Constraints:

• Must be in the format hh24:mi-hh24:mi.
• Must be in Universal Coordinated Time (UTC).
• Must not conflict with the preferred maintenance window.
• Must be at least 30 minutes.

---

preferredMaintenanceWindow^Optional

public readonly preferredMaintenanceWindow: string;

• Type: string
• Default: a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

The weekly time range (in UTC) during which system maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window

---

processorFeatures^Optional

public readonly processorFeatures: ProcessorFeatures;

• Type: aws-cdk-lib.aws_rds.ProcessorFeatures
• Default: the default number of CPU cores and threads per core for the chosen instance class. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor

The number of CPU cores and the number of threads per core.

---

publiclyAccessible^Optional

public readonly publiclyAccessible: boolean;

• Type: boolean
• Default: true if the instance’s vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise

Indicates whether the DB instance is an internet-facing instance.

If not specified, the instance’s vpcSubnets will be used to determine if the instance is internet-facing or not.

---

removalPolicy^Optional

public readonly removalPolicy: RemovalPolicy;

• Type: aws-cdk-lib.RemovalPolicy
• Default: RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)

The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

---

s3ExportBuckets^Optional

public readonly s3ExportBuckets: IBucket[];

• Type: aws-cdk-lib.aws_s3.IBucket[]
• Default: None

S3 buckets that you want to load data into.

This property must not be used if s3ExportRole is used.

For Microsoft SQL Server:

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html

---

s3ExportRole^Optional

public readonly s3ExportRole: IRole;

• Type: aws-cdk-lib.aws_iam.IRole
• Default: New role is created if s3ExportBuckets is set, no role is defined otherwise

Role that will be associated with this DB instance to enable S3 export.

This property must not be used if s3ExportBuckets is used.

For Microsoft SQL Server:

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html

---

s3ImportBuckets^Optional

public readonly s3ImportBuckets: IBucket[];

• Type: aws-cdk-lib.aws_s3.IBucket[]
• Default: None

S3 buckets that you want to load data from.

This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.

This property must not be used if s3ImportRole is used.

For Microsoft SQL Server:

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html

---

s3ImportRole^Optional

public readonly s3ImportRole: IRole;

• Type: aws-cdk-lib.aws_iam.IRole
• Default: New role is created if s3ImportBuckets is set, no role is defined otherwise

Role that will be associated with this DB instance to enable S3 import.

This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.

This property must not be used if s3ImportBuckets is used.

For Microsoft SQL Server:

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html

---

securityGroups^Optional

public readonly securityGroups: ISecurityGroup[];

• Type: aws-cdk-lib.aws_ec2.ISecurityGroup[]
• Default: a new security group is created

The security groups to assign to the DB instance.

---

storageThroughput^Optional

public readonly storageThroughput: number;

• Type: number
• Default: 125 MiBps if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 500 MiBps otherwise (except for SQL Server where the default is always 125 MiBps).

The storage throughput, specified in mebibytes per second (MiBps).

Only applicable for GP3.

https://docs.aws.amazon.com//AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage

---

storageType^Optional

public readonly storageType: StorageType;

• Type: aws-cdk-lib.aws_rds.StorageType
• Default: GP2

The storage type.

Storage types supported are gp2, io1, standard.

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD

---

subnetGroup^Optional

public readonly subnetGroup: ISubnetGroup;

• Type: aws-cdk-lib.aws_rds.ISubnetGroup
• Default: a new subnet group will be created.

Existing subnet group for the instance.

---

vpcSubnets^Optional

public readonly vpcSubnets: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection
• Default: private subnets

The type of subnets to add to the created DB subnet group.

---

engine^Required

public readonly engine: IInstanceEngine;

• Type: aws-cdk-lib.aws_rds.IInstanceEngine

The database engine.

---

allocatedStorage^Optional

public readonly allocatedStorage: number;

• Type: number
• Default: 100

The allocated storage size, specified in gibibytes (GiB).

---

allowMajorVersionUpgrade^Optional

public readonly allowMajorVersionUpgrade: boolean;

• Type: boolean
• Default: false

Whether to allow major version upgrades.

---

databaseName^Optional

public readonly databaseName: string;

• Type: string
• Default: no name

The name of the database.

---

instanceType^Optional

public readonly instanceType: InstanceType;

• Type: aws-cdk-lib.aws_ec2.InstanceType
• Default: m5.large (or, more specifically, db.m5.large)

The name of the compute and memory capacity for the instance.

---

licenseModel^Optional

public readonly licenseModel: LicenseModel;

• Type: aws-cdk-lib.aws_rds.LicenseModel
• Default: RDS default license model

The license model.

---

parameters^Optional

public readonly parameters: {[ key: string ]: string};

• Type: {[ key: string ]: string}
• Default: None

The parameters in the DBParameterGroup to create automatically.

You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup.

---

timezone^Optional

public readonly timezone: string;

• Type: string
• Default: RDS default timezone

The time zone of the instance.

This is currently supported only by Microsoft Sql Server.

---

characterSetName^Optional

public readonly characterSetName: string;

• Type: string
• Default: RDS default character set name

For supported engines, specifies the character set to associate with the DB instance.

---

credentials^Optional

public readonly credentials: Credentials;

• Type: aws-cdk-lib.aws_rds.Credentials
• Default: A username of ‘admin’ (or ‘postgres’ for PostgreSQL) and SecretsManager-generated password

Credentials for the administrative user.

---

storageEncrypted^Optional

public readonly storageEncrypted: boolean;

• Type: boolean
• Default: true if storageEncryptionKey has been provided, false otherwise

Indicates whether the DB instance is encrypted.

---

storageEncryptionKey^Optional

public readonly storageEncryptionKey: IKey;

• Type: aws-cdk-lib.aws_kms.IKey
• Default: default master key if storageEncrypted is true, no key otherwise

The KMS key that’s used to encrypt the DB instance.

---

bootstrapperLambdaFunctionOptions^Optional

public readonly bootstrapperLambdaFunctionOptions: any;

• Type: any
• Default: defined in the construct.

Can be used to override the default lambda function properties.

---

customResourceProperties^Optional

public readonly customResourceProperties: {[ key: string ]: any};

• Type: {[ key: string ]: any}

Lambda function Custom Resource properties.

A custom resource property is going to be created to trigger the boostrapping lambda function. This parameter allows the user to specify additional properties on top of the defaults ones.

---

pgstacDbName^Optional

public readonly pgstacDbName: string;

• Type: string
• Default: pgstac

Name of database that is to be created and onto which pgSTAC will be installed.

---

pgstacUsername^Optional

public readonly pgstacUsername: string;

• Type: string
• Default: pgstac_user

Name of user that will be generated for connecting to the pgSTAC database.

---

secretsPrefix^Optional

public readonly secretsPrefix: string;

• Type: string
• Default: pgstac

Prefix to assign to the generated secrets_manager.Secret.

---

StacBrowserProps

Initializer

import { StacBrowserProps } from 'eoapi-cdk'

const stacBrowserProps: StacBrowserProps = { ... }

Properties

Name	Type	Description
githubRepoTag	string	Tag of the radiant earth stac-browser repo to use to build the app.
stacCatalogUrl	string	STAC catalog URL.
bucketArn	string	Bucket ARN.
cloneDirectory	string	Location in the filesystem where to compile the browser code.
cloudFrontDistributionArn	string	The ARN of the cloudfront distribution that will be added to the bucket policy with read access.
configFilePath	string	Path to config file for the STAC browser.
websiteIndexDocument	string	The name of the index document (e.g. “index.html”) for the website. Enables static website hosting for this bucket.

---

githubRepoTag^Required

public readonly githubRepoTag: string;

• Type: string

Tag of the radiant earth stac-browser repo to use to build the app.

---

stacCatalogUrl^Required

public readonly stacCatalogUrl: string;

• Type: string

STAC catalog URL.

Overrides the catalog URL in the stac-browser configuration.

---

bucketArn^Optional

public readonly bucketArn: string;

• Type: string
• Default: No bucket ARN. A new bucket will be created.

Bucket ARN.

If specified, the identity used to deploy the stack must have the appropriate permissions to create a deployment for this bucket. In addition, if specified, cloudFrontDistributionArn is ignored since the policy of an imported resource can’t be modified.

---

cloneDirectory^Optional

public readonly cloneDirectory: string;

• Type: string
• Default: DEFAULT_CLONE_DIRECTORY

Location in the filesystem where to compile the browser code.

---

cloudFrontDistributionArn^Optional

public readonly cloudFrontDistributionArn: string;

• Type: string
• Default: No cloudfront distribution ARN. The bucket policy will not be modified.

The ARN of the cloudfront distribution that will be added to the bucket policy with read access.

If bucketArn is specified, this parameter is ignored since the policy of an imported bucket can’t be modified.

---

configFilePath^Optional

public readonly configFilePath: string;

• Type: string

Path to config file for the STAC browser.

If not provided, default configuration in the STAC browser repository is used.

---

websiteIndexDocument^Optional

public readonly websiteIndexDocument: string;

• Type: string
• Default: No index document.

The name of the index document (e.g. “index.html”) for the website. Enables static website hosting for this bucket.

---

StacIngestorProps

Initializer

import { StacIngestorProps } from 'eoapi-cdk'

const stacIngestorProps: StacIngestorProps = { ... }

Properties

Name	Type	Description
dataAccessRole	aws-cdk-lib.aws_iam.IRole	ARN of AWS Role used to validate access to S3 data.
stacDbSecret	aws-cdk-lib.aws_secretsmanager.ISecret	Secret containing pgSTAC DB connection information.
stacDbSecurityGroup	aws-cdk-lib.aws_ec2.ISecurityGroup	Security Group used by pgSTAC DB.
stacUrl	string	URL of STAC API.
stage	string	Stage of deployment (e.g. dev, prod).
apiEndpointConfiguration	aws-cdk-lib.aws_apigateway.EndpointConfiguration	API Endpoint Configuration, useful for creating private APIs.
apiEnv	{[ key: string ]: string}	Environment variables to be sent to Lambda.
apiLambdaFunctionOptions	any	Can be used to override the default lambda function properties.
apiPolicy	aws-cdk-lib.aws_iam.PolicyDocument	API Policy Document, useful for creating private APIs.
ingestorDomainNameOptions	aws-cdk-lib.aws_apigateway.DomainNameOptions	Custom Domain Name Options for Ingestor API.
ingestorLambdaFunctionOptions	any	Can be used to override the default lambda function properties.
subnetSelection	aws-cdk-lib.aws_ec2.SubnetSelection	Subnet into which the lambda should be deployed if using a VPC.
vpc	aws-cdk-lib.aws_ec2.IVpc	VPC running pgSTAC DB.

---

dataAccessRole^Required

public readonly dataAccessRole: IRole;

• Type: aws-cdk-lib.aws_iam.IRole

ARN of AWS Role used to validate access to S3 data.

---

stacDbSecret^Required

public readonly stacDbSecret: ISecret;

• Type: aws-cdk-lib.aws_secretsmanager.ISecret

Secret containing pgSTAC DB connection information.

---

stacDbSecurityGroup^Required

public readonly stacDbSecurityGroup: ISecurityGroup;

• Type: aws-cdk-lib.aws_ec2.ISecurityGroup

Security Group used by pgSTAC DB.

---

stacUrl^Required

public readonly stacUrl: string;

• Type: string

URL of STAC API.

---

stage^Required

public readonly stage: string;

• Type: string

Stage of deployment (e.g. dev, prod).

---

apiEndpointConfiguration^Optional

public readonly apiEndpointConfiguration: EndpointConfiguration;

• Type: aws-cdk-lib.aws_apigateway.EndpointConfiguration

API Endpoint Configuration, useful for creating private APIs.

---

apiEnv^Optional

public readonly apiEnv: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Environment variables to be sent to Lambda.

---

apiLambdaFunctionOptions^Optional

public readonly apiLambdaFunctionOptions: any;

• Type: any
• Default: default settings are defined in the construct.

Can be used to override the default lambda function properties.

---

apiPolicy^Optional

public readonly apiPolicy: PolicyDocument;

• Type: aws-cdk-lib.aws_iam.PolicyDocument

API Policy Document, useful for creating private APIs.

---

ingestorDomainNameOptions^Optional

public readonly ingestorDomainNameOptions: DomainNameOptions;

• Type: aws-cdk-lib.aws_apigateway.DomainNameOptions

Custom Domain Name Options for Ingestor API.

---

ingestorLambdaFunctionOptions^Optional

public readonly ingestorLambdaFunctionOptions: any;

• Type: any
• Default: default settings are defined in the construct.

Can be used to override the default lambda function properties.

---

subnetSelection^Optional

public readonly subnetSelection: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection

Subnet into which the lambda should be deployed if using a VPC.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

VPC running pgSTAC DB.

---

TiPgApiLambdaProps

Initializer

import { TiPgApiLambdaProps } from 'eoapi-cdk'

const tiPgApiLambdaProps: TiPgApiLambdaProps = { ... }

Properties

Name	Type	Description
db	aws-cdk-lib.aws_rds.IDatabaseInstance	RDS Instance with installed pgSTAC.
dbSecret	aws-cdk-lib.aws_secretsmanager.ISecret	Secret containing connection information for pgSTAC database.
apiEnv	{[ key: string ]: string}	Customized environment variables to send to titiler-pgstac runtime.
lambdaFunctionOptions	any	Can be used to override the default lambda function properties.
subnetSelection	aws-cdk-lib.aws_ec2.SubnetSelection	Subnet into which the lambda should be deployed.
tipgApiDomainName	@aws-cdk/aws-apigatewayv2-alpha.IDomainName	Custom Domain Name for tipg API.
vpc	aws-cdk-lib.aws_ec2.IVpc	VPC into which the lambda should be deployed.

---

db^Required

public readonly db: IDatabaseInstance;

• Type: aws-cdk-lib.aws_rds.IDatabaseInstance

RDS Instance with installed pgSTAC.

---

dbSecret^Required

public readonly dbSecret: ISecret;

• Type: aws-cdk-lib.aws_secretsmanager.ISecret

Secret containing connection information for pgSTAC database.

---

apiEnv^Optional

public readonly apiEnv: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Customized environment variables to send to titiler-pgstac runtime.

---

lambdaFunctionOptions^Optional

public readonly lambdaFunctionOptions: any;

• Type: any
• Default: defined in the construct.

Can be used to override the default lambda function properties.

---

subnetSelection^Optional

public readonly subnetSelection: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection

Subnet into which the lambda should be deployed.

---

tipgApiDomainName^Optional

public readonly tipgApiDomainName: IDomainName;

• Type: @aws-cdk/aws-apigatewayv2-alpha.IDomainName
• Default: undefined

Custom Domain Name for tipg API.

If defined, will create the domain name and integrate it with the tipg API.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

VPC into which the lambda should be deployed.

---

TitilerPgStacApiLambdaProps

Initializer

import { TitilerPgStacApiLambdaProps } from 'eoapi-cdk'

const titilerPgStacApiLambdaProps: TitilerPgStacApiLambdaProps = { ... }

Properties

Name	Type	Description
db	aws-cdk-lib.aws_rds.IDatabaseInstance	RDS Instance with installed pgSTAC.
dbSecret	aws-cdk-lib.aws_secretsmanager.ISecret	Secret containing connection information for pgSTAC database.
apiEnv	{[ key: string ]: string}	Customized environment variables to send to titiler-pgstac runtime.
buckets	string[]	list of buckets the lambda will be granted access to.
lambdaFunctionOptions	any	Can be used to override the default lambda function properties.
subnetSelection	aws-cdk-lib.aws_ec2.SubnetSelection	Subnet into which the lambda should be deployed.
titilerPgstacApiDomainName	@aws-cdk/aws-apigatewayv2-alpha.IDomainName	Custom Domain Name Options for Titiler Pgstac API,.
vpc	aws-cdk-lib.aws_ec2.IVpc	VPC into which the lambda should be deployed.

---

db^Required

public readonly db: IDatabaseInstance;

• Type: aws-cdk-lib.aws_rds.IDatabaseInstance

RDS Instance with installed pgSTAC.

---

dbSecret^Required

public readonly dbSecret: ISecret;

• Type: aws-cdk-lib.aws_secretsmanager.ISecret

Secret containing connection information for pgSTAC database.

---

apiEnv^Optional

public readonly apiEnv: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Customized environment variables to send to titiler-pgstac runtime.

These will be merged with defaultTitilerPgstacEnv. The database secret arn is automatically added to the environment variables at deployment. /

---

buckets^Optional

public readonly buckets: string[];

• Type: string[]

list of buckets the lambda will be granted access to.

---

lambdaFunctionOptions^Optional

public readonly lambdaFunctionOptions: any;

• Type: any
• Default: defined in the construct.

Can be used to override the default lambda function properties.

---

subnetSelection^Optional

public readonly subnetSelection: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection

Subnet into which the lambda should be deployed.

---

titilerPgstacApiDomainName^Optional

public readonly titilerPgstacApiDomainName: IDomainName;

• Type: @aws-cdk/aws-apigatewayv2-alpha.IDomainName
• Default: undefined.

Custom Domain Name Options for Titiler Pgstac API,.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

VPC into which the lambda should be deployed.

---