Skip to content

Latest commit

 

History

History
2315 lines (1438 loc) · 86.7 KB

API.md

File metadata and controls

2315 lines (1438 loc) · 86.7 KB

API Reference

Constructs

Network

Initializers 

import { Network } from '@smallcase/cdk-vpc-module'

new Network(scope: Construct, id: string, props: VPCProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props VPCProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
createSubnet No description.
toString 
public toString(): string

Returns a string representation of this construct.

createSubnet 
public createSubnet(option: ISubnetsProps, vpc: Vpc, peeringConnectionId?: PeeringConnectionInternalType, useGlobalNestedStacks?: boolean): Subnet[]
optionRequired
vpcRequired
  • Type: aws-cdk-lib.aws_ec2.Vpc
peeringConnectionIdOptional
useGlobalNestedStacksOptional
  • Type: boolean

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Network } from '@smallcase/cdk-vpc-module'

Network.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
endpointOutputs {[ key: string ]: aws-cdk-lib.aws_ec2.GatewayVpcEndpoint | aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint} No description.
natProvider aws-cdk-lib.aws_ec2.NatProvider No description.
securityGroupOutputs {[ key: string ]: aws-cdk-lib.aws_ec2.SecurityGroup} No description.
vpc aws-cdk-lib.aws_ec2.Vpc No description.
natSubnets aws-cdk-lib.aws_ec2.PublicSubnet[] No description.
pbSubnets aws-cdk-lib.aws_ec2.PublicSubnet[] No description.
pvSubnets aws-cdk-lib.aws_ec2.PrivateSubnet[] No description.
subnets {[ key: string ]: aws-cdk-lib.aws_ec2.Subnet[]} No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

endpointOutputsRequired 
public readonly endpointOutputs: {[ key: string ]: GatewayVpcEndpoint | InterfaceVpcEndpoint};
  • Type: {[ key: string ]: aws-cdk-lib.aws_ec2.GatewayVpcEndpoint | aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint}
natProviderRequired 
public readonly natProvider: NatProvider;
  • Type: aws-cdk-lib.aws_ec2.NatProvider
securityGroupOutputsRequired 
public readonly securityGroupOutputs: {[ key: string ]: SecurityGroup};
  • Type: {[ key: string ]: aws-cdk-lib.aws_ec2.SecurityGroup}
vpcRequired 
public readonly vpc: Vpc;
  • Type: aws-cdk-lib.aws_ec2.Vpc
natSubnetsRequired 
public readonly natSubnets: PublicSubnet[];
  • Type: aws-cdk-lib.aws_ec2.PublicSubnet[]
pbSubnetsRequired 
public readonly pbSubnets: PublicSubnet[];
  • Type: aws-cdk-lib.aws_ec2.PublicSubnet[]
pvSubnetsRequired 
public readonly pvSubnets: PrivateSubnet[];
  • Type: aws-cdk-lib.aws_ec2.PrivateSubnet[]
subnetsRequired 
public readonly subnets: {[ key: string ]: Subnet[]};
  • Type: {[ key: string ]: aws-cdk-lib.aws_ec2.Subnet[]}

VpcEndpointServiceNestedStack

Initializers 

import { VpcEndpointServiceNestedStack } from '@smallcase/cdk-vpc-module'

