Skip to content

API.md

Latest commit

 

History

History
208 lines (127 loc) · 6.25 KB

API.md

File metadata and controls

208 lines (127 loc) · 6.25 KB
Raw

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.
with Applies one or more mixins to this construct.
toString 
public toString(): string

Returns a string representation of this construct.

with 
public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.

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.

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.

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.