Skip to content

Latest commit

 

History

History
1725 lines (1092 loc) · 73.8 KB

vpc.java.md

File metadata and controls

1725 lines (1092 loc) · 73.8 KB
Raw

vpc Submodule

Constructs

Vpc

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

Initializers 

import com.hashicorp.cdktf.providers.aws.vpc.Vpc;

Vpc.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
//  .assignGeneratedIpv6CidrBlock(java.lang.Boolean)
//  .assignGeneratedIpv6CidrBlock(IResolvable)
//  .cidrBlock(java.lang.String)
//  .enableDnsHostnames(java.lang.Boolean)
//  .enableDnsHostnames(IResolvable)
//  .enableDnsSupport(java.lang.Boolean)
//  .enableDnsSupport(IResolvable)
//  .enableNetworkAddressUsageMetrics(java.lang.Boolean)
//  .enableNetworkAddressUsageMetrics(IResolvable)
//  .id(java.lang.String)
//  .instanceTenancy(java.lang.String)
//  .ipv4IpamPoolId(java.lang.String)
//  .ipv4NetmaskLength(java.lang.Number)
//  .ipv6CidrBlock(java.lang.String)
//  .ipv6CidrBlockNetworkBorderGroup(java.lang.String)
//  .ipv6IpamPoolId(java.lang.String)
//  .ipv6NetmaskLength(java.lang.Number)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
assignGeneratedIpv6CidrBlock java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#assign_generated_ipv6_cidr_block Vpc#assign_generated_ipv6_cidr_block}.
cidrBlock java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#cidr_block Vpc#cidr_block}.
enableDnsHostnames java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#enable_dns_hostnames Vpc#enable_dns_hostnames}.
enableDnsSupport java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#enable_dns_support Vpc#enable_dns_support}.
enableNetworkAddressUsageMetrics java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#enable_network_address_usage_metrics Vpc#enable_network_address_usage_metrics}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#id Vpc#id}.
instanceTenancy java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#instance_tenancy Vpc#instance_tenancy}.
ipv4IpamPoolId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv4_ipam_pool_id Vpc#ipv4_ipam_pool_id}.
ipv4NetmaskLength java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv4_netmask_length Vpc#ipv4_netmask_length}.
ipv6CidrBlock java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv6_cidr_block Vpc#ipv6_cidr_block}.
ipv6CidrBlockNetworkBorderGroup java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv6_cidr_block_network_border_group Vpc#ipv6_cidr_block_network_border_group}.
ipv6IpamPoolId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv6_ipam_pool_id Vpc#ipv6_ipam_pool_id}.
ipv6NetmaskLength java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv6_netmask_length Vpc#ipv6_netmask_length}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#tags Vpc#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#tags_all Vpc#tags_all}.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
assignGeneratedIpv6CidrBlockOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

cidrBlockOptional
  • Type: java.lang.String

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

enableDnsHostnamesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

enableDnsSupportOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

enableNetworkAddressUsageMetricsOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

idOptional
  • Type: java.lang.String

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

instanceTenancyOptional
  • Type: java.lang.String

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

ipv4IpamPoolIdOptional
  • Type: java.lang.String

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

ipv4NetmaskLengthOptional
  • Type: java.lang.Number

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

ipv6CidrBlockOptional
  • Type: java.lang.String

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

ipv6CidrBlockNetworkBorderGroupOptional
  • Type: java.lang.String

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

ipv6IpamPoolIdOptional
  • Type: java.lang.String

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

ipv6NetmaskLengthOptional
  • Type: java.lang.Number

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

tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

tagsAllOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

Methods

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.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

resetAssignGeneratedIpv6CidrBlock 
public void resetAssignGeneratedIpv6CidrBlock()
resetCidrBlock 
public void resetCidrBlock()
resetEnableDnsHostnames 
public void resetEnableDnsHostnames()
resetEnableDnsSupport 
public void resetEnableDnsSupport()
resetEnableNetworkAddressUsageMetrics 
public void resetEnableNetworkAddressUsageMetrics()
resetId 
public void resetId()
resetInstanceTenancy 
public void resetInstanceTenancy()
resetIpv4IpamPoolId 
public void resetIpv4IpamPoolId()
resetIpv4NetmaskLength 
public void resetIpv4NetmaskLength()
resetIpv6CidrBlock 
public void resetIpv6CidrBlock()
resetIpv6CidrBlockNetworkBorderGroup 
public void resetIpv6CidrBlockNetworkBorderGroup()
resetIpv6IpamPoolId 
public void resetIpv6IpamPoolId()
resetIpv6NetmaskLength 
public void resetIpv6NetmaskLength()
resetTags 
public void resetTags()
resetTagsAll 
public void resetTagsAll()

Static Functions

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 ".
isConstruct 
import com.hashicorp.cdktf.providers.aws.vpc.Vpc;

Vpc.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.aws.vpc.Vpc;

