servicecatalog_provisioning_artifact.md

permalink
/servicecatalog_provisioning_artifact/

servicecatalog_provisioning_artifact

servicecatalog_provisioning_artifact represents the aws_servicecatalog_provisioning_artifact Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withAcceptLanguage()
• fn withActive()
• fn withDescription()
• fn withDisableTemplateValidation()
• fn withGuidance()
• fn withName()
• fn withProductId()
• fn withTemplatePhysicalId()
• fn withTemplateUrl()
• fn withTimeouts()
• fn withTimeoutsMixin()
• fn withType()
• obj timeouts
  • fn new()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_servicecatalog_provisioning_artifact.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.
• accept_language (string): Set the accept_language field on the resulting resource block. When null, the accept_language field will be omitted from the resulting object.
• active (bool): Set the active field on the resulting resource block. When null, the active 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.
• disable_template_validation (bool): Set the disable_template_validation field on the resulting resource block. When null, the disable_template_validation field will be omitted from the resulting object.
• guidance (string): Set the guidance field on the resulting resource block. When null, the guidance field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block. When null, the name field will be omitted from the resulting object.
• product_id (string): Set the product_id field on the resulting resource block.
• template_physical_id (string): Set the template_physical_id field on the resulting resource block. When null, the template_physical_id field will be omitted from the resulting object.
• template_url (string): Set the template_url field on the resulting resource block. When null, the template_url field will be omitted from the resulting object.
• type (string): Set the type field on the resulting resource block. When null, the type field will be omitted from the resulting object.
• timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.servicecatalog_provisioning_artifact.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

• accept_language (string): Set the accept_language field on the resulting object. When null, the accept_language field will be omitted from the resulting object.
• active (bool): Set the active field on the resulting object. When null, the active 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.
• disable_template_validation (bool): Set the disable_template_validation field on the resulting object. When null, the disable_template_validation field will be omitted from the resulting object.
• guidance (string): Set the guidance field on the resulting object. When null, the guidance field will be omitted from the resulting object.
• name (string): Set the name field on the resulting object. When null, the name field will be omitted from the resulting object.
• product_id (string): Set the product_id field on the resulting object.
• template_physical_id (string): Set the template_physical_id field on the resulting object. When null, the template_physical_id field will be omitted from the resulting object.
• template_url (string): Set the template_url field on the resulting object. When null, the template_url field will be omitted from the resulting object.
• type (string): Set the type field on the resulting object. When null, the type field will be omitted from the resulting object.
• timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.servicecatalog_provisioning_artifact.timeouts.new constructor.

Returns:

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

fn withAcceptLanguage

withAcceptLanguage()

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

Args:

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

fn withActive

withActive()

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

Args:

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

withDisableTemplateValidation()

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

Args:

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

fn withGuidance

withGuidance()

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

Args:

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

withProductId()

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

Args:

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

fn withTemplatePhysicalId

withTemplatePhysicalId()

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

Args:

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

fn withTemplateUrl

withTemplateUrl()

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

Args:

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

fn withTimeouts

withTimeouts()

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

Args:

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

fn withTimeoutsMixin

withTimeoutsMixin()

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

Args:

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

fn timeouts.new

new()

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

Args:

• create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
• delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.
• read (string): Set the read field on the resulting object. When null, the read field will be omitted from the resulting object.
• update (string): Set the update field on the resulting object. When null, the update field will be omitted from the resulting object.

Returns:

• An attribute object that represents the timeouts sub block.