Skip to content

Latest commit

 

History

History
249 lines (147 loc) · 7.79 KB

API.md

File metadata and controls

249 lines (147 loc) · 7.79 KB
Raw

API Reference

Constructs

EdgeDB

Initializers 

import { EdgeDB } from 'cdk-edgedb'

new EdgeDB(scope: Construct, id: string, props?: EdgeDBProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props EdgeDBProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsOptional

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 { EdgeDB } from 'cdk-edgedb'

EdgeDB.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
endpoint string FQDN of the Network Load Balancer used as part of the EdgeDB deployment, you can connect to query EdgeDB from this endpoint.
secret aws-cdk-lib.aws_secretsmanager.Secret Secrets Manager secret containing the automatically generated EdgeDB server credentials.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

endpointRequired 
public readonly endpoint: string;
  • Type: string

FQDN of the Network Load Balancer used as part of the EdgeDB deployment, you can connect to query EdgeDB from this endpoint.

secretRequired 
public readonly secret: Secret;
  • Type: aws-cdk-lib.aws_secretsmanager.Secret

Secrets Manager secret containing the automatically generated EdgeDB server credentials.

Structs

EdgeDBCustomDomainProps

Initializer 

import { EdgeDBCustomDomainProps } from 'cdk-edgedb'

const edgeDBCustomDomainProps: EdgeDBCustomDomainProps = { ... }

Properties

Name Type Description
email string An email address to use for the Lets Encrypt certificate registration.
hostedZoneId string The Route53 Hosted Zone ID that is authoritative for the Custom Domain name to be used as the EdgeDB endpoint.
name string The FQDN of the Custom Domain name to be used for the EdgeDB endpoint.
zoneName string The Route53 Hosted Zone Name that is authoritative for the Custom Domain name to be used as the EdgeDB endpoint.
emailRequired 
public readonly email: string;
  • Type: string

An email address to use for the Lets Encrypt certificate registration.

hostedZoneIdRequired 
public readonly hostedZoneId: string;
  • Type: string

The Route53 Hosted Zone ID that is authoritative for the Custom Domain name to be used as the EdgeDB endpoint.

nameRequired 
public readonly name: string;
  • Type: string

The FQDN of the Custom Domain name to be used for the EdgeDB endpoint.

zoneNameRequired 
public readonly zoneName: string;
  • Type: string

The Route53 Hosted Zone Name that is authoritative for the Custom Domain name to be used as the EdgeDB endpoint.

EdgeDBProps

Initializer 

import { EdgeDBProps } from 'cdk-edgedb'

const edgeDBProps: EdgeDBProps = { ... }

Properties

Name Type Description
customDomain EdgeDBCustomDomainProps Properties for using a Custom Domain name to be used as the EdgeDB endpoint, an authoritative zone for the domain must already exist in Route53.
highAvailability boolean When true, EdgeDB server and Aurora PostgreSQL will deployed with two Tasks/Nodes in separate availability-zones.
customDomainOptional 
public readonly customDomain: EdgeDBCustomDomainProps;

Properties for using a Custom Domain name to be used as the EdgeDB endpoint, an authoritative zone for the domain must already exist in Route53.

  • @default - Not used.
highAvailabilityOptional 
public readonly highAvailability: boolean;
  • Type: boolean

When true, EdgeDB server and Aurora PostgreSQL will deployed with two Tasks/Nodes in separate availability-zones.

  • @default - true