Skip to content

API.md

Latest commit

 

History

History
339 lines (200 loc) · 11.6 KB

API.md

File metadata and controls

339 lines (200 loc) · 11.6 KB

API Reference

Constructs

EthereumNode

Initializers 

import { EthereumNode } from '@cdklabs/cdk-ethereum-node'

new EthereumNode(scope: Construct, id: string, props?: EthereumNodeProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props EthereumNodeProps 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 { EthereumNode } from '@cdklabs/cdk-ethereum-node'

EthereumNode.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.
availabilityZone string The Availability Zone in which the node exists.
instanceType InstanceType The Amazon Managed Blockchain instance type for the node.
network Network Managed Blockchain Ethereum network identifier.
region string The Region in which the node exists.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

availabilityZoneRequired 
public readonly availabilityZone: string;
  • Type: string

The Availability Zone in which the node exists.

instanceTypeRequired 
public readonly instanceType: InstanceType;

The Amazon Managed Blockchain instance type for the node.

networkRequired 
public readonly network: Network;

Managed Blockchain Ethereum network identifier.

regionRequired 
public readonly region: string;
  • Type: string

The Region in which the node exists.

Structs

EthereumNodeProps

Construct properties for EthereumNode.

Initializer 

import { EthereumNodeProps } from '@cdklabs/cdk-ethereum-node'

const ethereumNodeProps: EthereumNodeProps = { ... }

Properties

Name Type Description
availabilityZone string The Availability Zone in which the node will be created.
instanceType InstanceType The Amazon Managed Blockchain instance type for the Ethereum node.
network Network The Ethereum Network in which the node will be created.
availabilityZoneOptional 
public readonly availabilityZone: string;
  • Type: string
  • Default: us-east-1a

The Availability Zone in which the node will be created.

instanceTypeOptional 
public readonly instanceType: InstanceType;

The Amazon Managed Blockchain instance type for the Ethereum node.

networkOptional 
public readonly network: Network;
  • Type: Network
  • Default: The default network selected is Mainnet network

The Ethereum Network in which the node will be created.

Enums

InstanceType

Supported instance types for Managed Blockchain nodes.

Members

Name Description
BURSTABLE3_XLARGE No description.
STANDARD5_XLARGE No description.
STANDARD5_XLARGE2 No description.
STANDARD5_XLARGE4 No description.
COMPUTE5_XLARGE2 No description.
COMPUTE5_XLARGE4 No description.
BURSTABLE3_XLARGE
STANDARD5_XLARGE
STANDARD5_XLARGE2
STANDARD5_XLARGE4
COMPUTE5_XLARGE2
COMPUTE5_XLARGE4

Network

Supported Ethereum networks for Managed Blockchain nodes.

Members

Name Description
MAINNET No description.
GOERLI No description.
RINKEBY No description.
ROPSTEN No description.
MAINNET
GOERLI
RINKEBY
ROPSTEN