permalink |
---|
/data/ssm_document/ |
ssm_document
represents the aws_ssm_document
Terraform data source.
This package contains functions and utilities for setting up the data source using Jsonnet code.
new()
aws.data.ssm_document.new
injects a new data_aws_ssm_document
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.ssm_document.new('some_id')
You can get the reference to the id
field of the created aws.data.ssm_document
using the reference:
$._ref.data_aws_ssm_document.some_id.get('id')
This is the same as directly entering "${ data_aws_ssm_document.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.document_format
(string
): Set thedocument_format
field on the resulting data source block. Whennull
, thedocument_format
field will be omitted from the resulting object.document_version
(string
): Set thedocument_version
field on the resulting data source block. Whennull
, thedocument_version
field will be omitted from the resulting object.name
(string
): Set thename
field on the resulting data source block.
Returns:
- A mixin object that injects the new data source into the root Terraform configuration.
newAttrs()
aws.data.ssm_document.newAttrs
constructs a new object with attributes and blocks configured for the ssm_document
Terraform data source.
Unlike aws.data.ssm_document.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:
document_format
(string
): Set thedocument_format
field on the resulting object. Whennull
, thedocument_format
field will be omitted from the resulting object.document_version
(string
): Set thedocument_version
field on the resulting object. Whennull
, thedocument_version
field will be omitted from the resulting object.name
(string
): Set thename
field on the resulting object.
Returns:
- An attribute object that can be used with tf.withData to construct a new
ssm_document
data source into the root Terraform configuration.
withDocumentFormat()
aws.string.withDocumentFormat
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the document_format field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for thedocument_format
field.
withDocumentVersion()
aws.string.withDocumentVersion
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the document_version field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for thedocument_version
field.
withName()
aws.string.withName
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the name field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for thename
field.