Skip to content

Latest commit

 

History

History
172 lines (101 loc) · 4.8 KB

API.md

File metadata and controls

172 lines (101 loc) · 4.8 KB

API Reference

Constructs

CloudDuck

The CloudDuck construct.

This construct creates a serverless analysis environment using DuckDB for S3 data

Initializers 

import { CloudDuck } from 'cloud-duck'

new CloudDuck(scope: Construct, id: string, props?: CloudDuckProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props CloudDuckProps 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 { CloudDuck } from 'cloud-duck'

CloudDuck.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Structs

CloudDuckProps

Props for the CloudDuck construct.

Initializer 

import { CloudDuckProps } from 'cloud-duck'

const cloudDuckProps: CloudDuckProps = { ... }

Properties

Name Type Description
memory aws-cdk-lib.Size The amount of memory to allocate to the Lambda function.
targetBuckets aws-cdk-lib.aws_s3.Bucket[] The S3 buckets which the cloud duck will analyze.
userPoolProps aws-cdk-lib.aws_cognito.UserPoolProps The Cognito UserPool props.
memoryOptional 
public readonly memory: Size;
  • Type: aws-cdk-lib.Size
  • Default: 1024 MiB

The amount of memory to allocate to the Lambda function.

targetBucketsOptional 
public readonly targetBuckets: Bucket[];
  • Type: aws-cdk-lib.aws_s3.Bucket[]
  • Default: All buckets in the account

The S3 buckets which the cloud duck will analyze.

userPoolPropsOptional 
public readonly userPoolProps: UserPoolProps;
  • Type: aws-cdk-lib.aws_cognito.UserPoolProps
  • Default: selfSignUpEnabled: false, signInAliases: { email: true }, autoVerify: { email: true }, removalPolicy: RemovalPolicy.DESTROY

The Cognito UserPool props.