new VpcEndpointServiceNestedStack(scope: Construct, id: string, props: VpcEndpointServiceNestedStackProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props VpcEndpointServiceNestedStackProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
addDependency Add a dependency between this stack and another stack.
addMetadata Adds an arbitrary key-value pair, with information you want to record about the stack.
addStackTag Configure a stack tag.
addTransform Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.
exportStringListValue Create a CloudFormation Export for a string list value.
exportValue Create a CloudFormation Export for a string value.
formatArn Creates an ARN from components.
getLogicalId Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
regionalFact Look up a fact value for the given fact for the region of this stack.
removeStackTag Remove a stack tag.
renameLogicalId Rename a generated logical identities.
reportMissingContextKey Indicate that a context key was expected.
resolve Resolve a tokenized value in the context of the current stack.
splitArn Splits the provided ARN into its components.
toJsonString Convert an object, potentially containing tokens, to a JSON string.
toYamlString Convert an object, potentially containing tokens, to a YAML string.
setParameter Assign a value to one of the nested stack parameters.
toString 
public toString(): string

Returns a string representation of this construct.

addDependency 
public addDependency(target: Stack, reason?: string): void

Add a dependency between this stack and another stack.

This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

targetRequired
  • Type: aws-cdk-lib.Stack
reasonOptional
  • Type: string
addMetadata 
public addMetadata(key: string, value: any): void

Adds an arbitrary key-value pair, with information you want to record about the stack.

These get translated to the Metadata section of the generated template.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

keyRequired
  • Type: string
valueRequired
  • Type: any
addStackTag 
public addStackTag(tagName: string, tagValue: string): void

Configure a stack tag.

At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

tagNameRequired
  • Type: string
tagValueRequired
  • Type: string
addTransform 
public addTransform(transform: string): void

Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

Duplicate values are removed when stack is synthesized.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

Example

declare const stack: Stack;

stack.addTransform('AWS::Serverless-2016-10-31')
transformRequired
  • Type: string

The transform to add.

exportStringListValue 
public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[]

Create a CloudFormation Export for a string list value.

Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

See exportValue for an example of this process.

exportedValueRequired
  • Type: any
optionsOptional
  • Type: aws-cdk-lib.ExportValueOptions
exportValue 
public exportValue(exportedValue: any, options?: ExportValueOptions): string

Create a CloudFormation Export for a string value.

Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

Instead, the process takes two deployments:

Deployment 1: break the relationship:

  • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
  • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This will make sure the CloudFormation Export continues to exist while the relationship between the two stacks is being broken.
  • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).

Deployment 2: remove the bucket resource:

  • You are now free to remove the bucket resource from producerStack.
  • Don't forget to remove the exportValue() call as well.
  • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
exportedValueRequired
  • Type: any
optionsOptional
  • Type: aws-cdk-lib.ExportValueOptions
formatArn 
public formatArn(components: ArnComponents): string

Creates an ARN from components.

If partition, region or account are not specified, the stack's partition, region and account will be used.

If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

The ARN will be formatted as follows:

arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

componentsRequired
  • Type: aws-cdk-lib.ArnComponents
getLogicalId 
public getLogicalId(element: CfnElement): string

Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at this stage.

This method uses the protected method allocateLogicalId to render the logical ID for an element. To modify the naming scheme, extend the Stack class and override this method.

elementRequired
  • Type: aws-cdk-lib.CfnElement

The CloudFormation element for which a logical identity is needed.

regionalFact 
public regionalFact(factName: string, defaultValue?: string): string

Look up a fact value for the given fact for the region of this stack.

Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

What regions will be included in the lookup map is controlled by the @aws-cdk/core:target-partitions context value: it must be set to a list of partitions, and only regions from the given partitions will be included. If no such context key is set, all regions will be included.

This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts.

If defaultValue is not given, it is an error if the fact is unknown for the given region.

factNameRequired
  • Type: string
defaultValueOptional
  • Type: string
removeStackTag 
public removeStackTag(tagName: string): void

Remove a stack tag.

At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

tagNameRequired
  • Type: string
renameLogicalId 
public renameLogicalId(oldId: string, newId: string): void

Rename a generated logical identities.

To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

oldIdRequired
  • Type: string
newIdRequired
  • Type: string
reportMissingContextKey 
public reportMissingContextKey(report: MissingContext): void

Indicate that a context key was expected.

Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

reportRequired
  • Type: aws-cdk-lib.cloud_assembly_schema.MissingContext

The set of parameters needed to obtain the context.

resolve 
public resolve(obj: any): any

Resolve a tokenized value in the context of the current stack.

objRequired
  • Type: any
splitArn 
public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

Splits the provided ARN into its components.

Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

arnRequired
  • Type: string

the ARN to split into its components.

arnFormatRequired
  • Type: aws-cdk-lib.ArnFormat

the expected format of 'arn' - depends on what format the service 'arn' represents uses.

toJsonString 
public toJsonString(obj: any, space?: number): string

Convert an object, potentially containing tokens, to a JSON string.

objRequired
  • Type: any
spaceOptional
  • Type: number
toYamlString 
public toYamlString(obj: any): string

Convert an object, potentially containing tokens, to a YAML string.

objRequired
  • Type: any
setParameter 
public setParameter(name: string, value: string): void

Assign a value to one of the nested stack parameters.

nameRequired
  • Type: string

The parameter name (ID).