Vpc.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.aws.vpc.Vpc;

Vpc.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.aws.vpc.Vpc;

Vpc.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Vpc.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing Vpc that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
arn java.lang.String No description.
defaultNetworkAclId java.lang.String No description.
defaultRouteTableId java.lang.String No description.
defaultSecurityGroupId java.lang.String No description.
dhcpOptionsId java.lang.String No description.
ipv6AssociationId java.lang.String No description.
mainRouteTableId java.lang.String No description.
ownerId java.lang.String No description.
assignGeneratedIpv6CidrBlockInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
cidrBlockInput java.lang.String No description.
enableDnsHostnamesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableDnsSupportInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableNetworkAddressUsageMetricsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
instanceTenancyInput java.lang.String No description.
ipv4IpamPoolIdInput java.lang.String No description.
ipv4NetmaskLengthInput java.lang.Number No description.
ipv6CidrBlockInput java.lang.String No description.
ipv6CidrBlockNetworkBorderGroupInput java.lang.String No description.
ipv6IpamPoolIdInput java.lang.String No description.
ipv6NetmaskLengthInput java.lang.Number No description.
tagsAllInput java.util.Map<java.lang.String, java.lang.String> No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
assignGeneratedIpv6CidrBlock java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
cidrBlock java.lang.String No description.
enableDnsHostnames java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableDnsSupport java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableNetworkAddressUsageMetrics java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
instanceTenancy java.lang.String No description.
ipv4IpamPoolId java.lang.String No description.
ipv4NetmaskLength java.lang.Number No description.
ipv6CidrBlock java.lang.String No description.
ipv6CidrBlockNetworkBorderGroup java.lang.String No description.
ipv6IpamPoolId java.lang.String No description.
ipv6NetmaskLength java.lang.Number No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
tagsAll java.util.Map<java.lang.String, java.lang.String> No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
arnRequired 
public java.lang.String getArn();
  • Type: java.lang.String
defaultNetworkAclIdRequired 
public java.lang.String getDefaultNetworkAclId();
  • Type: java.lang.String
defaultRouteTableIdRequired 
public java.lang.String getDefaultRouteTableId();
  • Type: java.lang.String
defaultSecurityGroupIdRequired 
public java.lang.String getDefaultSecurityGroupId();
  • Type: java.lang.String
dhcpOptionsIdRequired 
public java.lang.String getDhcpOptionsId();
  • Type: java.lang.String
ipv6AssociationIdRequired 
public java.lang.String getIpv6AssociationId();
  • Type: java.lang.String
mainRouteTableIdRequired 
public java.lang.String getMainRouteTableId();
  • Type: java.lang.String
ownerIdRequired 
public java.lang.String getOwnerId();
  • Type: java.lang.String
assignGeneratedIpv6CidrBlockInputOptional 
public java.lang.Object getAssignGeneratedIpv6CidrBlockInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
cidrBlockInputOptional 
public java.lang.String getCidrBlockInput();
  • Type: java.lang.String
enableDnsHostnamesInputOptional 
public java.lang.Object getEnableDnsHostnamesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableDnsSupportInputOptional 
public java.lang.Object getEnableDnsSupportInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableNetworkAddressUsageMetricsInputOptional 
public java.lang.Object getEnableNetworkAddressUsageMetricsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
instanceTenancyInputOptional 
public java.lang.String getInstanceTenancyInput();
  • Type: java.lang.String
ipv4IpamPoolIdInputOptional 
public java.lang.String getIpv4IpamPoolIdInput();
  • Type: java.lang.String
ipv4NetmaskLengthInputOptional 
public java.lang.Number getIpv4NetmaskLengthInput();
  • Type: java.lang.Number
ipv6CidrBlockInputOptional 
public java.lang.String getIpv6CidrBlockInput();
  • Type: java.lang.String
ipv6CidrBlockNetworkBorderGroupInputOptional 
public java.lang.String getIpv6CidrBlockNetworkBorderGroupInput();
  • Type: java.lang.String
ipv6IpamPoolIdInputOptional 
public java.lang.String getIpv6IpamPoolIdInput();
  • Type: java.lang.String
ipv6NetmaskLengthInputOptional 
public java.lang.Number getIpv6NetmaskLengthInput();
  • Type: java.lang.Number
tagsAllInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
assignGeneratedIpv6CidrBlockRequired 
public java.lang.Object getAssignGeneratedIpv6CidrBlock();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
cidrBlockRequired 
public java.lang.String getCidrBlock();
  • Type: java.lang.String
enableDnsHostnamesRequired 
public java.lang.Object getEnableDnsHostnames();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableDnsSupportRequired 
public java.lang.Object getEnableDnsSupport();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableNetworkAddressUsageMetricsRequired 
public java.lang.Object getEnableNetworkAddressUsageMetrics();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
instanceTenancyRequired 
public java.lang.String getInstanceTenancy();
  • Type: java.lang.String
