route53_record.md

permalink
/route53_record/

route53_record

route53_record represents the aws_route53_record Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withAlias()
• fn withAliasMixin()
• fn withAllowOverwrite()
• fn withCidrRoutingPolicy()
• fn withCidrRoutingPolicyMixin()
• fn withFailoverRoutingPolicy()
• fn withFailoverRoutingPolicyMixin()
• fn withGeolocationRoutingPolicy()
• fn withGeolocationRoutingPolicyMixin()
• fn withHealthCheckId()
• fn withLatencyRoutingPolicy()
• fn withLatencyRoutingPolicyMixin()
• fn withMultivalueAnswerRoutingPolicy()
• fn withName()
• fn withRecords()
• fn withSetIdentifier()
• fn withTtl()
• fn withType()
• fn withWeightedRoutingPolicy()
• fn withWeightedRoutingPolicyMixin()
• fn withZoneId()
• obj alias
  • fn new()
• obj cidr_routing_policy
  • fn new()
• obj failover_routing_policy
  • fn new()
• obj geolocation_routing_policy
  • fn new()
• obj latency_routing_policy
  • fn new()
• obj weighted_routing_policy
  • fn new()

Fields

fn new

new()

aws.route53_record.new injects a new aws_route53_record 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.route53_record.new('some_id')

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

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

This is the same as directly entering "${ aws_route53_record.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.
• allow_overwrite (bool): Set the allow_overwrite field on the resulting resource block. When null, the allow_overwrite field will be omitted from the resulting object.
• health_check_id (string): Set the health_check_id field on the resulting resource block. When null, the health_check_id field will be omitted from the resulting object.
• multivalue_answer_routing_policy (bool): Set the multivalue_answer_routing_policy field on the resulting resource block. When null, the multivalue_answer_routing_policy field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block.
• records (list): Set the records field on the resulting resource block. When null, the records field will be omitted from the resulting object.
• set_identifier (string): Set the set_identifier field on the resulting resource block. When null, the set_identifier field will be omitted from the resulting object.
• ttl (number): Set the ttl field on the resulting resource block. When null, the ttl field will be omitted from the resulting object.
• type (string): Set the type field on the resulting resource block.
• zone_id (string): Set the zone_id field on the resulting resource block.
• alias (list[obj]): Set the alias field on the resulting resource block. When null, the alias sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.alias.new constructor.
• cidr_routing_policy (list[obj]): Set the cidr_routing_policy field on the resulting resource block. When null, the cidr_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.cidr_routing_policy.new constructor.
• failover_routing_policy (list[obj]): Set the failover_routing_policy field on the resulting resource block. When null, the failover_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.failover_routing_policy.new constructor.
• geolocation_routing_policy (list[obj]): Set the geolocation_routing_policy field on the resulting resource block. When null, the geolocation_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.geolocation_routing_policy.new constructor.
• latency_routing_policy (list[obj]): Set the latency_routing_policy field on the resulting resource block. When null, the latency_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.latency_routing_policy.new constructor.
• weighted_routing_policy (list[obj]): Set the weighted_routing_policy field on the resulting resource block. When null, the weighted_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.weighted_routing_policy.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.route53_record.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:

• allow_overwrite (bool): Set the allow_overwrite field on the resulting object. When null, the allow_overwrite field will be omitted from the resulting object.
• health_check_id (string): Set the health_check_id field on the resulting object. When null, the health_check_id field will be omitted from the resulting object.
• multivalue_answer_routing_policy (bool): Set the multivalue_answer_routing_policy field on the resulting object. When null, the multivalue_answer_routing_policy field will be omitted from the resulting object.
• name (string): Set the name field on the resulting object.
• records (list): Set the records field on the resulting object. When null, the records field will be omitted from the resulting object.
• set_identifier (string): Set the set_identifier field on the resulting object. When null, the set_identifier field will be omitted from the resulting object.
• ttl (number): Set the ttl field on the resulting object. When null, the ttl field will be omitted from the resulting object.
• type (string): Set the type field on the resulting object.
• zone_id (string): Set the zone_id field on the resulting object.
• alias (list[obj]): Set the alias field on the resulting object. When null, the alias sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.alias.new constructor.
• cidr_routing_policy (list[obj]): Set the cidr_routing_policy field on the resulting object. When null, the cidr_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.cidr_routing_policy.new constructor.
• failover_routing_policy (list[obj]): Set the failover_routing_policy field on the resulting object. When null, the failover_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.failover_routing_policy.new constructor.
• geolocation_routing_policy (list[obj]): Set the geolocation_routing_policy field on the resulting object. When null, the geolocation_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.geolocation_routing_policy.new constructor.
• latency_routing_policy (list[obj]): Set the latency_routing_policy field on the resulting object. When null, the latency_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.latency_routing_policy.new constructor.
• weighted_routing_policy (list[obj]): Set the weighted_routing_policy field on the resulting object. When null, the weighted_routing_policy sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.route53_record.weighted_routing_policy.new constructor.

