Skip to content

Latest commit

 

History

History
235 lines (144 loc) · 8.56 KB

config_conformance_pack.md

File metadata and controls

235 lines (144 loc) · 8.56 KB
Raw
permalink
/config_conformance_pack/

config_conformance_pack

config_conformance_pack represents the aws_config_conformance_pack Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_config_conformance_pack.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.
  • delivery_s3_bucket (string): Set the delivery_s3_bucket field on the resulting resource block. When null, the delivery_s3_bucket field will be omitted from the resulting object.
  • delivery_s3_key_prefix (string): Set the delivery_s3_key_prefix field on the resulting resource block. When null, the delivery_s3_key_prefix field will be omitted from the resulting object.
  • name (string): Set the name field on the resulting resource block.
  • template_body (string): Set the template_body field on the resulting resource block. When null, the template_body field will be omitted from the resulting object.
  • template_s3_uri (string): Set the template_s3_uri field on the resulting resource block. When null, the template_s3_uri field will be omitted from the resulting object.
  • input_parameter (list[obj]): Set the input_parameter field on the resulting resource block. When null, the input_parameter sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.config_conformance_pack.input_parameter.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • delivery_s3_bucket (string): Set the delivery_s3_bucket field on the resulting object. When null, the delivery_s3_bucket field will be omitted from the resulting object.
  • delivery_s3_key_prefix (string): Set the delivery_s3_key_prefix field on the resulting object. When null, the delivery_s3_key_prefix field will be omitted from the resulting object.
  • name (string): Set the name field on the resulting object.
  • template_body (string): Set the template_body field on the resulting object. When null, the template_body field will be omitted from the resulting object.
  • template_s3_uri (string): Set the template_s3_uri field on the resulting object. When null, the template_s3_uri field will be omitted from the resulting object.
  • input_parameter (list[obj]): Set the input_parameter field on the resulting object. When null, the input_parameter sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.config_conformance_pack.input_parameter.new constructor.

Returns:

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

fn withDeliveryS3Bucket

withDeliveryS3Bucket()

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

Args:

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

fn withDeliveryS3KeyPrefix

withDeliveryS3KeyPrefix()

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

Args:

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

fn withInputParameter

withInputParameter()

aws.list[obj].withInputParameter constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the input_parameter field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withInputParameterMixin function.

Args:

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

fn withInputParameterMixin

withInputParameterMixin()

aws.list[obj].withInputParameterMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the input_parameter field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withInputParameter function.

Args:

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

withTemplateBody()

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

Args:

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

fn withTemplateS3Uri

withTemplateS3Uri()

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

Args:

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

obj input_parameter

fn input_parameter.new

new()

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

Args:

  • parameter_name (string): Set the parameter_name field on the resulting object.
  • parameter_value (string): Set the parameter_value field on the resulting object.

Returns:

  • An attribute object that represents the input_parameter sub block.