compute_public_delegated_prefix.md

permalink
/compute_public_delegated_prefix/

compute_public_delegated_prefix

compute_public_delegated_prefix represents the google_compute_public_delegated_prefix Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withDescription()
• fn withIpCidrRange()
• fn withIsLiveMigration()
• fn withName()
• fn withParentPrefix()
• fn withProject()
• fn withRegion()
• fn withTimeouts()
• fn withTimeoutsMixin()
• obj timeouts
  • fn new()

Fields

fn new

new()

google.compute_public_delegated_prefix.new injects a new google_compute_public_delegated_prefix 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
google.compute_public_delegated_prefix.new('some_id')

You can get the reference to the id field of the created google.compute_public_delegated_prefix using the reference:

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

This is the same as directly entering "${ google_compute_public_delegated_prefix.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.
• description (string): An optional description of this resource. When null, the description field will be omitted from the resulting object.
• ip_cidr_range (string): The IPv4 address range, in CIDR format, represented by this public advertised prefix.
• is_live_migration (bool): If true, the prefix will be live migrated. When null, the is_live_migration field will be omitted from the resulting object.
• name (string): Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
• parent_prefix (string): The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
• project (string): Set the project field on the resulting resource block. When null, the project field will be omitted from the resulting object.
• region (string): A region where the prefix will reside.
• 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 google.compute_public_delegated_prefix.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

google.compute_public_delegated_prefix.newAttrs constructs a new object with attributes and blocks configured for the compute_public_delegated_prefix Terraform resource.

Unlike google.compute_public_delegated_prefix.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:

• description (string): An optional description of this resource. When null, the description field will be omitted from the resulting object.
• ip_cidr_range (string): The IPv4 address range, in CIDR format, represented by this public advertised prefix.
• is_live_migration (bool): If true, the prefix will be live migrated. When null, the is_live_migration field will be omitted from the resulting object.
• name (string): Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
• parent_prefix (string): The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
• project (string): Set the project field on the resulting object. When null, the project field will be omitted from the resulting object.
• region (string): A region where the prefix will reside.
• 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 google.compute_public_delegated_prefix.timeouts.new constructor.

Returns:

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

fn withDescription

withDescription()

google.string.withDescription constructs a mixin object that can be merged into the string Terraform resource block to set or update the description field.

Args:

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

fn withIpCidrRange

withIpCidrRange()

google.string.withIpCidrRange constructs a mixin object that can be merged into the string Terraform resource block to set or update the ip_cidr_range field.

Args:

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

fn withIsLiveMigration

withIsLiveMigration()

google.bool.withIsLiveMigration constructs a mixin object that can be merged into the bool Terraform resource block to set or update the is_live_migration field.

Args:

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

fn withName

withName()

google.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

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

fn withParentPrefix

withParentPrefix()

google.string.withParentPrefix constructs a mixin object that can be merged into the string Terraform resource block to set or update the parent_prefix field.

Args:

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

fn withProject

withProject()

google.string.withProject constructs a mixin object that can be merged into the string Terraform resource block to set or update the project field.

Args:

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

fn withRegion

withRegion()

google.string.withRegion constructs a mixin object that can be merged into the string Terraform resource block to set or update the region field.

Args:

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

fn withTimeouts

withTimeouts()

google.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 google.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()

google.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 google.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()

google.compute_public_delegated_prefix.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.