valueRequired
  • Type: string

The value to assign.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isStack Return whether the given object is a Stack.
of Looks up the first stack scope in which construct is defined.
isNestedStack Checks if x is an object of type NestedStack.
isConstruct 
import { VpcEndpointServiceNestedStack } from '@smallcase/cdk-vpc-module'

VpcEndpointServiceNestedStack.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

isStack 
import { VpcEndpointServiceNestedStack } from '@smallcase/cdk-vpc-module'

VpcEndpointServiceNestedStack.isStack(x: any)

Return whether the given object is a Stack.

We do attribute detection since we can't reliably use 'instanceof'.

xRequired
  • Type: any
of 
import { VpcEndpointServiceNestedStack } from '@smallcase/cdk-vpc-module'

VpcEndpointServiceNestedStack.of(construct: IConstruct)

Looks up the first stack scope in which construct is defined.

Fails if there is no stack up the tree.

constructRequired
  • Type: constructs.IConstruct

The construct to start the search from.

isNestedStack 
import { VpcEndpointServiceNestedStack } from '@smallcase/cdk-vpc-module'

VpcEndpointServiceNestedStack.isNestedStack(x: any)

Checks if x is an object of type NestedStack.

xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
account string The AWS account into which this stack will be deployed.
artifactId string The ID of the cloud assembly artifact for this stack.
availabilityZones string[] Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
bundlingRequired boolean Indicates whether the stack requires bundling or not.
dependencies aws-cdk-lib.Stack[] Return the stacks this stack depends on.
environment string The environment coordinates in which this stack is deployed.
nested boolean Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.
notificationArns string[] Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
partition string The partition in which this stack is defined.
region string The AWS region into which this stack will be deployed (e.g. us-west-2).
stackId string An attribute that represents the ID of the stack.
stackName string An attribute that represents the name of the nested stack.
synthesizer aws-cdk-lib.IStackSynthesizer Synthesis method for this stack.
tags aws-cdk-lib.TagManager Tags to be applied to the stack.
templateFile string The name of the CloudFormation template file emitted to the output directory during synthesis.
templateOptions aws-cdk-lib.ITemplateOptions Options for CloudFormation template (like version, transform, description).
urlSuffix string The Amazon domain suffix for the region in which this stack is defined.
nestedStackParent aws-cdk-lib.Stack If this is a nested stack, returns it's parent stack.
nestedStackResource aws-cdk-lib.CfnResource If this is a nested stack, this represents its AWS::CloudFormation::Stack resource.
terminationProtection boolean Whether termination protection is enabled for this stack.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

accountRequired 
public readonly account: string;
  • Type: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

  1. The value provided to env.account when the stack is defined. This can either be a concrete account (e.g. 585695031111) or the Aws.ACCOUNT_ID token.
  2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference { "Ref": "AWS::AccountId" } encoded as a string token.

Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

artifactIdRequired 
public readonly artifactId: string;
  • Type: string

The ID of the cloud assembly artifact for this stack.

availabilityZonesRequired 
public readonly availabilityZones: string[];
  • Type: string[]

Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

To specify a different strategy for selecting availability zones override this method.

bundlingRequiredRequired 
public readonly bundlingRequired: boolean;
  • Type: boolean

Indicates whether the stack requires bundling or not.

dependenciesRequired 
public readonly dependencies: Stack[];
  • Type: aws-cdk-lib.Stack[]

Return the stacks this stack depends on.

environmentRequired 
public readonly environment: string;
  • Type: string

The environment coordinates in which this stack is deployed.

In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

You can use this value to determine if two stacks are targeting the same environment.

If either stack.account or stack.region are not concrete values (e.g. Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

nestedRequired 
public readonly nested: boolean;
  • Type: boolean

Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

notificationArnsRequired 
public readonly notificationArns: string[];
  • Type: string[]

Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

partitionRequired 
public readonly partition: string;
  • Type: string

The partition in which this stack is defined.

regionRequired 
public readonly region: string;
  • Type: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

  1. The value provided to env.region when the stack is defined. This can either be a concrete region (e.g. us-west-2) or the Aws.REGION token.
  2. Aws.REGION, which is represents the CloudFormation intrinsic reference { "Ref": "AWS::Region" } encoded as a string token.

Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.region) returns true), this implies that the user wishes that this stack will synthesize into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

stackIdRequired 
public readonly stackId: string;
  • Type: string

