Skip to content

Latest commit

 

History

History
198 lines (122 loc) · 7.06 KB

opensearchserverless_security_config.md

File metadata and controls

198 lines (122 loc) · 7.06 KB
Raw
permalink
/opensearchserverless_security_config/

opensearchserverless_security_config

opensearchserverless_security_config represents the aws_opensearchserverless_security_config Terraform resource.

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

Index

Fields

fn new

new()

aws.opensearchserverless_security_config.new injects a new aws_opensearchserverless_security_config 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_security_config.new('some_id')

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

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

This is the same as directly entering "${ aws_opensearchserverless_security_config.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.
  • type (string): Set the type field on the resulting resource block.
  • saml_options (obj): Set the saml_options field on the resulting resource block. When null, the saml_options 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_security_config.saml_options.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.opensearchserverless_security_config.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.
  • type (string): Set the type field on the resulting object.
  • saml_options (obj): Set the saml_options field on the resulting object. When null, the saml_options 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_security_config.saml_options.new constructor.

Returns:

  • An attribute object that can be used with tf.withResource to construct a new opensearchserverless_security_config 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 withSamlOptions

withSamlOptions()

aws.obj.withSamlOptions constructs a mixin object that can be merged into the obj Terraform resource block to set or update the saml_options 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.withSamlOptionsMixin function.

Args:

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

fn withSamlOptionsMixin

withSamlOptionsMixin()

aws.obj.withSamlOptionsMixin constructs a mixin object that can be merged into the obj Terraform resource block to set or update the saml_options 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.withSamlOptions function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the saml_options 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 saml_options

fn saml_options.new

new()

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

Args:

  • group_attribute (string): Set the group_attribute field on the resulting object. When null, the group_attribute field will be omitted from the resulting object.
  • metadata (string): Set the metadata field on the resulting object.
  • session_timeout (number): Set the session_timeout field on the resulting object. When null, the session_timeout field will be omitted from the resulting object.
  • user_attribute (string): Set the user_attribute field on the resulting object. When null, the user_attribute field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the saml_options sub block.