Class DCDataplane

Represents a construct responsible for deploying an ECR container image for the data catalog Lambda.

Hierarchy

  • Construct
    • DCDataplane

Constructors

constructor

Properties

config ingestContainer ingestFunction ingestTopic lambdaRole node osDomain removalPolicy securityGroup stacContainer stacFunction

Methods

toString isConstruct

Constructors

constructor

  • new DCDataplane(
        scope: Construct,
        id: string,
        props: DCDataplaneProps,
    ): DCDataplane

  • Creates an instance of DCDataplane.

    Parameters

    • scope: Construct

      The scope/stack in which to define this construct.

    • id: string

      The id of this construct within the current scope.

    • props: DCDataplaneProps

      The properties of this construct.

    Returns DCDataplane

    DCDataplane - The DCDataplane instance.

Properties

config

config: DCDataplaneConfig

Configuration for the DCDataplane, containing settings for containers, VPCs, etc.

ingestContainer

ingestContainer: OSMLContainer

Container that handles the building and deployment of the ingest Lambda function.

ingestFunction

ingestFunction: Function

Lambda function responsible for ingesting data into the system. This function is created from a Docker image.

ingestTopic

ingestTopic: ITopic

SNS topic to which STAC item outputs will be published.

lambdaRole

lambdaRole: IRole

IAM role used by the Lambda functions within this construct. Provides necessary permissions for the Lambda to access required AWS services.

Readonlynode

node: Node

The tree node.

osDomain

osDomain: Domain

OpenSearch domain used as the backend for the STAC API. Manages and stores the STAC items and provides search capabilities.

removalPolicy

removalPolicy: RemovalPolicy

The removal policy for resources created by this construct. Determines whether resources are retained or destroyed upon stack deletion.

securityGroup

securityGroup: ISecurityGroup

Security group associated with the resources created by this construct. Controls the network traffic to and from the resources.

stacContainer

stacContainer: OSMLContainer

Container that handles the building and deployment of the STAC API Lambda function.

stacFunction

stacFunction: Function

Lambda function responsible for the STAC API. This function is created from a Docker image.

Methods

toString

  • toString(): string

  • Returns a string representation of this construct.

    Returns string

StaticisConstruct

  • isConstruct(x: any): x is Construct

  • 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.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods