Skip to content

Latest commit

 

History

History
206 lines (127 loc) · 6.91 KB

transfer_certificate.md

File metadata and controls

206 lines (127 loc) · 6.91 KB
Raw
permalink
/transfer_certificate/

transfer_certificate

transfer_certificate represents the aws_transfer_certificate Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_transfer_certificate.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.
  • certificate (string): Set the certificate field on the resulting resource block.
  • certificate_chain (string): Set the certificate_chain field on the resulting resource block. When null, the certificate_chain field will be omitted from the resulting object.
  • description (string): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
  • private_key (string): Set the private_key field on the resulting resource block. When null, the private_key field will be omitted from the resulting object.
  • tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
  • tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
  • usage (string): Set the usage field on the resulting resource block.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • certificate (string): Set the certificate field on the resulting object.
  • certificate_chain (string): Set the certificate_chain field on the resulting object. When null, the certificate_chain field will be omitted from 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.
  • private_key (string): Set the private_key field on the resulting object. When null, the private_key field will be omitted from 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.
  • tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
  • usage (string): Set the usage field on the resulting object.

Returns:

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

fn withCertificate

withCertificate()

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

Args:

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

fn withCertificateChain

withCertificateChain()

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

Args:

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

withPrivateKey()

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

Args:

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

withTagsAll()

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

Args:

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

fn withUsage

withUsage()

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

Args:

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