An attribute that represents the ID of the stack.

This is a context aware attribute:

  • If this is referenced from the parent stack, it will return { "Ref": "LogicalIdOfNestedStackResource" }.
  • If this is referenced from the context of the nested stack, it will return { "Ref": "AWS::StackId" }

Example value: arn:aws:cloudformation:us-east-2:123456789012:stack/mystack-mynestedstack-sggfrhxhum7w/f449b250-b969-11e0-a185-5081d0136786

stackNameRequired 
public readonly stackName: string;
  • Type: string

An attribute that represents the name of the nested stack.

This is a context aware attribute:

  • If this is referenced from the parent stack, it will return a token that parses the name from the stack ID.
  • If this is referenced from the context of the nested stack, it will return { "Ref": "AWS::StackName" }

Example value: mystack-mynestedstack-sggfrhxhum7w

synthesizerRequired 
public readonly synthesizer: IStackSynthesizer;
  • Type: aws-cdk-lib.IStackSynthesizer

Synthesis method for this stack.

tagsRequired 
public readonly tags: TagManager;
  • Type: aws-cdk-lib.TagManager

Tags to be applied to the stack.

templateFileRequired 
public readonly templateFile: string;
  • Type: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

templateOptionsRequired 
public readonly templateOptions: ITemplateOptions;
  • Type: aws-cdk-lib.ITemplateOptions

Options for CloudFormation template (like version, transform, description).

urlSuffixRequired 
public readonly urlSuffix: string;
  • Type: string

The Amazon domain suffix for the region in which this stack is defined.

nestedStackParentOptional 
public readonly nestedStackParent: Stack;
  • Type: aws-cdk-lib.Stack

If this is a nested stack, returns it's parent stack.

nestedStackResourceOptional 
public readonly nestedStackResource: CfnResource;
  • Type: aws-cdk-lib.CfnResource

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource.

undefined for top-level (non-nested) stacks.

terminationProtectionRequired 
public readonly terminationProtection: boolean;
  • Type: boolean

Whether termination protection is enabled for this stack.

Structs

AddRouteOptions

Initializer 

import { AddRouteOptions } from '@smallcase/cdk-vpc-module'

const addRouteOptions: AddRouteOptions = { ... }

Properties

Name Type Description
routerType aws-cdk-lib.aws_ec2.RouterType What type of router to route this traffic to.
destinationCidrBlock string IPv4 range this route applies to.
destinationIpv6CidrBlock string IPv6 range this route applies to.
enablesInternetConnectivity boolean Whether this route will enable internet connectivity.
existingVpcPeeringRouteKey string No description.
routeName string No description.
routerId string No description.
routerTypeRequired 
public readonly routerType: RouterType;
  • Type: aws-cdk-lib.aws_ec2.RouterType

What type of router to route this traffic to.

destinationCidrBlockOptional 
public readonly destinationCidrBlock: string;
  • Type: string
  • Default: '0.0.0.0/0'

IPv4 range this route applies to.

destinationIpv6CidrBlockOptional 
public readonly destinationIpv6CidrBlock: string;
  • Type: string
  • Default: Uses IPv6

IPv6 range this route applies to.

enablesInternetConnectivityOptional 
public readonly enablesInternetConnectivity: boolean;
  • Type: boolean
  • Default: false

Whether this route will enable internet connectivity.

If true, this route will be added before any AWS resources that depend on internet connectivity in the VPC will be created.

existingVpcPeeringRouteKeyOptional 
public readonly existingVpcPeeringRouteKey: string;
  • Type: string
routeNameOptional 
public readonly routeName: string;
  • Type: string
routerIdOptional 
public readonly routerId: string;
  • Type: string

LoadBalancerConfig

Initializer 

import { LoadBalancerConfig } from '@smallcase/cdk-vpc-module'

const loadBalancerConfig: LoadBalancerConfig = { ... }

Properties

Name Type Description
certificates string[] No description.
existingArn string No description.
existingSecurityGroupId string No description.
internetFacing boolean No description.
securityGroupRules SecurityGroupRule[] No description.
subnetGroupName string No description.
targetGroups TargetGroupConfig[] No description.
certificatesOptional 
public readonly certificates: string[];
  • Type: string[]
existingArnOptional 
public readonly existingArn: string;
  • Type: string
