permalink |
---|
/data/docdb_engine_version/ |
docdb_engine_version
represents the aws_docdb_engine_version
Terraform data source.
This package contains functions and utilities for setting up the data source using Jsonnet code.
fn new()
fn newAttrs()
fn withEngine()
fn withParameterGroupFamily()
fn withPreferredVersions()
fn withVersion()
new()
aws.data.docdb_engine_version.new
injects a new data_aws_docdb_engine_version
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
aws.data.docdb_engine_version.new('some_id')
You can get the reference to the id
field of the created aws.data.docdb_engine_version
using the reference:
$._ref.data_aws_docdb_engine_version.some_id.get('id')
This is the same as directly entering "${ data_aws_docdb_engine_version.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.engine
(string
): Set theengine
field on the resulting data source block. Whennull
, theengine
field will be omitted from the resulting object.parameter_group_family
(string
): Set theparameter_group_family
field on the resulting data source block. Whennull
, theparameter_group_family
field will be omitted from the resulting object.preferred_versions
(list
): Set thepreferred_versions
field on the resulting data source block. Whennull
, thepreferred_versions
field will be omitted from the resulting object.version
(string
): Set theversion
field on the resulting data source block. Whennull
, theversion
field will be omitted from the resulting object.
Returns:
- A mixin object that injects the new data source into the root Terraform configuration.
newAttrs()
aws.data.docdb_engine_version.newAttrs
constructs a new object with attributes and blocks configured for the docdb_engine_version
Terraform data source.
Unlike aws.data.docdb_engine_version.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:
engine
(string
): Set theengine
field on the resulting object. Whennull
, theengine
field will be omitted from the resulting object.parameter_group_family
(string
): Set theparameter_group_family
field on the resulting object. Whennull
, theparameter_group_family
field will be omitted from the resulting object.preferred_versions
(list
): Set thepreferred_versions
field on the resulting object. Whennull
, thepreferred_versions
field will be omitted from the resulting object.version
(string
): Set theversion
field on the resulting object. Whennull
, theversion
field will be omitted from the resulting object.
Returns:
- An attribute object that can be used with tf.withData to construct a new
docdb_engine_version
data source into the root Terraform configuration.
withEngine()
aws.string.withEngine
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the engine field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for theengine
field.
withParameterGroupFamily()
aws.string.withParameterGroupFamily
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the parameter_group_family field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for theparameter_group_family
field.
withPreferredVersions()
aws.list.withPreferredVersions
constructs a mixin object that can be merged into the list
Terraform data source block to set or update the preferred_versions field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(list
): The value to set for thepreferred_versions
field.
withVersion()
aws.string.withVersion
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the version field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for theversion
field.