default_vpc.md

permalink
/default_vpc/

default_vpc

default_vpc represents the aws_default_vpc Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withAssignGeneratedIpv6CidrBlock()
• fn withEnableDnsHostnames()
• fn withEnableDnsSupport()
• fn withEnableNetworkAddressUsageMetrics()
• fn withForceDestroy()
• fn withIpv6CidrBlock()
• fn withIpv6CidrBlockNetworkBorderGroup()
• fn withIpv6IpamPoolId()
• fn withIpv6NetmaskLength()
• fn withTags()
• fn withTagsAll()

Fields

fn new

new()

aws.default_vpc.new injects a new aws_default_vpc Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.default_vpc.new('some_id')

You can get the reference to the id field of the created aws.default_vpc using the reference:

$._ref.aws_default_vpc.some_id.get('id')

This is the same as directly entering "${ aws_default_vpc.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• assign_generated_ipv6_cidr_block (bool): Set the assign_generated_ipv6_cidr_block field on the resulting resource block. When null, the assign_generated_ipv6_cidr_block field will be omitted from the resulting object.
• enable_dns_hostnames (bool): Set the enable_dns_hostnames field on the resulting resource block. When null, the enable_dns_hostnames field will be omitted from the resulting object.
• enable_dns_support (bool): Set the enable_dns_support field on the resulting resource block. When null, the enable_dns_support field will be omitted from the resulting object.
• enable_network_address_usage_metrics (bool): Set the enable_network_address_usage_metrics field on the resulting resource block. When null, the enable_network_address_usage_metrics field will be omitted from the resulting object.
• force_destroy (bool): Set the force_destroy field on the resulting resource block. When null, the force_destroy field will be omitted from the resulting object.
• ipv6_cidr_block (string): Set the ipv6_cidr_block field on the resulting resource block. When null, the ipv6_cidr_block field will be omitted from the resulting object.
• ipv6_cidr_block_network_border_group (string): Set the ipv6_cidr_block_network_border_group field on the resulting resource block. When null, the ipv6_cidr_block_network_border_group field will be omitted from the resulting object.
• ipv6_ipam_pool_id (string): Set the ipv6_ipam_pool_id field on the resulting resource block. When null, the ipv6_ipam_pool_id field will be omitted from the resulting object.
• ipv6_netmask_length (number): Set the ipv6_netmask_length field on the resulting resource block. When null, the ipv6_netmask_length field will be omitted from the resulting object.
• tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.default_vpc.newAttrs constructs a new object with attributes and blocks configured for the default_vpc Terraform resource.

Unlike aws.default_vpc.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• assign_generated_ipv6_cidr_block (bool): Set the assign_generated_ipv6_cidr_block field on the resulting object. When null, the assign_generated_ipv6_cidr_block field will be omitted from the resulting object.
• enable_dns_hostnames (bool): Set the enable_dns_hostnames field on the resulting object. When null, the enable_dns_hostnames field will be omitted from the resulting object.
• enable_dns_support (bool): Set the enable_dns_support field on the resulting object. When null, the enable_dns_support field will be omitted from the resulting object.
• enable_network_address_usage_metrics (bool): Set the enable_network_address_usage_metrics field on the resulting object. When null, the enable_network_address_usage_metrics field will be omitted from the resulting object.
• force_destroy (bool): Set the force_destroy field on the resulting object. When null, the force_destroy field will be omitted from the resulting object.
• ipv6_cidr_block (string): Set the ipv6_cidr_block field on the resulting object. When null, the ipv6_cidr_block field will be omitted from the resulting object.
• ipv6_cidr_block_network_border_group (string): Set the ipv6_cidr_block_network_border_group field on the resulting object. When null, the ipv6_cidr_block_network_border_group field will be omitted from the resulting object.
• ipv6_ipam_pool_id (string): Set the ipv6_ipam_pool_id field on the resulting object. When null, the ipv6_ipam_pool_id field will be omitted from the resulting object.
• ipv6_netmask_length (number): Set the ipv6_netmask_length field on the resulting object. When null, the ipv6_netmask_length field will be omitted from the resulting object.
• tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.

Returns:

• An attribute object that can be used with tf.withResource to construct a new default_vpc resource into the root Terraform configuration.

fn withAssignGeneratedIpv6CidrBlock

withAssignGeneratedIpv6CidrBlock()

aws.bool.withAssignGeneratedIpv6CidrBlock constructs a mixin object that can be merged into the bool Terraform resource block to set or update the assign_generated_ipv6_cidr_block field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the assign_generated_ipv6_cidr_block field.

fn withEnableDnsHostnames

withEnableDnsHostnames()

aws.bool.withEnableDnsHostnames constructs a mixin object that can be merged into the bool Terraform resource block to set or update the enable_dns_hostnames field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the enable_dns_hostnames field.

fn withEnableDnsSupport

withEnableDnsSupport()

aws.bool.withEnableDnsSupport constructs a mixin object that can be merged into the bool Terraform resource block to set or update the enable_dns_support field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the enable_dns_support field.

fn withEnableNetworkAddressUsageMetrics

withEnableNetworkAddressUsageMetrics()

aws.bool.withEnableNetworkAddressUsageMetrics constructs a mixin object that can be merged into the bool Terraform resource block to set or update the enable_network_address_usage_metrics field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the enable_network_address_usage_metrics field.

fn withForceDestroy

withForceDestroy()

aws.bool.withForceDestroy constructs a mixin object that can be merged into the bool Terraform resource block to set or update the force_destroy field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the force_destroy field.

fn withIpv6CidrBlock

withIpv6CidrBlock()

aws.string.withIpv6CidrBlock constructs a mixin object that can be merged into the string Terraform resource block to set or update the ipv6_cidr_block field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the ipv6_cidr_block field.

fn withIpv6CidrBlockNetworkBorderGroup

withIpv6CidrBlockNetworkBorderGroup()

aws.string.withIpv6CidrBlockNetworkBorderGroup constructs a mixin object that can be merged into the string Terraform resource block to set or update the ipv6_cidr_block_network_border_group field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the ipv6_cidr_block_network_border_group field.

fn withIpv6IpamPoolId

withIpv6IpamPoolId()

aws.string.withIpv6IpamPoolId constructs a mixin object that can be merged into the string Terraform resource block to set or update the ipv6_ipam_pool_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the ipv6_ipam_pool_id field.

fn withIpv6NetmaskLength

withIpv6NetmaskLength()

aws.number.withIpv6NetmaskLength constructs a mixin object that can be merged into the number Terraform resource block to set or update the ipv6_netmask_length field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the ipv6_netmask_length field.

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags field.

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags_all field.