existingSecurityGroupIdOptional 
public readonly existingSecurityGroupId: string;
  • Type: string
internetFacingOptional 
public readonly internetFacing: boolean;
  • Type: boolean
securityGroupRulesOptional 
public readonly securityGroupRules: SecurityGroupRule[];
subnetGroupNameOptional 
public readonly subnetGroupName: string;
  • Type: string
targetGroupsOptional 
public readonly targetGroups: TargetGroupConfig[];

NetworkACL

Initializer 

import { NetworkACL } from '@smallcase/cdk-vpc-module'

const networkACL: NetworkACL = { ... }

Properties

Name Type Description
cidr aws-cdk-lib.aws_ec2.AclCidr No description.
traffic aws-cdk-lib.aws_ec2.AclTraffic No description.
cidrRequired 
public readonly cidr: AclCidr;
  • Type: aws-cdk-lib.aws_ec2.AclCidr
trafficRequired 
public readonly traffic: AclTraffic;
  • Type: aws-cdk-lib.aws_ec2.AclTraffic

NetworkLoadBalancerConfig

Initializer 

import { NetworkLoadBalancerConfig } from '@smallcase/cdk-vpc-module'

const networkLoadBalancerConfig: NetworkLoadBalancerConfig = { ... }

Properties

Name Type Description
securityGroupRules SecurityGroupRule[] No description.
subnetGroupName string No description.
certificates string[] No description.
existingSecurityGroupId string No description.
internetFacing boolean No description.
securityGroupRulesRequired 
public readonly securityGroupRules: SecurityGroupRule[];
subnetGroupNameRequired 
public readonly subnetGroupName: string;
  • Type: string
certificatesOptional 
public readonly certificates: string[];
  • Type: string[]
existingSecurityGroupIdOptional 
public readonly existingSecurityGroupId: string;
  • Type: string
internetFacingOptional 
public readonly internetFacing: boolean;
  • Type: boolean

PeeringConfig

Initializer 

import { PeeringConfig } from '@smallcase/cdk-vpc-module'

const peeringConfig: PeeringConfig = { ... }

Properties

Name Type Description
peeringVpcId string No description.
tags {[ key: string ]: string} No description.
peerAssumeRoleArn string No description.
peerOwnerId string No description.
peerRegion string No description.
peeringVpcIdRequired 
public readonly peeringVpcId: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
peerAssumeRoleArnOptional 
public readonly peerAssumeRoleArn: string;
  • Type: string
peerOwnerIdOptional 
public readonly peerOwnerId: string;
  • Type: string
peerRegionOptional 
public readonly peerRegion: string;
  • Type: string

PeeringConnectionInternalType

Initializer 

import { PeeringConnectionInternalType } from '@smallcase/cdk-vpc-module'

const peeringConnectionInternalType: PeeringConnectionInternalType = { ... }

SecurityGroupRule

Initializer 

import { SecurityGroupRule } from '@smallcase/cdk-vpc-module'

const securityGroupRule: SecurityGroupRule = { ... }

Properties

Name Type Description
peer aws-cdk-lib.aws_ec2.IPeer | aws-cdk-lib.aws_ec2.ISecurityGroup No description.
port aws-cdk-lib.aws_ec2.Port No description.
description string No description.
peerRequired 
public readonly peer: IPeer | ISecurityGroup;
  • Type: aws-cdk-lib.aws_ec2.IPeer | aws-cdk-lib.aws_ec2.ISecurityGroup
portRequired 
public readonly port: Port;
  • Type: aws-cdk-lib.aws_ec2.Port
descriptionOptional 
public readonly description: string;
  • Type: string

TargetGroupConfig

Initializer 

import { TargetGroupConfig } from '@smallcase/cdk-vpc-module'

const targetGroupConfig: TargetGroupConfig = { ... }

Properties

Name Type Description
applicationPort number No description.
host string No description.
healthCheckPath string No description.
healthCheckPort number No description.
healthCheckProtocol aws-cdk-lib.aws_elasticloadbalancingv2.Protocol No description.
priority number No description.
protocol aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol No description.
protocolVersion aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion No description.
applicationPortRequired 
public readonly applicationPort: number;
  • Type: number
hostRequired 
public readonly host: string;
  • Type: string
healthCheckPathOptional 
public readonly healthCheckPath: string;
  • Type: string