ipv4IpamPoolIdRequired 
public java.lang.String getIpv4IpamPoolId();
  • Type: java.lang.String
ipv4NetmaskLengthRequired 
public java.lang.Number getIpv4NetmaskLength();
  • Type: java.lang.Number
ipv6CidrBlockRequired 
public java.lang.String getIpv6CidrBlock();
  • Type: java.lang.String
ipv6CidrBlockNetworkBorderGroupRequired 
public java.lang.String getIpv6CidrBlockNetworkBorderGroup();
  • Type: java.lang.String
ipv6IpamPoolIdRequired 
public java.lang.String getIpv6IpamPoolId();
  • Type: java.lang.String
ipv6NetmaskLengthRequired 
public java.lang.Number getIpv6NetmaskLength();
  • Type: java.lang.Number
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsAllRequired 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

VpcConfig

Initializer 

import com.hashicorp.cdktf.providers.aws.vpc.VpcConfig;

VpcConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
//  .assignGeneratedIpv6CidrBlock(java.lang.Boolean)
//  .assignGeneratedIpv6CidrBlock(IResolvable)
//  .cidrBlock(java.lang.String)
//  .enableDnsHostnames(java.lang.Boolean)
//  .enableDnsHostnames(IResolvable)
//  .enableDnsSupport(java.lang.Boolean)
//  .enableDnsSupport(IResolvable)
//  .enableNetworkAddressUsageMetrics(java.lang.Boolean)
//  .enableNetworkAddressUsageMetrics(IResolvable)
//  .id(java.lang.String)
//  .instanceTenancy(java.lang.String)
//  .ipv4IpamPoolId(java.lang.String)
//  .ipv4NetmaskLength(java.lang.Number)
//  .ipv6CidrBlock(java.lang.String)
//  .ipv6CidrBlockNetworkBorderGroup(java.lang.String)
//  .ipv6IpamPoolId(java.lang.String)
//  .ipv6NetmaskLength(java.lang.Number)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
assignGeneratedIpv6CidrBlock java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#assign_generated_ipv6_cidr_block Vpc#assign_generated_ipv6_cidr_block}.
cidrBlock java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#cidr_block Vpc#cidr_block}.
enableDnsHostnames java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#enable_dns_hostnames Vpc#enable_dns_hostnames}.
enableDnsSupport java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#enable_dns_support Vpc#enable_dns_support}.
enableNetworkAddressUsageMetrics java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#enable_network_address_usage_metrics Vpc#enable_network_address_usage_metrics}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#id Vpc#id}.
instanceTenancy java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#instance_tenancy Vpc#instance_tenancy}.
ipv4IpamPoolId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv4_ipam_pool_id Vpc#ipv4_ipam_pool_id}.
ipv4NetmaskLength java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv4_netmask_length Vpc#ipv4_netmask_length}.
ipv6CidrBlock java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv6_cidr_block Vpc#ipv6_cidr_block}.
ipv6CidrBlockNetworkBorderGroup java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv6_cidr_block_network_border_group Vpc#ipv6_cidr_block_network_border_group}.
ipv6IpamPoolId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv6_ipam_pool_id Vpc#ipv6_ipam_pool_id}.
ipv6NetmaskLength java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#ipv6_netmask_length Vpc#ipv6_netmask_length}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#tags Vpc#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/vpc#tags_all Vpc#tags_all}.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
assignGeneratedIpv6CidrBlockOptional 
public java.lang.Object getAssignGeneratedIpv6CidrBlock();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

cidrBlockOptional 
public java.lang.String getCidrBlock();
  • Type: java.lang.String

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

enableDnsHostnamesOptional 
public java.lang.Object getEnableDnsHostnames();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

enableDnsSupportOptional 
public java.lang.Object getEnableDnsSupport();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

enableNetworkAddressUsageMetricsOptional 
public java.lang.Object getEnableNetworkAddressUsageMetrics();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

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

instanceTenancyOptional 
public java.lang.String getInstanceTenancy();
  • Type: java.lang.String

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

ipv4IpamPoolIdOptional 
public java.lang.String getIpv4IpamPoolId();
  • Type: java.lang.String

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

ipv4NetmaskLengthOptional 
public java.lang.Number getIpv4NetmaskLength();
  • Type: java.lang.Number

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

ipv6CidrBlockOptional 
public java.lang.String getIpv6CidrBlock();
  • Type: java.lang.String

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

ipv6CidrBlockNetworkBorderGroupOptional 
public java.lang.String getIpv6CidrBlockNetworkBorderGroup();
  • Type: java.lang.String

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

ipv6IpamPoolIdOptional 
public java.lang.String getIpv6IpamPoolId();
  • Type: java.lang.String

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

ipv6NetmaskLengthOptional 
public java.lang.Number getIpv6NetmaskLength();
  • Type: java.lang.Number

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

tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

tagsAllOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

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