Interface OSMLRestApiProps

Represents the properties required to configure the OSMLRestApi Construct.

interface OSMLRestApiProps {
    account: OSMLAccount;
    apiStageName: string;
    auth: OSMLAuth;
    integration: Integration;
    lambdaRole?: IRole;
    name: string;
    osmlVpc: OSMLVpc;
}

Properties

account apiStageName auth integration lambdaRole? name osmlVpc

Properties

account

account: OSMLAccount

The configuration for the authentication.

apiStageName

apiStageName: string

The name of the stage deployment for RestApi

auth

auth: OSMLAuth

The configuration for the authentication.

integration

integration: Integration

The integration for the handler of the RestApi

OptionallambdaRole

lambdaRole?: IRole

The IAM role for the Lambda function.

name

name: string

The name of the service

osmlVpc

osmlVpc: OSMLVpc

The OSML VPC (Virtual Private Cloud) configuration for the Dataplane.

Settings

Member Visibility

On This Page

Properties