permalink |
---|
/aws_network_peering/ |
aws_network_peering
represents the hcp_aws_network_peering
Terraform resource.
The AWS network peering resource allows you to manage a network peering between an HVN and a peer AWS VPC.
This package contains functions and utilities for setting up the resource using Jsonnet code.
fn new()
fn newAttrs()
fn withHvnId()
fn withPeerAccountId()
fn withPeerVpcId()
fn withPeerVpcRegion()
fn withPeeringId()
fn withProjectId()
fn withTimeouts()
fn withTimeoutsMixin()
obj timeouts
new()
hcp.aws_network_peering.new
injects a new hcp_aws_network_peering
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
hcp.aws_network_peering.new('some_id')
You can get the reference to the id
field of the created hcp.aws_network_peering
using the reference:
$._ref.hcp_aws_network_peering.some_id.get('id')
This is the same as directly entering "${ hcp_aws_network_peering.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.hvn_id
(string
): The ID of the HashiCorp Virtual Network (HVN).peer_account_id
(string
): The account ID of the peer VPC in AWS.peer_vpc_id
(string
): The ID of the peer VPC in AWS.peer_vpc_region
(string
): The region of the peer VPC in AWS.peering_id
(string
): The ID of the network peering.project_id
(string
): The ID of the HCP project where the network peering is located. Always matches the HVN's project. If not specified, the project specified in the HCP Provider config block will be used, if configured. If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. Whennull
, theproject_id
field will be omitted from the resulting object.timeouts
(obj
): Set thetimeouts
field on the resulting resource block. Whennull
, thetimeouts
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the hcp.aws_network_peering.timeouts.new constructor.
Returns:
- A mixin object that injects the new resource into the root Terraform configuration.
newAttrs()
hcp.aws_network_peering.newAttrs
constructs a new object with attributes and blocks configured for the aws_network_peering
Terraform resource.
Unlike hcp.aws_network_peering.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:
hvn_id
(string
): The ID of the HashiCorp Virtual Network (HVN).peer_account_id
(string
): The account ID of the peer VPC in AWS.peer_vpc_id
(string
): The ID of the peer VPC in AWS.peer_vpc_region
(string
): The region of the peer VPC in AWS.peering_id
(string
): The ID of the network peering.project_id
(string
): The ID of the HCP project where the network peering is located. Always matches the HVN's project. If not specified, the project specified in the HCP Provider config block will be used, if configured. If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. Whennull
, theproject_id
field will be omitted from the resulting object.timeouts
(obj
): Set thetimeouts
field on the resulting object. Whennull
, thetimeouts
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the hcp.aws_network_peering.timeouts.new constructor.
Returns:
- An attribute object that can be used with tf.withResource to construct a new
aws_network_peering
resource into the root Terraform configuration.
withHvnId()
hcp.string.withHvnId
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the hvn_id field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thehvn_id
field.
withPeerAccountId()
hcp.string.withPeerAccountId
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the peer_account_id field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thepeer_account_id
field.
withPeerVpcId()
hcp.string.withPeerVpcId
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the peer_vpc_id field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thepeer_vpc_id
field.
withPeerVpcRegion()
hcp.string.withPeerVpcRegion
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the peer_vpc_region field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thepeer_vpc_region
field.
withPeeringId()
hcp.string.withPeeringId
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the peering_id field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thepeering_id
field.
withProjectId()
hcp.string.withProjectId
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the project_id field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for theproject_id
field.
withTimeouts()
hcp.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 hcp.obj.withTimeoutsMixin function.
Args:
resourceLabel
(string
): The name label of the block to update.value
(obj
): The value to set for thetimeouts
field.
withTimeoutsMixin()
hcp.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 hcp.obj.withTimeouts
function.
Args:
resourceLabel
(string
): The name label of the block to update.value
(obj
): The value to set for thetimeouts
field.
new()
hcp.aws_network_peering.timeouts.new
constructs a new object with attributes and blocks configured for the timeouts
Terraform sub block.
Args:
create
(string
): Set thecreate
field on the resulting object. Whennull
, thecreate
field will be omitted from the resulting object.default
(string
): Set thedefault
field on the resulting object. Whennull
, thedefault
field will be omitted from the resulting object.delete
(string
): Set thedelete
field on the resulting object. Whennull
, thedelete
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
timeouts
sub block.