permalink |
---|
/data/aws_transit_gateway_attachment/ |
aws_transit_gateway_attachment
represents the hcp_aws_transit_gateway_attachment
Terraform data source.
The AWS transit gateway attachment data source provides information about an existing transit gateway attachment.
This package contains functions and utilities for setting up the data source using Jsonnet code.
fn new()
fn newAttrs()
fn withHvnId()
fn withProjectId()
fn withTimeouts()
fn withTimeoutsMixin()
fn withTransitGatewayAttachmentId()
fn withWaitForActiveState()
obj timeouts
new()
hcp.data.aws_transit_gateway_attachment.new
injects a new data_hcp_aws_transit_gateway_attachment
Terraform data source
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.data.aws_transit_gateway_attachment.new('some_id')
You can get the reference to the id
field of the created hcp.data.aws_transit_gateway_attachment
using the reference:
$._ref.data_hcp_aws_transit_gateway_attachment.some_id.get('id')
This is the same as directly entering "${ data_hcp_aws_transit_gateway_attachment.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:
dataSrcLabel
(string
): The name label of the block.hvn_id
(string
): The ID of the HashiCorp Virtual Network (HVN).project_id
(string
): The ID of the HCP project where the transit gateway attachment is located. 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.transit_gateway_attachment_id
(string
): The user-settable name of the transit gateway attachment in HCP.wait_for_active_state
(bool
): Iftrue
, Terraform will wait for the transit gateway attachment to reach anACTIVE
state before continuing. Defaultfalse
. Whennull
, thewait_for_active_state
field will be omitted from the resulting object.timeouts
(obj
): Set thetimeouts
field on the resulting data source 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.data.aws_transit_gateway_attachment.timeouts.new constructor.
Returns:
- A mixin object that injects the new data source into the root Terraform configuration.
newAttrs()
hcp.data.aws_transit_gateway_attachment.newAttrs
constructs a new object with attributes and blocks configured for the aws_transit_gateway_attachment
Terraform data source.
Unlike hcp.data.aws_transit_gateway_attachment.new, this function will not inject the data source
block into the root Terraform document. Instead, this must be passed in as the attrs
argument for the
tf.withData 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).project_id
(string
): The ID of the HCP project where the transit gateway attachment is located. 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.transit_gateway_attachment_id
(string
): The user-settable name of the transit gateway attachment in HCP.wait_for_active_state
(bool
): Iftrue
, Terraform will wait for the transit gateway attachment to reach anACTIVE
state before continuing. Defaultfalse
. Whennull
, thewait_for_active_state
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.data.aws_transit_gateway_attachment.timeouts.new constructor.
Returns:
- An attribute object that can be used with tf.withData to construct a new
aws_transit_gateway_attachment
data source into the root Terraform configuration.
withHvnId()
hcp.string.withHvnId
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the hvn_id field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for thehvn_id
field.
withProjectId()
hcp.string.withProjectId
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the project_id field.
Args:
dataSrcLabel
(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 data source 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:
dataSrcLabel
(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 data source 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:
dataSrcLabel
(string
): The name label of the block to update.value
(obj
): The value to set for thetimeouts
field.
withTransitGatewayAttachmentId()
hcp.string.withTransitGatewayAttachmentId
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the transit_gateway_attachment_id field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for thetransit_gateway_attachment_id
field.
withWaitForActiveState()
hcp.bool.withWaitForActiveState
constructs a mixin object that can be merged into the bool
Terraform data source block to set or update the wait_for_active_state field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(bool
): The value to set for thewait_for_active_state
field.
new()
hcp.aws_transit_gateway_attachment.timeouts.new
constructs a new object with attributes and blocks configured for the timeouts
Terraform sub block.
Args:
default
(string
): Set thedefault
field on the resulting object. Whennull
, thedefault
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
timeouts
sub block.