Skip to content

Latest commit

 

History

History
187 lines (115 loc) · 6.18 KB

appsync_api_cache.md

File metadata and controls

187 lines (115 loc) · 6.18 KB
Raw
permalink
/appsync_api_cache/

appsync_api_cache

appsync_api_cache represents the aws_appsync_api_cache Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_appsync_api_cache.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_caching_behavior (string): Set the api_caching_behavior field on the resulting resource block.
  • api_id (string): Set the api_id field on the resulting resource block.
  • at_rest_encryption_enabled (bool): Set the at_rest_encryption_enabled field on the resulting resource block. When null, the at_rest_encryption_enabled field will be omitted from the resulting object.
  • transit_encryption_enabled (bool): Set the transit_encryption_enabled field on the resulting resource block. When null, the transit_encryption_enabled field will be omitted from the resulting object.
  • ttl (number): Set the ttl field on the resulting resource block.
  • type (string): Set the type field on the resulting resource block.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.appsync_api_cache.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_caching_behavior (string): Set the api_caching_behavior field on the resulting object.
  • api_id (string): Set the api_id field on the resulting object.
  • at_rest_encryption_enabled (bool): Set the at_rest_encryption_enabled field on the resulting object. When null, the at_rest_encryption_enabled field will be omitted from the resulting object.
  • transit_encryption_enabled (bool): Set the transit_encryption_enabled field on the resulting object. When null, the transit_encryption_enabled field will be omitted from the resulting object.
  • ttl (number): Set the ttl field on the resulting object.
  • type (string): Set the type field on the resulting object.

Returns:

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

fn withApiCachingBehavior

withApiCachingBehavior()

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

Args:

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

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 withAtRestEncryptionEnabled

withAtRestEncryptionEnabled()

aws.bool.withAtRestEncryptionEnabled constructs a mixin object that can be merged into the bool Terraform resource block to set or update the at_rest_encryption_enabled field.

Args:

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

fn withTransitEncryptionEnabled

withTransitEncryptionEnabled()

aws.bool.withTransitEncryptionEnabled constructs a mixin object that can be merged into the bool Terraform resource block to set or update the transit_encryption_enabled field.

Args:

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

fn withTtl

withTtl()

aws.number.withTtl constructs a mixin object that can be merged into the number Terraform resource block to set or update the ttl field.

Args:

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