Returns:

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

fn withAlias

withAlias()

aws.list[obj].withAlias constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the alias field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withAliasMixin function.

Args:

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

fn withAliasMixin

withAliasMixin()

aws.list[obj].withAliasMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the alias field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withAlias function.

Args:

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

fn withAllowOverwrite

withAllowOverwrite()

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

Args:

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

fn withCidrRoutingPolicy

withCidrRoutingPolicy()

aws.list[obj].withCidrRoutingPolicy constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the cidr_routing_policy field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withCidrRoutingPolicyMixin function.

Args:

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

fn withCidrRoutingPolicyMixin

withCidrRoutingPolicyMixin()

aws.list[obj].withCidrRoutingPolicyMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the cidr_routing_policy field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withCidrRoutingPolicy function.

Args:

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

fn withFailoverRoutingPolicy

withFailoverRoutingPolicy()

aws.list[obj].withFailoverRoutingPolicy constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the failover_routing_policy field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withFailoverRoutingPolicyMixin function.

Args:

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

fn withFailoverRoutingPolicyMixin

withFailoverRoutingPolicyMixin()

aws.list[obj].withFailoverRoutingPolicyMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the failover_routing_policy field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withFailoverRoutingPolicy function.

Args:

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

fn withGeolocationRoutingPolicy

withGeolocationRoutingPolicy()

aws.list[obj].withGeolocationRoutingPolicy constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the geolocation_routing_policy field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withGeolocationRoutingPolicyMixin function.

Args:

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

fn withGeolocationRoutingPolicyMixin

withGeolocationRoutingPolicyMixin()

aws.list[obj].withGeolocationRoutingPolicyMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the geolocation_routing_policy field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withGeolocationRoutingPolicy function.

Args:

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

fn withHealthCheckId

withHealthCheckId()

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

Args:

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

fn withLatencyRoutingPolicy

withLatencyRoutingPolicy()

aws.list[obj].withLatencyRoutingPolicy constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the latency_routing_policy field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withLatencyRoutingPolicyMixin function.

Args:

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

fn withLatencyRoutingPolicyMixin

withLatencyRoutingPolicyMixin()

aws.list[obj].withLatencyRoutingPolicyMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the latency_routing_policy field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withLatencyRoutingPolicy function.

Args:

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

fn withMultivalueAnswerRoutingPolicy

withMultivalueAnswerRoutingPolicy()

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

Args:

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

fn withName

withName()

aws.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 withRecords

withRecords()

aws.list.withRecords constructs a mixin object that can be merged into the list Terraform resource block to set or update the records field.

Args:

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

fn withSetIdentifier

withSetIdentifier()

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

Args:

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

fn withTtl

withTtl()

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

Args:

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

fn withType

withType()

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

Args:

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

fn withWeightedRoutingPolicy

withWeightedRoutingPolicy()

aws.list[obj].withWeightedRoutingPolicy constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the weighted_routing_policy field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withWeightedRoutingPolicyMixin function.

Args:

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

fn withWeightedRoutingPolicyMixin

withWeightedRoutingPolicyMixin()

aws.list[obj].withWeightedRoutingPolicyMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the weighted_routing_policy field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withWeightedRoutingPolicy function.

Args:

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

fn withZoneId

withZoneId()

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

Args:

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

obj alias

fn alias.new

new()

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

Args:

• evaluate_target_health (bool): Set the evaluate_target_health field on the resulting object.
• name (string): Set the name field on the resulting object.
• zone_id (string): Set the zone_id field on the resulting object.

Returns:

• An attribute object that represents the alias sub block.

obj cidr_routing_policy

fn cidr_routing_policy.new

new()

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

Args:

• collection_id (string): Set the collection_id field on the resulting object.
• location_name (string): Set the location_name field on the resulting object.

Returns:

• An attribute object that represents the cidr_routing_policy sub block.

obj failover_routing_policy

fn failover_routing_policy.new

new()

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

Args:

• type (string): Set the type field on the resulting object.

Returns:

• An attribute object that represents the failover_routing_policy sub block.

obj geolocation_routing_policy

fn geolocation_routing_policy.new

new()

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

Args:

• continent (string): Set the continent field on the resulting object. When null, the continent field will be omitted from the resulting object.
• country (string): Set the country field on the resulting object. When null, the country field will be omitted from the resulting object.
• subdivision (string): Set the subdivision field on the resulting object. When null, the subdivision field will be omitted from the resulting object.

Returns:

• An attribute object that represents the geolocation_routing_policy sub block.

obj latency_routing_policy

fn latency_routing_policy.new

new()

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

Args:

• region (string): Set the region field on the resulting object.

Returns:

• An attribute object that represents the latency_routing_policy sub block.

obj weighted_routing_policy

fn weighted_routing_policy.new

new()

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

Args:

• weight (number): Set the weight field on the resulting object.

Returns:

• An attribute object that represents the weighted_routing_policy sub block.