healthCheckPortOptional 
public readonly healthCheckPort: number;
  • Type: number
healthCheckProtocolOptional 
public readonly healthCheckProtocol: Protocol;
  • Type: aws-cdk-lib.aws_elasticloadbalancingv2.Protocol
priorityOptional 
public readonly priority: number;
  • Type: number
protocolOptional 
public readonly protocol: ApplicationProtocol;
  • Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol
protocolVersionOptional 
public readonly protocolVersion: ApplicationProtocolVersion;
  • Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion

VpcEndpointConfig

Initializer 

import { VpcEndpointConfig } from '@smallcase/cdk-vpc-module'

const vpcEndpointConfig: VpcEndpointConfig = { ... }

Properties

Name Type Description
name string No description.
service aws-cdk-lib.aws_ec2.InterfaceVpcEndpointAwsService | aws-cdk-lib.aws_ec2.GatewayVpcEndpointAwsService | aws-cdk-lib.aws_ec2.InterfaceVpcEndpointService No description.
subnetGroupNames string[] No description.
additionalTags {[ key: string ]: string} No description.
externalSubnets IExternalVPEndpointSubnets[] No description.
iamPolicyStatements aws-cdk-lib.aws_iam.PolicyStatement[] No description.
securityGroupRules SecurityGroupRule[] No description.
nameRequired 
public readonly name: string;
  • Type: string
serviceRequired 
public readonly service: InterfaceVpcEndpointAwsService | GatewayVpcEndpointAwsService | InterfaceVpcEndpointService;
  • Type: aws-cdk-lib.aws_ec2.InterfaceVpcEndpointAwsService | aws-cdk-lib.aws_ec2.GatewayVpcEndpointAwsService | aws-cdk-lib.aws_ec2.InterfaceVpcEndpointService
subnetGroupNamesRequired 
public readonly subnetGroupNames: string[];
  • Type: string[]
additionalTagsOptional 
public readonly additionalTags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
externalSubnetsOptional 
public readonly externalSubnets: IExternalVPEndpointSubnets[];
iamPolicyStatementsOptional 
public readonly iamPolicyStatements: PolicyStatement[];
  • Type: aws-cdk-lib.aws_iam.PolicyStatement[]
securityGroupRulesOptional 
public readonly securityGroupRules: SecurityGroupRule[];

VpcEndpointServiceNestedStackProps

Initializer 

import { VpcEndpointServiceNestedStackProps } from '@smallcase/cdk-vpc-module'

const vpcEndpointServiceNestedStackProps: VpcEndpointServiceNestedStackProps = { ... }

Properties

Name Type Description
description string A description of the stack.
notificationArns string[] The Simple Notification Service (SNS) topics to publish stack related events.
parameters {[ key: string ]: string} The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
removalPolicy aws-cdk-lib.RemovalPolicy Policy to apply when the nested stack is removed.
timeout aws-cdk-lib.Duration The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.
subnets {[ key: string ]: aws-cdk-lib.aws_ec2.Subnet[]} No description.
vpc aws-cdk-lib.aws_ec2.Vpc No description.
vpcEndpointServiceConfigs VpcEndpontServiceConfig[] No description.
descriptionOptional 
public readonly description: string;
  • Type: string
  • Default: No description.

A description of the stack.

notificationArnsOptional 
public readonly notificationArns: string[];
  • Type: string[]
  • Default: notifications are not sent for this stack.

The Simple Notification Service (SNS) topics to publish stack related events.

parametersOptional 
public readonly parameters: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: no user-defined parameters are passed to the nested stack

The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.

Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.

The nested stack construct will automatically synthesize parameters in order to bind references from the parent stack(s) into the nested stack.

removalPolicyOptional 
public readonly removalPolicy: RemovalPolicy;
  • Type: aws-cdk-lib.RemovalPolicy
  • Default: RemovalPolicy.DESTROY

Policy to apply when the nested stack is removed.

The default is Destroy, because all Removal Policies of resources inside the Nested Stack should already have been set correctly. You normally should not need to set this value.

timeoutOptional 
public readonly timeout: Duration;
  • Type: aws-cdk-lib.Duration
  • Default: no timeout

The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE state, it marks the nested stack resource as CREATE_COMPLETE in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.

subnetsRequired 
public readonly subnets: {[ key: string ]: Subnet[]};
  • Type: {[ key: string ]: aws-cdk-lib.aws_ec2.Subnet[]}
