Skip to content

Latest commit

 

History

History
237 lines (141 loc) · 8.33 KB

API.md

File metadata and controls

237 lines (141 loc) · 8.33 KB

API Reference

Constructs

BlockchainListener

Initializers 

import { BlockchainListener } from '@odfdata/blockchain-listener'

new BlockchainListener(scope: Construct, id: string, props: BlockchainListenerProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props BlockchainListenerProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
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 { BlockchainListener } from '@odfdata/blockchain-listener'

BlockchainListener.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
blockchainListenerContainer aws-cdk-lib.aws_ecs.ContainerDefinition The blockchain listener docker container.
ecsLogGroup aws-cdk-lib.aws_logs.LogGroup The AWS LogGroup the ECS Fargate Task will write logs in.
eventBus aws-cdk-lib.aws_events.EventBus The AWS EventBus you can use to send events to.
securityGroup aws-cdk-lib.aws_ec2.SecurityGroup The AWS Security Group created to allow connections just from the inside to the outside.
vpc aws-cdk-lib.aws_ec2.Vpc The AWS VPC created for the ECS Cluster.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

blockchainListenerContainerRequired 
public readonly blockchainListenerContainer: ContainerDefinition;
  • Type: aws-cdk-lib.aws_ecs.ContainerDefinition

The blockchain listener docker container.

It gives you the control to set environment variables, if it's necessary

ecsLogGroupRequired 
public readonly ecsLogGroup: LogGroup;
  • Type: aws-cdk-lib.aws_logs.LogGroup

The AWS LogGroup the ECS Fargate Task will write logs in.

eventBusRequired 
public readonly eventBus: EventBus;
  • Type: aws-cdk-lib.aws_events.EventBus

The AWS EventBus you can use to send events to.

securityGroupRequired 
public readonly securityGroup: SecurityGroup;
  • Type: aws-cdk-lib.aws_ec2.SecurityGroup

The AWS Security Group created to allow connections just from the inside to the outside.

vpcRequired 
public readonly vpc: Vpc;
  • Type: aws-cdk-lib.aws_ec2.Vpc

The AWS VPC created for the ECS Cluster.

Structs

BlockchainListenerProps

It's the Blockchain Listener properties interface.

Initializer 

import { BlockchainListenerProps } from '@odfdata/blockchain-listener'

const blockchainListenerProps: BlockchainListenerProps = { ... }

Properties

Name Type Description
cidrBlock string The range of IP addresses in which the ECS Fargate Task will be put in.
containerImageDirectory string The directory in which the Docker file is placed.
cpuArchitecture aws-cdk-lib.aws_ecs.CpuArchitecture The CPU architecture you want to use for your Fargate Task.
cidrBlockRequired 
public readonly cidrBlock: string;
  • Type: string
  • Default: 11.1.0.0/24

The range of IP addresses in which the ECS Fargate Task will be put in.

containerImageDirectoryRequired 
public readonly containerImageDirectory: string;
  • Type: string
  • Default: src/

The directory in which the Docker file is placed.

cpuArchitectureRequired 
public readonly cpuArchitecture: CpuArchitecture;
  • Type: aws-cdk-lib.aws_ecs.CpuArchitecture
  • Default: aws-cdk-lib.aws_ecs.CpuArchitecture.ARM64

The CPU architecture you want to use for your Fargate Task.

Remember that it needs to be the same one of your building environment (pipeline or local machine)