terraform_aws_vpc

Documentation

Overview

terraform_aws_vpc

Index

• func NewTerraformAwsVpc_Override(t TerraformAwsVpc, scope constructs.Construct, id *string, ...)
• func TerraformAwsVpc_IsConstruct(x interface{}) *bool
• func TerraformAwsVpc_IsTerraformElement(x interface{}) *bool
• type TerraformAwsVpc
  • func NewTerraformAwsVpc(scope constructs.Construct, id *string, config *TerraformAwsVpcConfig) TerraformAwsVpc
• type TerraformAwsVpcConfig

Functions

func NewTerraformAwsVpc_Override

func NewTerraformAwsVpc_Override(t TerraformAwsVpc, scope constructs.Construct, id *string, config *TerraformAwsVpcConfig)

func TerraformAwsVpc_IsConstruct

func TerraformAwsVpc_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`.

func TerraformAwsVpc_IsTerraformElement

func TerraformAwsVpc_IsTerraformElement(x interface{}) *bool

Experimental.

Types

type TerraformAwsVpc

type TerraformAwsVpc interface {
	cdktf.TerraformModule
	AdditionalCidrBlocksOutput() *string
	AdditionalCidrBlocksToAssociationIdsOutput() *string
	AdditionalIpv6CidrBlocksOutput() *string
	AdditionalIpv6CidrBlocksToAssociationIdsOutput() *string
	AdditionalTagMap() *map[string]*string
	SetAdditionalTagMap(val *map[string]*string)
	AssignGeneratedIpv6CidrBlock() *bool
	SetAssignGeneratedIpv6CidrBlock(val *bool)
	Attributes() *[]*string
	SetAttributes(val *[]*string)
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	Context() interface{}
	SetContext(val interface{})
	DefaultNetworkAclDenyAll() *bool
	SetDefaultNetworkAclDenyAll(val *bool)
	DefaultRouteTableNoRoutes() *bool
	SetDefaultRouteTableNoRoutes(val *bool)
	DefaultSecurityGroupDenyAll() *bool
	SetDefaultSecurityGroupDenyAll(val *bool)
	Delimiter() *string
	SetDelimiter(val *string)
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	DescriptorFormats() interface{}
	SetDescriptorFormats(val interface{})
	DnsHostnamesEnabled() *bool
	SetDnsHostnamesEnabled(val *bool)
	DnsSupportEnabled() *bool
	SetDnsSupportEnabled(val *bool)
	Enabled() *bool
	SetEnabled(val *bool)
	Environment() *string
	SetEnvironment(val *string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	IdLengthLimit() *float64
	SetIdLengthLimit(val *float64)
	IgwIdOutput() *string
	InstanceTenancy() *string
	SetInstanceTenancy(val *string)
	InternetGatewayEnabled() *bool
	SetInternetGatewayEnabled(val *bool)
	Ipv4AdditionalCidrBlockAssociations() interface{}
	SetIpv4AdditionalCidrBlockAssociations(val interface{})
	Ipv4CidrBlockAssociationTimeouts() interface{}
	SetIpv4CidrBlockAssociationTimeouts(val interface{})
	Ipv4PrimaryCidrBlock() *string
	SetIpv4PrimaryCidrBlock(val *string)
	Ipv4PrimaryCidrBlockAssociation() interface{}
	SetIpv4PrimaryCidrBlockAssociation(val interface{})
	Ipv6AdditionalCidrBlockAssociations() interface{}
	SetIpv6AdditionalCidrBlockAssociations(val interface{})
	Ipv6CidrBlockAssociationTimeouts() interface{}
	SetIpv6CidrBlockAssociationTimeouts(val interface{})
	Ipv6CidrBlockNetworkBorderGroup() *string
	SetIpv6CidrBlockNetworkBorderGroup(val *string)
	Ipv6CidrBlockNetworkBorderGroupOutput() *string
	Ipv6EgressOnlyIgwIdOutput() *string
	Ipv6EgressOnlyInternetGatewayEnabled() *bool
	SetIpv6EgressOnlyInternetGatewayEnabled(val *bool)
	Ipv6PrimaryCidrBlockAssociation() interface{}
	SetIpv6PrimaryCidrBlockAssociation(val interface{})
	LabelKeyCase() *string
	SetLabelKeyCase(val *string)
	LabelOrder() *[]*string
	SetLabelOrder(val *[]*string)
	LabelsAsTags() *[]*string
	SetLabelsAsTags(val *[]*string)
	LabelValueCase() *string
	SetLabelValueCase(val *string)
	Name() *string
	SetName(val *string)
	Namespace() *string
	SetNamespace(val *string)
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Providers() *[]interface{}
	// Experimental.
	RawOverrides() interface{}
	RegexReplaceChars() *string
	SetRegexReplaceChars(val *string)
	// Experimental.
	SkipAssetCreationFromLocalModules() *bool
	// Experimental.
	Source() *string
	Stage() *string
	SetStage(val *string)
	Tags() *map[string]*string
	SetTags(val *map[string]*string)
	Tenant() *string
	SetTenant(val *string)
	// Experimental.
	Version() *string
	VpcArnOutput() *string
	VpcCidrBlockOutput() *string
	VpcDefaultNetworkAclIdOutput() *string
	VpcDefaultRouteTableIdOutput() *string
	VpcDefaultSecurityGroupIdOutput() *string
	VpcIdOutput() *string
	VpcIpv6AssociationIdOutput() *string
	VpcIpv6CidrBlockOutput() *string
	VpcMainRouteTableIdOutput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	AddProvider(provider interface{})
	// Experimental.
	GetString(output *string) *string
	// Experimental.
	InterpolationForOutput(moduleOutput *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Experimental.
	ToTerraform() interface{}
}

Defines an TerraformAwsVpc based on a Terraform module.

Source at ./mod/terraform-aws-vpc

func NewTerraformAwsVpc

func NewTerraformAwsVpc(scope constructs.Construct, id *string, config *TerraformAwsVpcConfig) TerraformAwsVpc

type TerraformAwsVpcConfig

type TerraformAwsVpcConfig struct {
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Providers *[]interface{} `field:"optional" json:"providers" yaml:"providers"`
	// Experimental.
	SkipAssetCreationFromLocalModules *bool `field:"optional" json:"skipAssetCreationFromLocalModules" yaml:"skipAssetCreationFromLocalModules"`
	// Additional key-value pairs to add to each map in `tags_as_list_of_maps`.
	//
	// Not added to `tags` or `id`.
	// This is for some rare cases where resources want additional configuration of tags
	// and therefore take a list of maps with tag key, value, and additional configuration.
	//
	// The property type contains a map, they have special handling, please see {@link cdk.tf /module-map-inputs the docs}
	AdditionalTagMap *map[string]*string `field:"optional" json:"additionalTagMap" yaml:"additionalTagMap"`
	// When `true`, assign AWS generated IPv6 CIDR block to the VPC.
	//
	// Conflicts with `ipv6_ipam_pool_id`.
	// true.
	AssignGeneratedIpv6CidrBlock *bool `field:"optional" json:"assignGeneratedIpv6CidrBlock" yaml:"assignGeneratedIpv6CidrBlock"`
	// ID element.
	//
	// Additional attributes (e.g. `workers` or `cluster`) to add to `id`,
	// in the order they appear in the list. New attributes are appended to the
	// end of the list. The elements of the list are joined by the `delimiter`
	// and treated as a single ID element.
	Attributes *[]*string `field:"optional" json:"attributes" yaml:"attributes"`
	// Single object for setting entire context at once.
	//
	// See description of individual variables for details.
	// Leave string and numeric variables as `null` to use default value.
	// Individual variable settings (non-null) override settings in context object,
	// except for attributes, tags, and additional_tag_map, which are merged.
	Context interface{} `field:"optional" json:"context" yaml:"context"`
	// When `true`, manage the default network acl and remove all rules, disabling all ingress and egress.
	//
	// When `false`, do not mange the default networking acl, allowing it to be managed by another component.
	DefaultNetworkAclDenyAll *bool `field:"optional" json:"defaultNetworkAclDenyAll" yaml:"defaultNetworkAclDenyAll"`
	// When `true`, manage the default route table and remove all routes, disabling all ingress and egress.
	//
	// When `false`, do not mange the default route table, allowing it to be managed by another component.
	// Conflicts with Terraform resource `aws_main_route_table_association`.
	DefaultRouteTableNoRoutes *bool `field:"optional" json:"defaultRouteTableNoRoutes" yaml:"defaultRouteTableNoRoutes"`
	// When `true`, manage the default security group and remove all rules, disabling all ingress and egress.
	//
	// When `false`, do not manage the default security group, allowing it to be managed by another component.
	//
	// true.
	DefaultSecurityGroupDenyAll *bool `field:"optional" json:"defaultSecurityGroupDenyAll" yaml:"defaultSecurityGroupDenyAll"`
	// Delimiter to be used between ID elements.
	//
	// Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.
	Delimiter *string `field:"optional" json:"delimiter" yaml:"delimiter"`
	// Describe additional descriptors to be output in the `descriptors` output map.
	//
	// Map of maps. Keys are names of descriptors. Values are maps of the form
	// `{
	//    format = string
	//    labels = list(string)
	// }`
	// (Type is `any` so the map values can later be enhanced to provide additional options.)
	// `format` is a Terraform format string to be passed to the `format()` function.
	// `labels` is a list of labels, in order, to pass to `format()` function.
	// Label values will be normalized before being passed to `format()` so they will be
	// identical to how they appear in `id`.
	// Default is `{}` (`descriptors` output will be empty).
	DescriptorFormats interface{} `field:"optional" json:"descriptorFormats" yaml:"descriptorFormats"`
	// Set `true` to enable [DNS hostnames](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-hostnames) in the VPC true.
	DnsHostnamesEnabled *bool `field:"optional" json:"dnsHostnamesEnabled" yaml:"dnsHostnamesEnabled"`
	// Set `true` to enable DNS resolution in the VPC through the Amazon provided DNS server true.
	DnsSupportEnabled *bool `field:"optional" json:"dnsSupportEnabled" yaml:"dnsSupportEnabled"`
	// Set to false to prevent the module from creating any resources.
	Enabled *bool `field:"optional" json:"enabled" yaml:"enabled"`
	// ID element.
	//
	// Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
	Environment *string `field:"optional" json:"environment" yaml:"environment"`
	// Limit `id` to this many characters (minimum 6).
	//
	// Set to `0` for unlimited length.
	// Set to `null` for keep the existing setting, which defaults to `0`.
	// Does not affect `id_full`.
	IdLengthLimit *float64 `field:"optional" json:"idLengthLimit" yaml:"idLengthLimit"`
	// A tenancy option for instances launched into the VPC default.
	InstanceTenancy *string `field:"optional" json:"instanceTenancy" yaml:"instanceTenancy"`
	// Set `true` to create an Internet Gateway for the VPC true.
	InternetGatewayEnabled *bool `field:"optional" json:"internetGatewayEnabled" yaml:"internetGatewayEnabled"`
	// IPv4 CIDR blocks to assign to the VPC.
	//
	// `ipv4_cidr_block` can be set explicitly, or set to `null` with the CIDR block derived from `ipv4_ipam_pool_id` using `ipv4_netmask_length`.
	// Map keys must be known at `plan` time, and are only used to track changes.
	Ipv4AdditionalCidrBlockAssociations interface{} `field:"optional" json:"ipv4AdditionalCidrBlockAssociations" yaml:"ipv4AdditionalCidrBlockAssociations"`
	// Timeouts (in `go` duration format) for creating and destroying IPv4 CIDR block associations.
	Ipv4CidrBlockAssociationTimeouts interface{} `field:"optional" json:"ipv4CidrBlockAssociationTimeouts" yaml:"ipv4CidrBlockAssociationTimeouts"`
	// The primary IPv4 CIDR block for the VPC.
	//
	// Either `ipv4_primary_cidr_block` or `ipv4_primary_cidr_block_association` must be set, but not both.
	Ipv4PrimaryCidrBlock *string `field:"optional" json:"ipv4PrimaryCidrBlock" yaml:"ipv4PrimaryCidrBlock"`
	// Configuration of the VPC's primary IPv4 CIDR block via IPAM.
	//
	// Conflicts with `ipv4_primary_cidr_block`.
	// One of `ipv4_primary_cidr_block` or `ipv4_primary_cidr_block_association` must be set.
	// Additional CIDR blocks can be set via `ipv4_additional_cidr_block_associations`.
	Ipv4PrimaryCidrBlockAssociation interface{} `field:"optional" json:"ipv4PrimaryCidrBlockAssociation" yaml:"ipv4PrimaryCidrBlockAssociation"`
	// IPv6 CIDR blocks to assign to the VPC (in addition to the autogenerated one).
	//
	// `ipv6_cidr_block` can be set explicitly, or set to `null` with the CIDR block derived from `ipv6_ipam_pool_id` using `ipv6_netmask_length`.
	// Map keys must be known at `plan` time and are used solely to prevent unnecessary changes.
	Ipv6AdditionalCidrBlockAssociations interface{} `field:"optional" json:"ipv6AdditionalCidrBlockAssociations" yaml:"ipv6AdditionalCidrBlockAssociations"`
	// Timeouts (in `go` duration format) for creating and destroying IPv6 CIDR block associations.
	Ipv6CidrBlockAssociationTimeouts interface{} `field:"optional" json:"ipv6CidrBlockAssociationTimeouts" yaml:"ipv6CidrBlockAssociationTimeouts"`
	// Set this to restrict advertisement of public addresses to a specific Network Border Group such as a LocalZone.
	//
	// Requires `assign_generated_ipv6_cidr_block` to be set to `true`.
	Ipv6CidrBlockNetworkBorderGroup *string `field:"optional" json:"ipv6CidrBlockNetworkBorderGroup" yaml:"ipv6CidrBlockNetworkBorderGroup"`
	// Set `true` to create an IPv6 Egress-Only Internet Gateway for the VPC.
	Ipv6EgressOnlyInternetGatewayEnabled *bool `field:"optional" json:"ipv6EgressOnlyInternetGatewayEnabled" yaml:"ipv6EgressOnlyInternetGatewayEnabled"`
	// Primary IPv6 CIDR block to assign to the VPC.
	//
	// Conflicts with `assign_generated_ipv6_cidr_block`.
	// `ipv6_cidr_block` can be set explicitly, or set to `null` with the CIDR block derived from `ipv6_ipam_pool_id` using `ipv6_netmask_length`.
	Ipv6PrimaryCidrBlockAssociation interface{} `field:"optional" json:"ipv6PrimaryCidrBlockAssociation" yaml:"ipv6PrimaryCidrBlockAssociation"`
	// Controls the letter case of the `tags` keys (label names) for tags generated by this module.
	//
	// Does not affect keys of tags passed in via the `tags` input.
	// Possible values: `lower`, `title`, `upper`.
	// Default value: `title`.
	LabelKeyCase *string `field:"optional" json:"labelKeyCase" yaml:"labelKeyCase"`
	// The order in which the labels (ID elements) appear in the `id`.
	//
	// Defaults to ["namespace", "environment", "stage", "name", "attributes"].
	// You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
	LabelOrder *[]*string `field:"optional" json:"labelOrder" yaml:"labelOrder"`
	// Set of labels (ID elements) to include as tags in the `tags` output.
	//
	// Default is to include all labels.
	// Tags with empty values will not be included in the `tags` output.
	// Set to `[]` to suppress all generated tags.
	// **Notes:**
	//   The value of the `name` tag, if included, will be the `id`, not the `name`.
	//   Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be
	//   changed in later chained modules. Attempts to change it will be silently ignored.
	//
	// default.
	LabelsAsTags *[]*string `field:"optional" json:"labelsAsTags" yaml:"labelsAsTags"`
	// Controls the letter case of ID elements (labels) as included in `id`, set as tag values, and output by this module individually.
	//
	// Does not affect values of tags passed in via the `tags` input.
	// Possible values: `lower`, `title`, `upper` and `none` (no transformation).
	// Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.
	// Default value: `lower`.
	LabelValueCase *string `field:"optional" json:"labelValueCase" yaml:"labelValueCase"`
	// ID element.
	//
	// Usually the component or solution name, e.g. 'app' or 'jenkins'.
	// This is the only ID element not also included as a `tag`.
	// The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.
	Name *string `field:"optional" json:"name" yaml:"name"`
	// ID element.
	//
	// Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// Terraform regular expression (regex) string.
	//
	// Characters matching the regex will be removed from the ID elements.
	// If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.
	RegexReplaceChars *string `field:"optional" json:"regexReplaceChars" yaml:"regexReplaceChars"`
	// ID element.
	//
	// Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
	Stage *string `field:"optional" json:"stage" yaml:"stage"`
	// Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.
	//
	// The property type contains a map, they have special handling, please see {@link cdk.tf /module-map-inputs the docs}
	Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
	// ID element _(Rarely used, not included by default)_.
	//
	// A customer identifier, indicating who this instance of a resource is for.
	Tenant *string `field:"optional" json:"tenant" yaml:"tenant"`
}