Skip to content

Latest commit

 

History

History
168 lines (103 loc) · 5.08 KB

apigatewayv2_model.md

File metadata and controls

168 lines (103 loc) · 5.08 KB
Raw
permalink
/apigatewayv2_model/

apigatewayv2_model

apigatewayv2_model represents the aws_apigatewayv2_model Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_apigatewayv2_model.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.
  • api_id (string): Set the api_id field on the resulting resource block.
  • content_type (string): Set the content_type field on the resulting resource 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.
  • schema (string): Set the schema field on the resulting resource block.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • api_id (string): Set the api_id field on the resulting object.
  • content_type (string): Set the content_type field on the resulting object.
  • 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.
  • schema (string): Set the schema field on the resulting object.

Returns:

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

fn withApiId

withApiId()

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

Args:

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

fn withContentType

withContentType()

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

Args:

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

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 withSchema

withSchema()

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

Args:

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