permalink |
---|
/consul_snapshot/ |
consul_snapshot
represents the hcp_consul_snapshot
Terraform resource.
The Consul snapshot resource allows users to manage Consul snapshots of an HCP Consul cluster. Snapshots currently have a retention policy of 30 days.
This package contains functions and utilities for setting up the resource using Jsonnet code.
fn new()
fn newAttrs()
fn withClusterId()
fn withProjectId()
fn withSnapshotName()
fn withTimeouts()
fn withTimeoutsMixin()
obj timeouts
new()
hcp.consul_snapshot.new
injects a new hcp_consul_snapshot
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.consul_snapshot.new('some_id')
You can get the reference to the id
field of the created hcp.consul_snapshot
using the reference:
$._ref.hcp_consul_snapshot.some_id.get('id')
This is the same as directly entering "${ hcp_consul_snapshot.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.cluster_id
(string
): The ID of the HCP Consul cluster.project_id
(string
): The ID of the HCP project where the HCP Consul cluster 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.snapshot_name
(string
): The name of the snapshot.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.consul_snapshot.timeouts.new constructor.
Returns:
- A mixin object that injects the new resource into the root Terraform configuration.
newAttrs()
hcp.consul_snapshot.newAttrs
constructs a new object with attributes and blocks configured for the consul_snapshot
Terraform resource.
Unlike hcp.consul_snapshot.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:
cluster_id
(string
): The ID of the HCP Consul cluster.project_id
(string
): The ID of the HCP project where the HCP Consul cluster 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.snapshot_name
(string
): The name of the snapshot.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.consul_snapshot.timeouts.new constructor.
Returns:
- An attribute object that can be used with tf.withResource to construct a new
consul_snapshot
resource into the root Terraform configuration.
withClusterId()
hcp.string.withClusterId
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the cluster_id field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thecluster_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.
withSnapshotName()
hcp.string.withSnapshotName
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the snapshot_name field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thesnapshot_name
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.consul_snapshot.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.update
(string
): Set theupdate
field on the resulting object. Whennull
, theupdate
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
timeouts
sub block.