Skip to content

Latest commit

 

History

History
206 lines (127 loc) · 7.55 KB

db_snapshot.md

File metadata and controls

206 lines (127 loc) · 7.55 KB
Raw
permalink
/data/db_snapshot/

data.db_snapshot

db_snapshot represents the aws_db_snapshot Terraform data source.

This package contains functions and utilities for setting up the data source using Jsonnet code.

Index

Fields

fn new

new()

aws.data.db_snapshot.new injects a new data_aws_db_snapshot 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.db_snapshot.new('some_id')

You can get the reference to the id field of the created aws.data.db_snapshot using the reference:

$._ref.data_aws_db_snapshot.some_id.get('id')

This is the same as directly entering "${ data_aws_db_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:

  • dataSrcLabel (string): The name label of the block.
  • db_instance_identifier (string): Set the db_instance_identifier field on the resulting data source block. When null, the db_instance_identifier field will be omitted from the resulting object.
  • db_snapshot_identifier (string): Set the db_snapshot_identifier field on the resulting data source block. When null, the db_snapshot_identifier field will be omitted from the resulting object.
  • include_public (bool): Set the include_public field on the resulting data source block. When null, the include_public field will be omitted from the resulting object.
  • include_shared (bool): Set the include_shared field on the resulting data source block. When null, the include_shared field will be omitted from the resulting object.
  • most_recent (bool): Set the most_recent field on the resulting data source block. When null, the most_recent field will be omitted from the resulting object.
  • snapshot_type (string): Set the snapshot_type field on the resulting data source block. When null, the snapshot_type field will be omitted from the resulting object.
  • tags (obj): Set the tags field on the resulting data source block. When null, the tags field will be omitted from the resulting object.

Returns:

  • A mixin object that injects the new data source into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.data.db_snapshot.newAttrs constructs a new object with attributes and blocks configured for the db_snapshot Terraform data source.

Unlike aws.data.db_snapshot.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:

  • db_instance_identifier (string): Set the db_instance_identifier field on the resulting object. When null, the db_instance_identifier field will be omitted from the resulting object.
  • db_snapshot_identifier (string): Set the db_snapshot_identifier field on the resulting object. When null, the db_snapshot_identifier field will be omitted from the resulting object.
  • include_public (bool): Set the include_public field on the resulting object. When null, the include_public field will be omitted from the resulting object.
  • include_shared (bool): Set the include_shared field on the resulting object. When null, the include_shared field will be omitted from the resulting object.
  • most_recent (bool): Set the most_recent field on the resulting object. When null, the most_recent field will be omitted from the resulting object.
  • snapshot_type (string): Set the snapshot_type field on the resulting object. When null, the snapshot_type field will be omitted from the resulting object.
  • tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.

Returns:

  • An attribute object that can be used with tf.withData to construct a new db_snapshot data source into the root Terraform configuration.

fn withDbInstanceIdentifier

withDbInstanceIdentifier()

aws.string.withDbInstanceIdentifier constructs a mixin object that can be merged into the string Terraform data source block to set or update the db_instance_identifier field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (string): The value to set for the db_instance_identifier field.

fn withDbSnapshotIdentifier

withDbSnapshotIdentifier()

aws.string.withDbSnapshotIdentifier constructs a mixin object that can be merged into the string Terraform data source block to set or update the db_snapshot_identifier field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (string): The value to set for the db_snapshot_identifier field.

fn withIncludePublic

withIncludePublic()

aws.bool.withIncludePublic constructs a mixin object that can be merged into the bool Terraform data source block to set or update the include_public field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (bool): The value to set for the include_public field.

fn withIncludeShared

withIncludeShared()

aws.bool.withIncludeShared constructs a mixin object that can be merged into the bool Terraform data source block to set or update the include_shared field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (bool): The value to set for the include_shared field.

fn withMostRecent

withMostRecent()

aws.bool.withMostRecent constructs a mixin object that can be merged into the bool Terraform data source block to set or update the most_recent field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (bool): The value to set for the most_recent field.

fn withSnapshotType

withSnapshotType()

aws.string.withSnapshotType constructs a mixin object that can be merged into the string Terraform data source block to set or update the snapshot_type field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (string): The value to set for the snapshot_type field.

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform data source block to set or update the tags field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (obj): The value to set for the tags field.