import { AutoScaler } from '@smallcase/aws-cdk-microservice'
new AutoScaler ( scope : Construct , id : string , props : AutoScalerProps )
Type: constructs.Construct
Name Description
toString Returns a string representation of this construct.
applyRemovalPolicy Apply the given removal policy to this resource.
public toString ( ) : string Returns a string representation of this construct.
public applyRemovalPolicy ( policy : RemovalPolicy ) : void Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
Type: aws-cdk-lib.RemovalPolicy
Name Description
isConstruct Checks if x is a construct.
isResource Check whether the given construct is a Resource.
import { AutoScaler } from '@smallcase/aws-cdk-microservice'
AutoScaler . isConstruct ( x : any ) Checks if x is a construct.
Any object.
import { AutoScaler } from '@smallcase/aws-cdk-microservice'
AutoScaler . isResource ( construct : IConstruct ) Check whether the given construct is a Resource.
Type: constructs.IConstruct
Name Type Description
node constructs.NodeThe tree node.
env aws-cdk-lib.ResourceEnvironmentThe environment this resource belongs to.
stack aws-cdk-lib.StackThe stack in which this resource is defined.
loadBalancerProperties LoadBalancerProps []No description.
public readonly node : Node ; The tree node.
public readonly env : ResourceEnvironment ;
Type: aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
public readonly stack : Stack ; The stack in which this resource is defined.
loadBalancerPropertiesOptional public readonly loadBalancerProperties: LoadBalancerProps [ ] ; import { BalancerEntry } from '@smallcase/aws-cdk-microservice'
new BalancerEntry ( scope : Construct , id : string , props : LoadBalancerProps )
Type: constructs.Construct
Name Description
toString Returns a string representation of this construct.
applyRemovalPolicy Apply the given removal policy to this resource.
public toString ( ) : string Returns a string representation of this construct.
public applyRemovalPolicy ( policy : RemovalPolicy ) : void Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
Type: aws-cdk-lib.RemovalPolicy
Name Description
isConstruct Checks if x is a construct.
isResource Check whether the given construct is a Resource.
import { BalancerEntry } from '@smallcase/aws-cdk-microservice'
BalancerEntry . isConstruct ( x : any ) Checks if x is a construct.
Any object.
import { BalancerEntry } from '@smallcase/aws-cdk-microservice'
BalancerEntry . isResource ( construct : IConstruct ) Check whether the given construct is a Resource.
Type: constructs.IConstruct
Name Type Description
node constructs.NodeThe tree node.
env aws-cdk-lib.ResourceEnvironmentThe environment this resource belongs to.
stack aws-cdk-lib.StackThe stack in which this resource is defined.
public readonly node : Node ; The tree node.
public readonly env : ResourceEnvironment ;
Type: aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
public readonly stack : Stack ; The stack in which this resource is defined.
import { Deployment } from '@smallcase/aws-cdk-microservice'
new Deployment ( scope : Construct , id : string , props : DeploymentProps )
Type: constructs.Construct
Name Description
toString Returns a string representation of this construct.
public toString ( ) : string Returns a string representation of this construct.
Name Description
isConstruct Checks if x is a construct.
import { Deployment } from '@smallcase/aws-cdk-microservice'
Deployment . isConstruct ( x : any ) Checks if x is a construct.
Any object.
Name Type Description
node constructs.NodeThe tree node.
public readonly node : Node ; The tree node.
import { MicroService } from '@smallcase/aws-cdk-microservice'
new MicroService ( scope : Construct , id : string , props : MicroServiceProps )
Type: constructs.Construct
Name Description
toString Returns a string representation of this construct.
public toString ( ) : string Returns a string representation of this construct.
Name Description
isConstruct Checks if x is a construct.
import { MicroService } from '@smallcase/aws-cdk-microservice'
MicroService . isConstruct ( x : any ) Checks if x is a construct.
Any object.
public readonly node : Node ; The tree node.
public readonly appName: string ; public readonly role : InternalRole ; public readonly sshKey: string ; public readonly subnets: string [ ] ; public readonly targetGroupProps: TargetGroupProps [ ] ; public readonly vpc : string ; public readonly applicationType: string ; public readonly asgMaxSize: string ; public readonly asgMinSize: string ; createCodedeployApplicationOptional public readonly createCodedeployApplication: boolean ; deploymentPoliciesOptional public readonly deploymentPolicies: string [ ] ; public readonly diskSize: number ; public readonly diskType: string ; public readonly env : string ; public readonly instanceLabels: TagPropertyProperty [ ] ;
Type: aws-cdk-lib.aws_autoscaling.CfnAutoScalingGroup.TagPropertyProperty[]
public readonly instanceType: string ; public readonly networkProps: NetworkProps [ ] ; securityGroupPropsOptional public readonly securityGroupProps: InternalSG ; public readonly tcpRules: IngressRule [ ] ; import { ApplicationProps } from '@smallcase/aws-cdk-microservice'
const applicationProps : ApplicationProps = { ... } public readonly applicationName: string ; public readonly resourceType: string ; public readonly type : string ; import { AutoScalerProps } from '@smallcase/aws-cdk-microservice'
const autoScalerProps : AutoScalerProps = { ... } public readonly appName: string ; public readonly asgName: string ; availabilityZonesRequired public readonly availabilityZones: string [ ] ; public readonly maxSize: string ; public readonly minSize: string ; public readonly networkProps: NetworkProps [ ] ; public readonly subnets: string [ ] ; public readonly templateProps: InternalLaunchTemplateProps ; public readonly tags : TagPropertyProperty [ ] ;
Type: aws-cdk-lib.aws_autoscaling.CfnAutoScalingGroup.TagPropertyProperty[]
public readonly tgProps: TargetGroupProps ; import { DeploymentProps } from '@smallcase/aws-cdk-microservice'
const deploymentProps : DeploymentProps = { ... } public readonly applicationProps: ApplicationProps ; public readonly asgNames: string [ ] ; deploymentConfigNameRequired public readonly deploymentConfigName: string ; deploymentGroupNameRequired public readonly deploymentGroupName: string ; public readonly roleArn: string ; public readonly tgName: string ; import { IngressRule } from '@smallcase/aws-cdk-microservice'
const ingressRule : IngressRule = { ... }
Name Type Description
port numberNo description.
sourceSG stringNo description.
description stringNo description.
public readonly port : number ; public readonly sourceSG: string ; public readonly description: string ; import { InstanceStackProps } from '@smallcase/aws-cdk-microservice'
const instanceStackProps : InstanceStackProps = { ... } public readonly asgName: string ; public readonly instanceProps: InstanceProps ;
Type: aws-cdk-lib.aws_ec2.InstanceProps
instanceVolumeSizeOptional public readonly instanceVolumeSize: BlockDevice ;
Type: aws-cdk-lib.aws_autoscaling.BlockDevice
public readonly role : InternalRole ; public readonly securityGroup: InternalSG ; public readonly tags : { [ key : string ] : string } ;
Type: {[ key: string ]: string}
public readonly targetGroupProps: NetworkTargetGroupProps ;
Type: aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroupProps
public readonly vpc : InternalVPC ; import { InternalBD } from '@smallcase/aws-cdk-microservice'
const internalBD : InternalBD = { ... }
Name Type Description
name stringNo description.
size numberNo description.
type aws-cdk-lib.aws_autoscaling.EbsDeviceVolumeTypeNo description.
public readonly name : string ; public readonly size : number ; public readonly type : EbsDeviceVolumeType ;
Type: aws-cdk-lib.aws_autoscaling.EbsDeviceVolumeType
InternalLaunchTemplateProps import { InternalLaunchTemplateProps } from '@smallcase/aws-cdk-microservice'
const internalLaunchTemplateProps : InternalLaunchTemplateProps = { ... } public readonly amiImageId: string ; public readonly blockDevice: InternalBD ; detailedMonitoringRequired public readonly detailedMonitoring: boolean ; public readonly instanceType: string ; public readonly role : InternalRole ; public readonly securityGroup: InternalSG ; public readonly sshKey: string ; public readonly templateName: string ; public readonly type : string ; public readonly vpc : InternalVPC ; existingAttributesOptional public readonly existingAttributes: LaunchTemplateAttributes ;
Type: aws-cdk-lib.aws_ec2.LaunchTemplateAttributes
instanceVolumeSizeOptional public readonly instanceVolumeSize: BlockDevice ;
Type: aws-cdk-lib.aws_autoscaling.BlockDevice
import { InternalRole } from '@smallcase/aws-cdk-microservice'
const internalRole : InternalRole = { ... } public readonly type : string ; additionalPoliciesOptional public readonly additionalPolicies: any [ ] ; public readonly roleArn: string ; public readonly roleName: string ; import { InternalSG } from '@smallcase/aws-cdk-microservice'
const internalSG : InternalSG = { ... } public readonly type : string ; public readonly allowAllOutbound: boolean ; public readonly description: string ; disableInlineRulesOptional public readonly disableInlineRules: boolean ; public readonly ingressRules: IngressRule [ ] ; securityGroupNameOptional public readonly securityGroupName: string ; public readonly sgGroupId: string ; import { InternalVPC } from '@smallcase/aws-cdk-microservice'
const internalVPC : InternalVPC = { ... }
Name Type Description
type stringNo description.
vpcName stringNo description.
vpcProps aws-cdk-lib.aws_ec2.VpcPropsNo description.
public readonly type : string ; public readonly vpcName: string ; public readonly vpcProps: VpcProps ;
Type: aws-cdk-lib.aws_ec2.VpcProps
import { LoadBalancerProps } from '@smallcase/aws-cdk-microservice'
const loadBalancerProps : LoadBalancerProps = { ... } public readonly appName: string ;
hostHeaderRequired public readonly hostHeader: string ; public readonly lbArn : string ; public readonly sslEnabled: boolean ; public readonly targetGroupArn: string ; public readonly zoneId: string ; public readonly zoneName: string ; import { MicroServiceProps } from '@smallcase/aws-cdk-microservice'
const microServiceProps : MicroServiceProps = { ... } public readonly ami : string ; public readonly appName: string ; availabilityZonesRequired public readonly availabilityZones: string [ ] ; public readonly env : string ; public readonly role : InternalRole ; public readonly sshKey: string ; public readonly subnets: string [ ] ; public readonly vpc : string ; public readonly applicationType: string ; public readonly asgMaxSize: string ; public readonly asgMinSize: string ; createCodedeployApplicationOptional public readonly createCodedeployApplication: boolean ; deploymentPoliciesOptional public readonly deploymentPolicies: string [ ] ; public readonly diskSize: number ; public readonly diskType: string ; public readonly instanceLabels: TagPropertyProperty [ ] ;
Type: aws-cdk-lib.aws_autoscaling.CfnAutoScalingGroup.TagPropertyProperty[]
public readonly instanceType: string ; public readonly networkProps: NetworkProps [ ] ; securityGroupPropsOptional public readonly securityGroupProps: InternalSG ; public readonly tcpRules: IngressRule [ ] ; import { NetworkProps } from '@smallcase/aws-cdk-microservice'
const networkProps : NetworkProps = { ... } public readonly healthCheckPath: string ; public readonly host : string ; public readonly lbArn : string ; public readonly port : number ; public readonly protocol: string ; public readonly sslEnabled: boolean ; public readonly zoneId: string ; public readonly zoneName: string ; import { TargetGroupProps } from '@smallcase/aws-cdk-microservice'
const targetGroupProps : TargetGroupProps = { ... } public readonly type : string ; public readonly healthPath: string ; public readonly name : string ; public readonly port : number ; public readonly protocol: string ; public readonly tgArn : string ; public readonly thresholdCount: number ; public readonly timeout: number ;