Skip to content
This repository has been archived by the owner on Nov 9, 2023. It is now read-only.

Latest commit

 

History

History
293 lines (179 loc) · 9.3 KB

API.md

File metadata and controls

293 lines (179 loc) · 9.3 KB
Raw

API Reference

Constructs

DocumentDB

Initializers 

import { DocumentDB } from '@time-loop/cdk-documentdb'

new DocumentDB(scope: Construct, id: Namer, props: DocumentDBProps)
Name Type Description
scope constructs.Construct No description.
id multi-convention-namer.Namer No description.
props DocumentDBProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: multi-convention-namer.Namer
propsRequired

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 { DocumentDB } from '@time-loop/cdk-documentdb'

DocumentDB.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
cluster aws-cdk-lib.aws_docdb.DatabaseCluster No description.
kmsKey aws-cdk-lib.aws_kms.IKey No description.
secret aws-cdk-lib.aws_docdb.DatabaseSecret No description.
securityGroup aws-cdk-lib.aws_ec2.ISecurityGroup No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

clusterRequired 
public readonly cluster: DatabaseCluster;
  • Type: aws-cdk-lib.aws_docdb.DatabaseCluster
kmsKeyRequired 
public readonly kmsKey: IKey;
  • Type: aws-cdk-lib.aws_kms.IKey
secretRequired 
public readonly secret: DatabaseSecret;
  • Type: aws-cdk-lib.aws_docdb.DatabaseSecret
securityGroupRequired 
public readonly securityGroup: ISecurityGroup;
  • Type: aws-cdk-lib.aws_ec2.ISecurityGroup

Structs

DocumentDBProps

Initializer 

import { DocumentDBProps } from '@time-loop/cdk-documentdb'

const documentDBProps: DocumentDBProps = { ... }

Properties

Name Type Description
vpc aws-cdk-lib.aws_ec2.IVpc Which VPC?
backup aws-cdk-lib.aws_docdb.BackupProps Backup configuration.
dbClusterName string The identifier for the cluster.
deletionProtection boolean DeletionProtection.
instances number Number of DocDB compute instances.
instanceType aws-cdk-lib.aws_ec2.InstanceType What size/type of boxes should the instances be on?
kmsKey aws-cdk-lib.aws_kms.IKey Kms Key - you probably want to provide one, but...
removalPolicy aws-cdk-lib.RemovalPolicy Removal Policy - applies to both the actual documentdb and the kms key (if created).
securityGroup aws-cdk-lib.aws_ec2.ISecurityGroup Security group.
vpcRequired 
public readonly vpc: IVpc;
  • Type: aws-cdk-lib.aws_ec2.IVpc

Which VPC?

backupOptional 
public readonly backup: BackupProps;
  • Type: aws-cdk-lib.aws_docdb.BackupProps
  • Default: {retention:Duration.days(30)}

Backup configuration.

dbClusterNameOptional 
public readonly dbClusterName: string;
  • Type: string
  • Default: id.pascal

The identifier for the cluster.

deletionProtectionOptional 
public readonly deletionProtection: boolean;
  • Type: boolean
  • Default: true

DeletionProtection.

instancesOptional 
public readonly instances: number;
  • Type: number
  • Default: 1

Number of DocDB compute instances.

instanceTypeOptional 
public readonly instanceType: InstanceType;
  • Type: aws-cdk-lib.aws_ec2.InstanceType
  • Default: InstanceType.of(InstanceClass.R5,InstanceSize.LARGE)

What size/type of boxes should the instances be on?

kmsKeyOptional 
public readonly kmsKey: IKey;
  • Type: aws-cdk-lib.aws_kms.IKey
  • Default: generate a KMS Key

Kms Key - you probably want to provide one, but...

removalPolicyOptional 
public readonly removalPolicy: RemovalPolicy;
  • Type: aws-cdk-lib.RemovalPolicy
  • Default: passthrough to RETAIN.

Removal Policy - applies to both the actual documentdb and the kms key (if created).

securityGroupOptional 
public readonly securityGroup: ISecurityGroup;
  • Type: aws-cdk-lib.aws_ec2.ISecurityGroup
  • Default: undefined a new security group is created.

Security group.