vpcRequired 
public readonly vpc: Vpc;
  • Type: aws-cdk-lib.aws_ec2.Vpc
vpcEndpointServiceConfigsRequired 
public readonly vpcEndpointServiceConfigs: VpcEndpontServiceConfig[];

VpcEndpontServiceConfig

Initializer 

import { VpcEndpontServiceConfig } from '@smallcase/cdk-vpc-module'

const vpcEndpontServiceConfig: VpcEndpontServiceConfig = { ... }

Properties

Name Type Description
alb LoadBalancerConfig No description.
name string No description.
nlb NetworkLoadBalancerConfig No description.
acceptanceRequired boolean No description.
additionalTags {[ key: string ]: string} No description.
allowedPrincipals string[] No description.
albRequired 
public readonly alb: LoadBalancerConfig;
nameRequired 
public readonly name: string;
  • Type: string
nlbRequired 
public readonly nlb: NetworkLoadBalancerConfig;
acceptanceRequiredOptional 
public readonly acceptanceRequired: boolean;
  • Type: boolean
additionalTagsOptional 
public readonly additionalTags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
allowedPrincipalsOptional 
public readonly allowedPrincipals: string[];
  • Type: string[]

VPCProps

Initializer 

import { VPCProps } from '@smallcase/cdk-vpc-module'

const vPCProps: VPCProps = { ... }

Properties

Name Type Description
subnets ISubnetsProps[] No description.
vpc aws-cdk-lib.aws_ec2.VpcProps No description.
natEipAllocationIds string[] No description.
peeringConfigs {[ key: string ]: PeeringConfig} No description.
useNestedStacks boolean No description.
vpcEndpoints VpcEndpointConfig[] No description.
vpcEndpointServices VpcEndpontServiceConfig[] No description.
subnetsRequired 
public readonly subnets: ISubnetsProps[];
vpcRequired 
public readonly vpc: VpcProps;
  • Type: aws-cdk-lib.aws_ec2.VpcProps
natEipAllocationIdsOptional 
public readonly natEipAllocationIds: string[];
  • Type: string[]
peeringConfigsOptional 
public readonly peeringConfigs: {[ key: string ]: PeeringConfig};
useNestedStacksOptional 
public readonly useNestedStacks: boolean;
  • Type: boolean
vpcEndpointsOptional 
public readonly vpcEndpoints: VpcEndpointConfig[];
vpcEndpointServicesOptional 
public readonly vpcEndpointServices: VpcEndpontServiceConfig[];

Protocols

IExternalVPEndpointSubnets

Properties

Name Type Description
availabilityZone string No description.
id string No description.
routeTableId string No description.
availabilityZoneRequired 
public readonly availabilityZone: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
routeTableIdRequired 
public readonly routeTableId: string;
  • Type: string

ISubnetsProps

Properties

Name Type Description
availabilityZones string[] No description.
cidrBlock string[] No description.
subnetGroupName string No description.
subnetType aws-cdk-lib.aws_ec2.SubnetType No description.
egressNetworkACL NetworkACL[] No description.
ingressNetworkACL NetworkACL[] No description.
routes AddRouteOptions[] No description.
routeTableStringFormat boolean No description.
tags {[ key: string ]: string} No description.
useNestedStacks boolean No description.
useSubnetForNAT boolean No description.
availabilityZonesRequired 
public readonly availabilityZones: string[];
  • Type: string[]
cidrBlockRequired 
public readonly cidrBlock: string[];
  • Type: string[]
subnetGroupNameRequired 
public readonly subnetGroupName: string;
  • Type: string
subnetTypeRequired 
public readonly subnetType: SubnetType;
  • Type: aws-cdk-lib.aws_ec2.SubnetType
egressNetworkACLOptional 
public readonly egressNetworkACL: NetworkACL[];
ingressNetworkACLOptional 
public readonly ingressNetworkACL: NetworkACL[];
routesOptional 
public readonly routes: AddRouteOptions[];
routeTableStringFormatOptional 
public readonly routeTableStringFormat: boolean;
  • Type: boolean
tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
useNestedStacksOptional 
public readonly useNestedStacks: boolean;
  • Type: boolean
useSubnetForNATOptional 
public readonly useSubnetForNAT: boolean;
  • Type: boolean