Skip to content

Latest commit

 

History

History
405 lines (252 loc) · 16.3 KB

default_subnet.md

File metadata and controls

405 lines (252 loc) · 16.3 KB
permalink
/default_subnet/

default_subnet

default_subnet represents the aws_default_subnet Terraform resource.

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

Index

Fields

fn new

new()

aws.default_subnet.new injects a new aws_default_subnet 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_subnet.new('some_id')

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

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

This is the same as directly entering "${ aws_default_subnet.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_ipv6_address_on_creation (bool): Set the assign_ipv6_address_on_creation field on the resulting resource block. When null, the assign_ipv6_address_on_creation field will be omitted from the resulting object.
  • availability_zone (string): Set the availability_zone field on the resulting resource block.
  • customer_owned_ipv4_pool (string): Set the customer_owned_ipv4_pool field on the resulting resource block. When null, the customer_owned_ipv4_pool field will be omitted from the resulting object.
  • enable_dns64 (bool): Set the enable_dns64 field on the resulting resource block. When null, the enable_dns64 field will be omitted from the resulting object.
  • enable_resource_name_dns_a_record_on_launch (bool): Set the enable_resource_name_dns_a_record_on_launch field on the resulting resource block. When null, the enable_resource_name_dns_a_record_on_launch field will be omitted from the resulting object.
  • enable_resource_name_dns_aaaa_record_on_launch (bool): Set the enable_resource_name_dns_aaaa_record_on_launch field on the resulting resource block. When null, the enable_resource_name_dns_aaaa_record_on_launch 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_native (bool): Set the ipv6_native field on the resulting resource block. When null, the ipv6_native field will be omitted from the resulting object.
  • map_customer_owned_ip_on_launch (bool): Set the map_customer_owned_ip_on_launch field on the resulting resource block. When null, the map_customer_owned_ip_on_launch field will be omitted from the resulting object.
  • map_public_ip_on_launch (bool): Set the map_public_ip_on_launch field on the resulting resource block. When null, the map_public_ip_on_launch field will be omitted from the resulting object.
  • private_dns_hostname_type_on_launch (string): Set the private_dns_hostname_type_on_launch field on the resulting resource block. When null, the private_dns_hostname_type_on_launch 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.
  • timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.default_subnet.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.default_subnet.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_ipv6_address_on_creation (bool): Set the assign_ipv6_address_on_creation field on the resulting object. When null, the assign_ipv6_address_on_creation field will be omitted from the resulting object.
  • availability_zone (string): Set the availability_zone field on the resulting object.
  • customer_owned_ipv4_pool (string): Set the customer_owned_ipv4_pool field on the resulting object. When null, the customer_owned_ipv4_pool field will be omitted from the resulting object.
  • enable_dns64 (bool): Set the enable_dns64 field on the resulting object. When null, the enable_dns64 field will be omitted from the resulting object.
  • enable_resource_name_dns_a_record_on_launch (bool): Set the enable_resource_name_dns_a_record_on_launch field on the resulting object. When null, the enable_resource_name_dns_a_record_on_launch field will be omitted from the resulting object.
  • enable_resource_name_dns_aaaa_record_on_launch (bool): Set the enable_resource_name_dns_aaaa_record_on_launch field on the resulting object. When null, the enable_resource_name_dns_aaaa_record_on_launch 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_native (bool): Set the ipv6_native field on the resulting object. When null, the ipv6_native field will be omitted from the resulting object.
  • map_customer_owned_ip_on_launch (bool): Set the map_customer_owned_ip_on_launch field on the resulting object. When null, the map_customer_owned_ip_on_launch field will be omitted from the resulting object.
  • map_public_ip_on_launch (bool): Set the map_public_ip_on_launch field on the resulting object. When null, the map_public_ip_on_launch field will be omitted from the resulting object.
  • private_dns_hostname_type_on_launch (string): Set the private_dns_hostname_type_on_launch field on the resulting object. When null, the private_dns_hostname_type_on_launch 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.
  • timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.default_subnet.timeouts.new constructor.

Returns:

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

fn withAssignIpv6AddressOnCreation

withAssignIpv6AddressOnCreation()

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

Args:

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

fn withAvailabilityZone

withAvailabilityZone()

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

Args:

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

fn withCustomerOwnedIpv4Pool

withCustomerOwnedIpv4Pool()

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

Args:

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

fn withEnableDns64

withEnableDns64()

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

Args:

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

fn withEnableResourceNameDnsARecordOnLaunch

withEnableResourceNameDnsARecordOnLaunch()

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

Args:

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

fn withEnableResourceNameDnsAaaaRecordOnLaunch

withEnableResourceNameDnsAaaaRecordOnLaunch()

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

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (bool): The value to set for the enable_resource_name_dns_aaaa_record_on_launch 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 withIpv6Native

withIpv6Native()

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

Args:

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

fn withMapCustomerOwnedIpOnLaunch

withMapCustomerOwnedIpOnLaunch()

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

Args:

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

fn withMapPublicIpOnLaunch

withMapPublicIpOnLaunch()

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

Args:

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

fn withPrivateDnsHostnameTypeOnLaunch

withPrivateDnsHostnameTypeOnLaunch()

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

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the private_dns_hostname_type_on_launch 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.

fn withTimeouts

withTimeouts()

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

This function will replace the map with the passed in value. If you wish to instead merge the passed in value to the existing map, use the aws.obj.withTimeoutsMixin function.

Args:

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

fn withTimeoutsMixin

withTimeoutsMixin()

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

This function will merge the passed in value to the existing map. If you wish to instead replace the entire map with the passed in value, use the aws.obj.withTimeouts function.

Args:

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

obj timeouts

fn timeouts.new

new()

aws.default_subnet.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

  • create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
  • delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the timeouts sub block.