Skip to content

Latest commit

 

History

History
1757 lines (1124 loc) · 70.5 KB

vpc.python.md

File metadata and controls

1757 lines (1124 loc) · 70.5 KB
Raw

vpc Submodule

Constructs

Vpc

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc aws_vpc}.

Initializers 

from cdktf_cdktf_provider_aws import vpc

vpc.Vpc(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  assign_generated_ipv6_cidr_block: typing.Union[bool, IResolvable] = None,
  cidr_block: str = None,
  enable_dns_hostnames: typing.Union[bool, IResolvable] = None,
  enable_dns_support: typing.Union[bool, IResolvable] = None,
  enable_network_address_usage_metrics: typing.Union[bool, IResolvable] = None,
  id: str = None,
  instance_tenancy: str = None,
  ipv4_ipam_pool_id: str = None,
  ipv4_netmask_length: typing.Union[int, float] = None,
  ipv6_cidr_block: str = None,
  ipv6_cidr_block_network_border_group: str = None,
  ipv6_ipam_pool_id: str = None,
  ipv6_netmask_length: typing.Union[int, float] = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
assign_generated_ipv6_cidr_block typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#assign_generated_ipv6_cidr_block Vpc#assign_generated_ipv6_cidr_block}.
cidr_block str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#cidr_block Vpc#cidr_block}.
enable_dns_hostnames typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_dns_hostnames Vpc#enable_dns_hostnames}.
enable_dns_support typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_dns_support Vpc#enable_dns_support}.
enable_network_address_usage_metrics typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_network_address_usage_metrics Vpc#enable_network_address_usage_metrics}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#id Vpc#id}.
instance_tenancy str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#instance_tenancy Vpc#instance_tenancy}.
ipv4_ipam_pool_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv4_ipam_pool_id Vpc#ipv4_ipam_pool_id}.
ipv4_netmask_length typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv4_netmask_length Vpc#ipv4_netmask_length}.
ipv6_cidr_block str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_cidr_block Vpc#ipv6_cidr_block}.
ipv6_cidr_block_network_border_group str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_cidr_block_network_border_group Vpc#ipv6_cidr_block_network_border_group}.
ipv6_ipam_pool_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_ipam_pool_id Vpc#ipv6_ipam_pool_id}.
ipv6_netmask_length typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_netmask_length Vpc#ipv6_netmask_length}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#tags Vpc#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#tags_all Vpc#tags_all}.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
assign_generated_ipv6_cidr_blockOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#assign_generated_ipv6_cidr_block Vpc#assign_generated_ipv6_cidr_block}.

cidr_blockOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#cidr_block Vpc#cidr_block}.

enable_dns_hostnamesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_dns_hostnames Vpc#enable_dns_hostnames}.

enable_dns_supportOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_dns_support Vpc#enable_dns_support}.

enable_network_address_usage_metricsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_network_address_usage_metrics Vpc#enable_network_address_usage_metrics}.

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.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.

instance_tenancyOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#instance_tenancy Vpc#instance_tenancy}.

ipv4_ipam_pool_idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv4_ipam_pool_id Vpc#ipv4_ipam_pool_id}.

ipv4_netmask_lengthOptional
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv4_netmask_length Vpc#ipv4_netmask_length}.

ipv6_cidr_blockOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_cidr_block Vpc#ipv6_cidr_block}.

ipv6_cidr_block_network_border_groupOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_cidr_block_network_border_group Vpc#ipv6_cidr_block_network_border_group}.

ipv6_ipam_pool_idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_ipam_pool_id Vpc#ipv6_ipam_pool_id}.

ipv6_netmask_lengthOptional
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_netmask_length Vpc#ipv6_netmask_length}.

tagsOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#tags Vpc#tags}.

tags_allOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#tags_all Vpc#tags_all}.

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_assign_generated_ipv6_cidr_block No description.
reset_cidr_block No description.
reset_enable_dns_hostnames No description.
reset_enable_dns_support No description.
reset_enable_network_address_usage_metrics No description.
reset_id No description.
reset_instance_tenancy No description.
reset_ipv4_ipam_pool_id No description.
reset_ipv4_netmask_length No description.
reset_ipv6_cidr_block No description.
reset_ipv6_cidr_block_network_border_group No description.
reset_ipv6_ipam_pool_id No description.
reset_ipv6_netmask_length No description.
reset_tags No description.
reset_tags_all No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

reset_assign_generated_ipv6_cidr_block 
def reset_assign_generated_ipv6_cidr_block() -> None
reset_cidr_block 
def reset_cidr_block() -> None
reset_enable_dns_hostnames 
def reset_enable_dns_hostnames() -> None
reset_enable_dns_support 
def reset_enable_dns_support() -> None
reset_enable_network_address_usage_metrics 
def reset_enable_network_address_usage_metrics() -> None
reset_id 
def reset_id() -> None
reset_instance_tenancy 
def reset_instance_tenancy() -> None
reset_ipv4_ipam_pool_id 
def reset_ipv4_ipam_pool_id() -> None
reset_ipv4_netmask_length 
def reset_ipv4_netmask_length() -> None
reset_ipv6_cidr_block 
def reset_ipv6_cidr_block() -> None
reset_ipv6_cidr_block_network_border_group 
def reset_ipv6_cidr_block_network_border_group() -> None
reset_ipv6_ipam_pool_id 
def reset_ipv6_ipam_pool_id() -> None
reset_ipv6_netmask_length 
def reset_ipv6_netmask_length() -> None
reset_tags 
def reset_tags() -> None
reset_tags_all 
def reset_tags_all() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a Vpc resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_aws import vpc

vpc.Vpc.is_construct(
  x: typing.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.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_aws import vpc

vpc.Vpc.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_aws import vpc

vpc.Vpc.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_aws import vpc

vpc.Vpc.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a Vpc resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the Vpc to import.

import_from_idRequired
  • Type: str

The id of the existing Vpc that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the Vpc to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
arn str No description.
default_network_acl_id str No description.
default_route_table_id str No description.
default_security_group_id str No description.
dhcp_options_id str No description.
ipv6_association_id str No description.
main_route_table_id str No description.
owner_id str No description.
assign_generated_ipv6_cidr_block_input typing.Union[bool, cdktf.IResolvable] No description.
cidr_block_input str No description.
enable_dns_hostnames_input typing.Union[bool, cdktf.IResolvable] No description.
enable_dns_support_input typing.Union[bool, cdktf.IResolvable] No description.
enable_network_address_usage_metrics_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
instance_tenancy_input str No description.
ipv4_ipam_pool_id_input str No description.
ipv4_netmask_length_input typing.Union[int, float] No description.
ipv6_cidr_block_input str No description.
ipv6_cidr_block_network_border_group_input str No description.
ipv6_ipam_pool_id_input str No description.
ipv6_netmask_length_input typing.Union[int, float] No description.
tags_all_input typing.Mapping[str] No description.
tags_input typing.Mapping[str] No description.
assign_generated_ipv6_cidr_block typing.Union[bool, cdktf.IResolvable] No description.
cidr_block str No description.
enable_dns_hostnames typing.Union[bool, cdktf.IResolvable] No description.
enable_dns_support typing.Union[bool, cdktf.IResolvable] No description.
enable_network_address_usage_metrics typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
instance_tenancy str No description.
ipv4_ipam_pool_id str No description.
ipv4_netmask_length typing.Union[int, float] No description.
ipv6_cidr_block str No description.
ipv6_cidr_block_network_border_group str No description.
ipv6_ipam_pool_id str No description.
ipv6_netmask_length typing.Union[int, float] No description.
tags typing.Mapping[str] No description.
tags_all typing.Mapping[str] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
arnRequired 
arn: str
  • Type: str
default_network_acl_idRequired 
default_network_acl_id: str
  • Type: str
default_route_table_idRequired 
default_route_table_id: str
  • Type: str
default_security_group_idRequired 
default_security_group_id: str
  • Type: str
dhcp_options_idRequired 
dhcp_options_id: str
  • Type: str
ipv6_association_idRequired 
ipv6_association_id: str
  • Type: str
main_route_table_idRequired 
main_route_table_id: str
  • Type: str
owner_idRequired 
owner_id: str
  • Type: str
assign_generated_ipv6_cidr_block_inputOptional 
assign_generated_ipv6_cidr_block_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
cidr_block_inputOptional 
cidr_block_input: str
  • Type: str
enable_dns_hostnames_inputOptional 
enable_dns_hostnames_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_dns_support_inputOptional 
enable_dns_support_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_network_address_usage_metrics_inputOptional 
enable_network_address_usage_metrics_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
instance_tenancy_inputOptional 
instance_tenancy_input: str
  • Type: str
ipv4_ipam_pool_id_inputOptional 
ipv4_ipam_pool_id_input: str
  • Type: str
ipv4_netmask_length_inputOptional 
ipv4_netmask_length_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
ipv6_cidr_block_inputOptional 
ipv6_cidr_block_input: str
  • Type: str
ipv6_cidr_block_network_border_group_inputOptional 
ipv6_cidr_block_network_border_group_input: str
  • Type: str
ipv6_ipam_pool_id_inputOptional 
ipv6_ipam_pool_id_input: str
  • Type: str
ipv6_netmask_length_inputOptional 
ipv6_netmask_length_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
tags_all_inputOptional 
tags_all_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_inputOptional 
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
assign_generated_ipv6_cidr_blockRequired 
assign_generated_ipv6_cidr_block: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
cidr_blockRequired 
cidr_block: str
  • Type: str
enable_dns_hostnamesRequired 
enable_dns_hostnames: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_dns_supportRequired 
enable_dns_support: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_network_address_usage_metricsRequired 
enable_network_address_usage_metrics: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
instance_tenancyRequired 
instance_tenancy: str
  • Type: str
ipv4_ipam_pool_idRequired 
ipv4_ipam_pool_id: str
  • Type: str
ipv4_netmask_lengthRequired 
ipv4_netmask_length: typing.Union[int, float]
  • Type: typing.Union[int, float]
ipv6_cidr_blockRequired 
ipv6_cidr_block: str
  • Type: str
ipv6_cidr_block_network_border_groupRequired 
ipv6_cidr_block_network_border_group: str
  • Type: str
ipv6_ipam_pool_idRequired 
ipv6_ipam_pool_id: str
  • Type: str
ipv6_netmask_lengthRequired 
ipv6_netmask_length: typing.Union[int, float]
  • Type: typing.Union[int, float]
tagsRequired 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_allRequired 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

VpcConfig

Initializer 

from cdktf_cdktf_provider_aws import vpc

vpc.VpcConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  assign_generated_ipv6_cidr_block: typing.Union[bool, IResolvable] = None,
  cidr_block: str = None,
  enable_dns_hostnames: typing.Union[bool, IResolvable] = None,
  enable_dns_support: typing.Union[bool, IResolvable] = None,
  enable_network_address_usage_metrics: typing.Union[bool, IResolvable] = None,
  id: str = None,
  instance_tenancy: str = None,
  ipv4_ipam_pool_id: str = None,
  ipv4_netmask_length: typing.Union[int, float] = None,
  ipv6_cidr_block: str = None,
  ipv6_cidr_block_network_border_group: str = None,
  ipv6_ipam_pool_id: str = None,
  ipv6_netmask_length: typing.Union[int, float] = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
assign_generated_ipv6_cidr_block typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#assign_generated_ipv6_cidr_block Vpc#assign_generated_ipv6_cidr_block}.
cidr_block str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#cidr_block Vpc#cidr_block}.
enable_dns_hostnames typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_dns_hostnames Vpc#enable_dns_hostnames}.
enable_dns_support typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_dns_support Vpc#enable_dns_support}.
enable_network_address_usage_metrics typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_network_address_usage_metrics Vpc#enable_network_address_usage_metrics}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#id Vpc#id}.
instance_tenancy str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#instance_tenancy Vpc#instance_tenancy}.
ipv4_ipam_pool_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv4_ipam_pool_id Vpc#ipv4_ipam_pool_id}.
ipv4_netmask_length typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv4_netmask_length Vpc#ipv4_netmask_length}.
ipv6_cidr_block str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_cidr_block Vpc#ipv6_cidr_block}.
ipv6_cidr_block_network_border_group str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_cidr_block_network_border_group Vpc#ipv6_cidr_block_network_border_group}.
ipv6_ipam_pool_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_ipam_pool_id Vpc#ipv6_ipam_pool_id}.
ipv6_netmask_length typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_netmask_length Vpc#ipv6_netmask_length}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#tags Vpc#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#tags_all Vpc#tags_all}.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
assign_generated_ipv6_cidr_blockOptional 
assign_generated_ipv6_cidr_block: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#assign_generated_ipv6_cidr_block Vpc#assign_generated_ipv6_cidr_block}.

cidr_blockOptional 
cidr_block: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#cidr_block Vpc#cidr_block}.

enable_dns_hostnamesOptional 
enable_dns_hostnames: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_dns_hostnames Vpc#enable_dns_hostnames}.

enable_dns_supportOptional 
enable_dns_support: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_dns_support Vpc#enable_dns_support}.

enable_network_address_usage_metricsOptional 
enable_network_address_usage_metrics: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#enable_network_address_usage_metrics Vpc#enable_network_address_usage_metrics}.

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.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.

instance_tenancyOptional 
instance_tenancy: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#instance_tenancy Vpc#instance_tenancy}.

ipv4_ipam_pool_idOptional 
ipv4_ipam_pool_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv4_ipam_pool_id Vpc#ipv4_ipam_pool_id}.

ipv4_netmask_lengthOptional 
ipv4_netmask_length: typing.Union[int, float]
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv4_netmask_length Vpc#ipv4_netmask_length}.

ipv6_cidr_blockOptional 
ipv6_cidr_block: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_cidr_block Vpc#ipv6_cidr_block}.

ipv6_cidr_block_network_border_groupOptional 
ipv6_cidr_block_network_border_group: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_cidr_block_network_border_group Vpc#ipv6_cidr_block_network_border_group}.

ipv6_ipam_pool_idOptional 
ipv6_ipam_pool_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_ipam_pool_id Vpc#ipv6_ipam_pool_id}.

ipv6_netmask_lengthOptional 
ipv6_netmask_length: typing.Union[int, float]
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#ipv6_netmask_length Vpc#ipv6_netmask_length}.

tagsOptional 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#tags Vpc#tags}.

tags_allOptional 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/resources/vpc#tags_all Vpc#tags_all}.