Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc aws_vpc}.
import { vpc } from '@cdktf/provider-aws'
new vpc.Vpc(scope: Construct, id: string, config?: VpcConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
VpcConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: VpcConfig
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
addOverride |
No description. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
resetOverrideLogicalId |
Resets a previously passed logical Id to use the auto-generated logical id again. |
toHclTerraform |
No description. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
addMoveTarget |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
hasResourceMove |
No description. |
importFrom |
No description. |
interpolationForAttribute |
No description. |
moveFromId |
Move the resource corresponding to "id" to this resource. |
moveTo |
Moves this resource to the target resource given by moveTarget. |
moveToId |
Moves this resource to the resource corresponding to "id". |
resetAssignGeneratedIpv6CidrBlock |
No description. |
resetCidrBlock |
No description. |
resetEnableDnsHostnames |
No description. |
resetEnableDnsSupport |
No description. |
resetEnableNetworkAddressUsageMetrics |
No description. |
resetId |
No description. |
resetInstanceTenancy |
No description. |
resetIpv4IpamPoolId |
No description. |
resetIpv4NetmaskLength |
No description. |
resetIpv6CidrBlock |
No description. |
resetIpv6CidrBlockNetworkBorderGroup |
No description. |
resetIpv6IpamPoolId |
No description. |
resetIpv6NetmaskLength |
No description. |
resetTags |
No description. |
resetTagsAll |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public addMoveTarget(moveTarget: string): void
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public moveFromId(id: string): void
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public resetAssignGeneratedIpv6CidrBlock(): void
public resetCidrBlock(): void
public resetEnableDnsHostnames(): void
public resetEnableDnsSupport(): void
public resetEnableNetworkAddressUsageMetrics(): void
public resetId(): void
public resetInstanceTenancy(): void
public resetIpv4IpamPoolId(): void
public resetIpv4NetmaskLength(): void
public resetIpv6CidrBlock(): void
public resetIpv6CidrBlockNetworkBorderGroup(): void
public resetIpv6IpamPoolId(): void
public resetIpv6NetmaskLength(): void
public resetTags(): void
public resetTagsAll(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a Vpc resource upon running "cdktf plan ". |
import { vpc } from '@cdktf/provider-aws'
vpc.Vpc.isConstruct(x: any)
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.
- Type: any
Any object.
import { vpc } from '@cdktf/provider-aws'
vpc.Vpc.isTerraformElement(x: any)
- Type: any
import { vpc } from '@cdktf/provider-aws'
vpc.Vpc.isTerraformResource(x: any)
- Type: any
import { vpc } from '@cdktf/provider-aws'
vpc.Vpc.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a Vpc resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the Vpc to import.
- Type: string
The id of the existing Vpc that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the Vpc to import is found.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cdktfStack |
cdktf.TerraformStack |
No description. |
fqn |
string |
No description. |
friendlyUniqueId |
string |
No description. |
terraformMetaArguments |
{[ key: string ]: any} |
No description. |
terraformResourceType |
string |
No description. |
terraformGeneratorMetadata |
cdktf.TerraformProviderGeneratorMetadata |
No description. |
connection |
cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection |
No description. |
count |
number | cdktf.TerraformCount |
No description. |
dependsOn |
string[] |
No description. |
forEach |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] |
No description. |
arn |
string |
No description. |
defaultNetworkAclId |
string |
No description. |
defaultRouteTableId |
string |
No description. |
defaultSecurityGroupId |
string |
No description. |
dhcpOptionsId |
string |
No description. |
ipv6AssociationId |
string |
No description. |
mainRouteTableId |
string |
No description. |
ownerId |
string |
No description. |
assignGeneratedIpv6CidrBlockInput |
boolean | cdktf.IResolvable |
No description. |
cidrBlockInput |
string |
No description. |
enableDnsHostnamesInput |
boolean | cdktf.IResolvable |
No description. |
enableDnsSupportInput |
boolean | cdktf.IResolvable |
No description. |
enableNetworkAddressUsageMetricsInput |
boolean | cdktf.IResolvable |
No description. |
idInput |
string |
No description. |
instanceTenancyInput |
string |
No description. |
ipv4IpamPoolIdInput |
string |
No description. |
ipv4NetmaskLengthInput |
number |
No description. |
ipv6CidrBlockInput |
string |
No description. |
ipv6CidrBlockNetworkBorderGroupInput |
string |
No description. |
ipv6IpamPoolIdInput |
string |
No description. |
ipv6NetmaskLengthInput |
number |
No description. |
tagsAllInput |
{[ key: string ]: string} |
No description. |
tagsInput |
{[ key: string ]: string} |
No description. |
assignGeneratedIpv6CidrBlock |
boolean | cdktf.IResolvable |
No description. |
cidrBlock |
string |
No description. |
enableDnsHostnames |
boolean | cdktf.IResolvable |
No description. |
enableDnsSupport |
boolean | cdktf.IResolvable |
No description. |
enableNetworkAddressUsageMetrics |
boolean | cdktf.IResolvable |
No description. |
id |
string |
No description. |
instanceTenancy |
string |
No description. |
ipv4IpamPoolId |
string |
No description. |
ipv4NetmaskLength |
number |
No description. |
ipv6CidrBlock |
string |
No description. |
ipv6CidrBlockNetworkBorderGroup |
string |
No description. |
ipv6IpamPoolId |
string |
No description. |
ipv6NetmaskLength |
number |
No description. |
tags |
{[ key: string ]: string} |
No description. |
tagsAll |
{[ key: string ]: string} |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly arn: string;
- Type: string
public readonly defaultNetworkAclId: string;
- Type: string
public readonly defaultRouteTableId: string;
- Type: string
public readonly defaultSecurityGroupId: string;
- Type: string
public readonly dhcpOptionsId: string;
- Type: string
public readonly ipv6AssociationId: string;
- Type: string
public readonly mainRouteTableId: string;
- Type: string
public readonly ownerId: string;
- Type: string
public readonly assignGeneratedIpv6CidrBlockInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly cidrBlockInput: string;
- Type: string
public readonly enableDnsHostnamesInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly enableDnsSupportInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly enableNetworkAddressUsageMetricsInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly idInput: string;
- Type: string
public readonly instanceTenancyInput: string;
- Type: string
public readonly ipv4IpamPoolIdInput: string;
- Type: string
public readonly ipv4NetmaskLengthInput: number;
- Type: number
public readonly ipv6CidrBlockInput: string;
- Type: string
public readonly ipv6CidrBlockNetworkBorderGroupInput: string;
- Type: string
public readonly ipv6IpamPoolIdInput: string;
- Type: string
public readonly ipv6NetmaskLengthInput: number;
- Type: number
public readonly tagsAllInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly tagsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly assignGeneratedIpv6CidrBlock: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly cidrBlock: string;
- Type: string
public readonly enableDnsHostnames: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly enableDnsSupport: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly enableNetworkAddressUsageMetrics: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly id: string;
- Type: string
public readonly instanceTenancy: string;
- Type: string
public readonly ipv4IpamPoolId: string;
- Type: string
public readonly ipv4NetmaskLength: number;
- Type: number
public readonly ipv6CidrBlock: string;
- Type: string
public readonly ipv6CidrBlockNetworkBorderGroup: string;
- Type: string
public readonly ipv6IpamPoolId: string;
- Type: string
public readonly ipv6NetmaskLength: number;
- Type: number
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly tagsAll: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { vpc } from '@cdktf/provider-aws'
const vpcConfig: vpc.VpcConfig = { ... }
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly assignGeneratedIpv6CidrBlock: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#assign_generated_ipv6_cidr_block Vpc#assign_generated_ipv6_cidr_block}.
public readonly cidrBlock: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#cidr_block Vpc#cidr_block}.
public readonly enableDnsHostnames: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#enable_dns_hostnames Vpc#enable_dns_hostnames}.
public readonly enableDnsSupport: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#enable_dns_support Vpc#enable_dns_support}.
public readonly enableNetworkAddressUsageMetrics: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#enable_network_address_usage_metrics Vpc#enable_network_address_usage_metrics}.
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#id Vpc#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
public readonly instanceTenancy: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#instance_tenancy Vpc#instance_tenancy}.
public readonly ipv4IpamPoolId: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#ipv4_ipam_pool_id Vpc#ipv4_ipam_pool_id}.
public readonly ipv4NetmaskLength: number;
- Type: number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#ipv4_netmask_length Vpc#ipv4_netmask_length}.
public readonly ipv6CidrBlock: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#ipv6_cidr_block Vpc#ipv6_cidr_block}.
public readonly ipv6CidrBlockNetworkBorderGroup: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#ipv6_cidr_block_network_border_group Vpc#ipv6_cidr_block_network_border_group}.
public readonly ipv6IpamPoolId: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#ipv6_ipam_pool_id Vpc#ipv6_ipam_pool_id}.
public readonly ipv6NetmaskLength: number;
- Type: number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#ipv6_netmask_length Vpc#ipv6_netmask_length}.
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#tags Vpc#tags}.
public readonly tagsAll: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/vpc#tags_all Vpc#tags_all}.