cloudscoutscdkvpcpattern

README

replace this

Documentation

Overview

A CDK pattern to create a VPC with public and private subnets

Index

• func NewVpcPattern_Override(v VpcPattern, scope constructs.Construct, id *string, props *VpcProps)
• func VpcPattern_IsConstruct(x interface{}) *bool
• type VpcPattern
  • func NewVpcPattern(scope constructs.Construct, id *string, props *VpcProps) VpcPattern
• type VpcProps

Functions

func NewVpcPattern_Override

func NewVpcPattern_Override(v VpcPattern, scope constructs.Construct, id *string, props *VpcProps)

func VpcPattern_IsConstruct

func VpcPattern_IsConstruct(x interface{}) *bool

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.

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

Types

type VpcPattern

type VpcPattern interface {
	constructs.Construct
	DatabaseSubnets() *[]awsec2.ISubnet
	SetDatabaseSubnets(val *[]awsec2.ISubnet)
	// The tree node.
	Node() constructs.Node
	PrivateSubnets() *[]awsec2.ISubnet
	SetPrivateSubnets(val *[]awsec2.ISubnet)
	PublicSubnets() *[]awsec2.ISubnet
	SetPublicSubnets(val *[]awsec2.ISubnet)
	VpcId() awsec2.IVpc
	SetVpcId(val awsec2.IVpc)
	// Returns a string representation of this construct.
	ToString() *string
}

func NewVpcPattern

func NewVpcPattern(scope constructs.Construct, id *string, props *VpcProps) VpcPattern

type VpcProps

type VpcProps struct {
	Azs                   *[]*string `field:"required" json:"azs" yaml:"azs"`
	Cidr                  *string    `field:"required" json:"cidr" yaml:"cidr"`
	Name                  *string    `field:"required" json:"name" yaml:"name"`
	PrivateSubnets        *[]*string `field:"required" json:"privateSubnets" yaml:"privateSubnets"`
	PublicSubnets         *[]*string `field:"required" json:"publicSubnets" yaml:"publicSubnets"`
	DatabaseSubnets       *[]*string `field:"optional" json:"databaseSubnets" yaml:"databaseSubnets"`
	EnableKubernenetes    *bool      `field:"optional" json:"enableKubernenetes" yaml:"enableKubernenetes"`
	KubernetesClusterName *string    `field:"optional" json:"kubernetesClusterName" yaml:"kubernetesClusterName"`
}