API.md

API Reference

Constructs

AutoScaler

Initializer

import { AutoScaler } from '@smallcase/aws-cdk-microservice'

new AutoScaler(scope: Construct, id: string, props: AutoScalerProps)

scope^Required

• Type: @aws-cdk/core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @smallcase/aws-cdk-microservice.AutoScalerProps

---

Properties

targetGroupArn^Required

• Type: string

---

BalancerEntry

Initializer

import { BalancerEntry } from '@smallcase/aws-cdk-microservice'

new BalancerEntry(scope: Construct, id: string, props: LoadBalancerProps)

scope^Required

• Type: @aws-cdk/core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @smallcase/aws-cdk-microservice.LoadBalancerProps

---

Deployment

Initializer

import { Deployment } from '@smallcase/aws-cdk-microservice'

new Deployment(scope: Construct, id: string, props: DeploymentProps)

scope^Required

• Type: @aws-cdk/core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @smallcase/aws-cdk-microservice.DeploymentProps

---

MicroService

Initializer

import { MicroService } from '@smallcase/aws-cdk-microservice'

new MicroService(scope: Construct, id: string, props: MicroServiceProps)

scope^Required

• Type: @aws-cdk/core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @smallcase/aws-cdk-microservice.MicroServiceProps

---

Properties

appName^Required

• Type: string

---

role^Required

• Type: @smallcase/aws-cdk-microservice.InternalRole

---

sshKey^Required

• Type: string

---

subnets^Required

• Type: string[]

---

vpc^Required

• Type: string

---

applicationType^Optional

• Type: string

---

asgMaxSize^Optional

• Type: string

---

asgMinSize^Optional

• Type: string

---

createCodedeployApplication^Optional

• Type: boolean

---

deploymentPolicies^Optional

• Type: string[]

---

diskSize^Optional

• Type: number

---

diskType^Optional

• Type: string

---

env^Optional

• Type: string

---

healthCheckPath^Optional

• Type: string

---

host^Optional

• Type: string

---

instanceLabels^Optional

• Type: @aws-cdk/aws-autoscaling.CfnAutoScalingGroup.TagPropertyProperty[]

---

instanceType^Optional

• Type: string

---

lbArn^Optional

• Type: string

---

port^Optional

• Type: number

---

protocol^Optional

• Type: string

---

securityGroupProps^Optional

• Type: @smallcase/aws-cdk-microservice.InternalSG

---

sslEnabled^Optional

• Type: boolean

---

tcpRules^Optional

• Type: @smallcase/aws-cdk-microservice.IngressRule[]

---

Structs

ApplicationProps

Initializer

import { ApplicationProps } from '@smallcase/aws-cdk-microservice'

const applicationProps: ApplicationProps = { ... }

applicationName^Required

• Type: string

---

resourceType^Required

• Type: string

---

type^Required

• Type: string

---

AutoScalerProps

Initializer

import { AutoScalerProps } from '@smallcase/aws-cdk-microservice'

const autoScalerProps: AutoScalerProps = { ... }

asgName^Required

• Type: string

---

maxSize^Required

• Type: string

---

minSize^Required

• Type: string

---

subnets^Required

• Type: string[]

---

templateProps^Required

• Type: @smallcase/aws-cdk-microservice.InternalLaunchTemplateProps

---

tags^Optional

• Type: @aws-cdk/aws-autoscaling.CfnAutoScalingGroup.TagPropertyProperty[]

---

tgProps^Optional

• Type: @smallcase/aws-cdk-microservice.TargetGroupProps

---

DeploymentProps

Initializer

import { DeploymentProps } from '@smallcase/aws-cdk-microservice'

const deploymentProps: DeploymentProps = { ... }

applicationProps^Required

• Type: @smallcase/aws-cdk-microservice.ApplicationProps

---

asgNames^Required

• Type: string[]

---

deploymentConfigName^Required

• Type: string

---

deploymentGroupName^Required

• Type: string

---

roleArn^Required

• Type: string

---

tgName^Required

• Type: string

---

IngressRule

Initializer

import { IngressRule } from '@smallcase/aws-cdk-microservice'

const ingressRule: IngressRule = { ... }

port^Required

• Type: number

---

sourceSG^Required

• Type: string

---

description^Optional

• Type: string

---

InstanceStackProps

Initializer

import { InstanceStackProps } from '@smallcase/aws-cdk-microservice'

const instanceStackProps: InstanceStackProps = { ... }

asgName^Required

• Type: string

---

instanceProps^Required

• Type: @aws-cdk/aws-ec2.InstanceProps

---

instanceVolumeSize^Optional

• Type: @aws-cdk/aws-ec2.BlockDevice

---

role^Optional

• Type: @smallcase/aws-cdk-microservice.InternalRole

---

securityGroup^Optional

• Type: @smallcase/aws-cdk-microservice.InternalSG

---

tags^Optional

• Type: {[ key: string ]: string}

---

targetGroupProps^Optional

• Type: @aws-cdk/aws-elasticloadbalancingv2.NetworkTargetGroupProps

