Skip to content

Latest commit

 

History

History
215 lines (132 loc) · 7.86 KB

opensearchserverless_collection.md

File metadata and controls

215 lines (132 loc) · 7.86 KB
Raw
permalink
/opensearchserverless_collection/

opensearchserverless_collection

opensearchserverless_collection represents the aws_opensearchserverless_collection Terraform resource.

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

Index

Fields

fn new

new()

aws.opensearchserverless_collection.new injects a new aws_opensearchserverless_collection 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
aws.opensearchserverless_collection.new('some_id')

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

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

This is the same as directly entering "${ aws_opensearchserverless_collection.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.
  • description (string): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
  • name (string): Set the name field on the resulting resource block.
  • tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
  • type (string): Set the type field on the resulting resource block. When null, the type field will be omitted from the resulting object.
  • timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.opensearchserverless_collection.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

aws.opensearchserverless_collection.newAttrs constructs a new object with attributes and blocks configured for the opensearchserverless_collection Terraform resource.

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

  • description (string): Set the description field on the resulting object. When null, the description field will be omitted from the resulting object.
  • name (string): Set the name field on 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.
  • type (string): Set the type field on the resulting object. When null, the type field will be omitted from the resulting object.
  • timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.opensearchserverless_collection.timeouts.new constructor.

Returns:

  • An attribute object that can be used with tf.withResource to construct a new opensearchserverless_collection resource into the root Terraform configuration.

fn withDescription

withDescription()

aws.string.withDescription constructs a mixin object that can be merged into the string Terraform resource block to set or update the description field.

Args:

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

fn withName

withName()

aws.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

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

fn withTags

withTags()

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

Args:

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

fn withTimeouts

withTimeouts()

aws.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 aws.obj.withTimeoutsMixin function.

Args:

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

fn withTimeoutsMixin

withTimeoutsMixin()

aws.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 aws.obj.withTimeouts function.

Args:

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

fn withType

withType()

aws.string.withType constructs a mixin object that can be merged into the string Terraform resource block to set or update the type field.

Args:

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

obj timeouts

fn timeouts.new

new()

aws.opensearchserverless_collection.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

  • create (string): A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When null, the create field will be omitted from the resulting object.
  • delete (string): A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When null, the delete field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the timeouts sub block.