---

vpc^Optional

• Type: @smallcase/aws-cdk-microservice.InternalVPC

---

InternalBD

Initializer

import { InternalBD } from '@smallcase/aws-cdk-microservice'

const internalBD: InternalBD = { ... }

name^Required

• Type: string

---

size^Required

• Type: number

---

type^Required

• Type: @aws-cdk/aws-ec2.EbsDeviceVolumeType

---

InternalLaunchTemplateProps

Initializer

import { InternalLaunchTemplateProps } from '@smallcase/aws-cdk-microservice'

const internalLaunchTemplateProps: InternalLaunchTemplateProps = { ... }

amiImageId^Required

• Type: string

---

blockDevice^Required

• Type: @smallcase/aws-cdk-microservice.InternalBD

---

detailedMonitoring^Required

• Type: boolean

---

instanceType^Required

• Type: string

---

role^Required

• Type: @smallcase/aws-cdk-microservice.InternalRole

---

securityGroup^Required

• Type: @smallcase/aws-cdk-microservice.InternalSG

---

sshKey^Required

• Type: string

---

templateName^Required

• Type: string

---

type^Required

• Type: string

---

vpc^Required

• Type: @smallcase/aws-cdk-microservice.InternalVPC

---

existingAttributes^Optional

• Type: @aws-cdk/aws-ec2.LaunchTemplateAttributes

---

instanceVolumeSize^Optional

• Type: @aws-cdk/aws-ec2.BlockDevice

---

InternalRole

Initializer

import { InternalRole } from '@smallcase/aws-cdk-microservice'

const internalRole: InternalRole = { ... }

type^Required

• Type: string

---

additionalPolicies^Optional

• Type: any[]

---

roleArn^Optional

• Type: string

---

roleName^Optional

• Type: string

---

InternalSG

Initializer

import { InternalSG } from '@smallcase/aws-cdk-microservice'

const internalSG: InternalSG = { ... }

type^Required

• Type: string

---

allowAllOutbound^Optional

• Type: boolean

---

description^Optional

• Type: string

---

disableInlineRules^Optional

• Type: boolean

---

ingressRules^Optional

• Type: @smallcase/aws-cdk-microservice.IngressRule[]

---

securityGroupName^Optional

• Type: string

---

sgGroupId^Optional

• Type: string

---

InternalVPC

Initializer

import { InternalVPC } from '@smallcase/aws-cdk-microservice'

const internalVPC: InternalVPC = { ... }

type^Required

• Type: string

---

vpcName^Required

• Type: string

---

vpcProps^Optional

• Type: @aws-cdk/aws-ec2.VpcProps

---

LoadBalancerProps

Initializer

import { LoadBalancerProps } from '@smallcase/aws-cdk-microservice'

const loadBalancerProps: LoadBalancerProps = { ... }

appName^Required

• Type: string

---

hostHeader^Required

• Type: string

---

lbArn^Required

• Type: string

---

sslEnabled^Required

• Type: boolean

---

targetGroupArn^Required

• Type: string

---

MicroServiceProps

Initializer

import { MicroServiceProps } from '@smallcase/aws-cdk-microservice'

const microServiceProps: MicroServiceProps = { ... }

appName^Required

• Type: string

---

env^Required

• Type: string

---

role^Required

• Type: @smallcase/aws-cdk-microservice.InternalRole

---

sshKey^Required

• Type: string

---

subnets^Required

• Type: string[]

---

vpc^Required

• Type: string

---

ami^Optional

• Type: string

---

applicationType^Optional

• Type: string

---

asgMaxSize^Optional

• Type: string

---

asgMinSize^Optional

• Type: string

---

createCodedeployApplication^Optional

• Type: boolean

---

deploymentPolicies^Optional

• Type: string[]

---

diskSize^Optional

• Type: number

---

diskType^Optional

• Type: string

---

healthCheckPath^Optional

• Type: string

---

host^Optional

• Type: string

---

instanceLabels^Optional

• Type: @aws-cdk/aws-autoscaling.CfnAutoScalingGroup.TagPropertyProperty[]

---

instanceType^Optional

• Type: string

---

lbArn^Optional

• Type: string

---

port^Optional

• Type: number

---

protocol^Optional

• Type: string

---

securityGroupProps^Optional

• Type: @smallcase/aws-cdk-microservice.InternalSG

---

sslEnabled^Optional

• Type: boolean

---

tcpRules^Optional

• Type: @smallcase/aws-cdk-microservice.IngressRule[]

---

TargetGroupProps

Initializer

import { TargetGroupProps } from '@smallcase/aws-cdk-microservice'

const targetGroupProps: TargetGroupProps = { ... }

type^Required

• Type: string

---

healthPath^Optional

• Type: string

---

name^Optional

• Type: string

---

port^Optional

• Type: number

---

protocol^Optional

• Type: string

---

tgArn^Optional

• Type: string

---

thresholdCount^Optional

• Type: number

---

timeout^Optional

• Type: number

---