diff --git a/0.x/_gen/data/main.libsonnet b/0.x/_gen/data/main.libsonnet index 716493a..4ec912d 100644 --- a/0.x/_gen/data/main.libsonnet +++ b/0.x/_gen/data/main.libsonnet @@ -14,10 +14,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); hvn_route: (import 'hvn_route.libsonnet'), iam_policy: (import 'iam_policy.libsonnet'), organization: (import 'organization.libsonnet'), + packer_artifact: (import 'packer_artifact.libsonnet'), packer_bucket_names: (import 'packer_bucket_names.libsonnet'), packer_image: (import 'packer_image.libsonnet'), packer_iteration: (import 'packer_iteration.libsonnet'), packer_run_task: (import 'packer_run_task.libsonnet'), + packer_version: (import 'packer_version.libsonnet'), project: (import 'project.libsonnet'), service_principal: (import 'service_principal.libsonnet'), vault_cluster: (import 'vault_cluster.libsonnet'), diff --git a/0.x/_gen/data/packer_artifact.libsonnet b/0.x/_gen/data/packer_artifact.libsonnet new file mode 100644 index 0000000..f627f47 --- /dev/null +++ b/0.x/_gen/data/packer_artifact.libsonnet @@ -0,0 +1,118 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='packer_artifact', url='', help='`packer_artifact` represents the `hcp_packer_artifact` Terraform data source.\n\nThe HCP Packer Artifact data source retrieves information about an Artifact.\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`hcp.data.packer_artifact.new` injects a new `data_hcp_packer_artifact` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n hcp.data.packer_artifact.new('some_id')\n\nYou can get the reference to the `id` field of the created `hcp.data.packer_artifact` using the reference:\n\n $._ref.data_hcp_packer_artifact.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_hcp_packer_artifact.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `bucket_name` (`string`): The name of the HCP Packer Bucket where the Artifact is located.\n - `channel_name` (`string`): \nThe name of the HCP Packer Channel the Version containing this Artifact is assigned to.\nThe Version currently assigned to the Channel will be fetched. \nExactly one of `channel_name` or `version_fingerprint` must be provided. When `null`, the `channel_name` field will be omitted from the resulting object.\n - `component_type` (`string`): Name of the Packer builder that built this Artifact. Ex: `amazon-ebs.example`. When `null`, the `component_type` field will be omitted from the resulting object.\n - `platform` (`string`): Name of the platform where the HCP Packer Artifact is stored.\n - `project_id` (`string`): The ID of the HCP Organization where the Artifact is located When `null`, the `project_id` field will be omitted from the resulting object.\n - `region` (`string`): The Region where the HCP Packer Artifact is stored, if any.\n - `version_fingerprint` (`string`): \nThe fingerprint of the HCP Packer Version where the Artifact is located. \nIf provided in the config, it is used to fetch the Version.\nExactly one of `channel_name` or `version_fingerprint` must be provided. When `null`, the `version_fingerprint` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + bucket_name, + platform, + region, + channel_name=null, + component_type=null, + project_id=null, + version_fingerprint=null, + _meta={} + ):: tf.withData( + type='hcp_packer_artifact', + label=dataSrcLabel, + attrs=self.newAttrs( + bucket_name=bucket_name, + channel_name=channel_name, + component_type=component_type, + platform=platform, + project_id=project_id, + region=region, + version_fingerprint=version_fingerprint + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`hcp.data.packer_artifact.newAttrs` constructs a new object with attributes and blocks configured for the `packer_artifact`\nTerraform data source.\n\nUnlike [hcp.data.packer_artifact.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket_name` (`string`): The name of the HCP Packer Bucket where the Artifact is located.\n - `channel_name` (`string`): \nThe name of the HCP Packer Channel the Version containing this Artifact is assigned to.\nThe Version currently assigned to the Channel will be fetched. \nExactly one of `channel_name` or `version_fingerprint` must be provided. When `null`, the `channel_name` field will be omitted from the resulting object.\n - `component_type` (`string`): Name of the Packer builder that built this Artifact. Ex: `amazon-ebs.example`. When `null`, the `component_type` field will be omitted from the resulting object.\n - `platform` (`string`): Name of the platform where the HCP Packer Artifact is stored.\n - `project_id` (`string`): The ID of the HCP Organization where the Artifact is located When `null`, the `project_id` field will be omitted from the resulting object.\n - `region` (`string`): The Region where the HCP Packer Artifact is stored, if any.\n - `version_fingerprint` (`string`): \nThe fingerprint of the HCP Packer Version where the Artifact is located. \nIf provided in the config, it is used to fetch the Version.\nExactly one of `channel_name` or `version_fingerprint` must be provided. When `null`, the `version_fingerprint` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `packer_artifact` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + bucket_name, + platform, + region, + channel_name=null, + component_type=null, + project_id=null, + version_fingerprint=null + ):: std.prune(a={ + bucket_name: bucket_name, + channel_name: channel_name, + component_type: component_type, + platform: platform, + project_id: project_id, + region: region, + version_fingerprint: version_fingerprint, + }), + '#withBucketName':: d.fn(help='`hcp.string.withBucketName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the bucket_name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `bucket_name` field.\n', args=[]), + withBucketName(dataSrcLabel, value): { + data+: { + hcp_packer_artifact+: { + [dataSrcLabel]+: { + bucket_name: value, + }, + }, + }, + }, + '#withChannelName':: d.fn(help='`hcp.string.withChannelName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the channel_name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `channel_name` field.\n', args=[]), + withChannelName(dataSrcLabel, value): { + data+: { + hcp_packer_artifact+: { + [dataSrcLabel]+: { + channel_name: value, + }, + }, + }, + }, + '#withComponentType':: d.fn(help='`hcp.string.withComponentType` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the component_type field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `component_type` field.\n', args=[]), + withComponentType(dataSrcLabel, value): { + data+: { + hcp_packer_artifact+: { + [dataSrcLabel]+: { + component_type: value, + }, + }, + }, + }, + '#withPlatform':: d.fn(help='`hcp.string.withPlatform` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the platform field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `platform` field.\n', args=[]), + withPlatform(dataSrcLabel, value): { + data+: { + hcp_packer_artifact+: { + [dataSrcLabel]+: { + platform: value, + }, + }, + }, + }, + '#withProjectId':: d.fn(help='`hcp.string.withProjectId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the project_id field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project_id` field.\n', args=[]), + withProjectId(dataSrcLabel, value): { + data+: { + hcp_packer_artifact+: { + [dataSrcLabel]+: { + project_id: value, + }, + }, + }, + }, + '#withRegion':: d.fn(help='`hcp.string.withRegion` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the region field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `region` field.\n', args=[]), + withRegion(dataSrcLabel, value): { + data+: { + hcp_packer_artifact+: { + [dataSrcLabel]+: { + region: value, + }, + }, + }, + }, + '#withVersionFingerprint':: d.fn(help='`hcp.string.withVersionFingerprint` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the version_fingerprint field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `version_fingerprint` field.\n', args=[]), + withVersionFingerprint(dataSrcLabel, value): { + data+: { + hcp_packer_artifact+: { + [dataSrcLabel]+: { + version_fingerprint: value, + }, + }, + }, + }, +} diff --git a/0.x/_gen/data/packer_version.libsonnet b/0.x/_gen/data/packer_version.libsonnet new file mode 100644 index 0000000..042fd9b --- /dev/null +++ b/0.x/_gen/data/packer_version.libsonnet @@ -0,0 +1,58 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='packer_version', url='', help='`packer_version` represents the `hcp_packer_version` Terraform data source.\n\nThe HCP Packer Version data source retrieves information about a Version.\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`hcp.data.packer_version.new` injects a new `data_hcp_packer_version` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n hcp.data.packer_version.new('some_id')\n\nYou can get the reference to the `id` field of the created `hcp.data.packer_version` using the reference:\n\n $._ref.data_hcp_packer_version.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_hcp_packer_version.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `bucket_name` (`string`): The name of the HCP Packer Bucket where the Version is located\n - `channel_name` (`string`): \nThe name of the HCP Packer Channel the Version is assigned to.\nThe version currently assigned to the Channel will be fetched.\n - `project_id` (`string`): The ID of the HCP Organization where the Version is located When `null`, the `project_id` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + bucket_name, + channel_name, + project_id=null, + _meta={} + ):: tf.withData( + type='hcp_packer_version', + label=dataSrcLabel, + attrs=self.newAttrs(bucket_name=bucket_name, channel_name=channel_name, project_id=project_id), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`hcp.data.packer_version.newAttrs` constructs a new object with attributes and blocks configured for the `packer_version`\nTerraform data source.\n\nUnlike [hcp.data.packer_version.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket_name` (`string`): The name of the HCP Packer Bucket where the Version is located\n - `channel_name` (`string`): \nThe name of the HCP Packer Channel the Version is assigned to.\nThe version currently assigned to the Channel will be fetched.\n - `project_id` (`string`): The ID of the HCP Organization where the Version is located When `null`, the `project_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `packer_version` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + bucket_name, + channel_name, + project_id=null + ):: std.prune(a={ + bucket_name: bucket_name, + channel_name: channel_name, + project_id: project_id, + }), + '#withBucketName':: d.fn(help='`hcp.string.withBucketName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the bucket_name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `bucket_name` field.\n', args=[]), + withBucketName(dataSrcLabel, value): { + data+: { + hcp_packer_version+: { + [dataSrcLabel]+: { + bucket_name: value, + }, + }, + }, + }, + '#withChannelName':: d.fn(help='`hcp.string.withChannelName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the channel_name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `channel_name` field.\n', args=[]), + withChannelName(dataSrcLabel, value): { + data+: { + hcp_packer_version+: { + [dataSrcLabel]+: { + channel_name: value, + }, + }, + }, + }, + '#withProjectId':: d.fn(help='`hcp.string.withProjectId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the project_id field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project_id` field.\n', args=[]), + withProjectId(dataSrcLabel, value): { + data+: { + hcp_packer_version+: { + [dataSrcLabel]+: { + project_id: value, + }, + }, + }, + }, +} diff --git a/0.x/_gen/main.libsonnet b/0.x/_gen/main.libsonnet index 7f576cc..4f55f70 100644 --- a/0.x/_gen/main.libsonnet +++ b/0.x/_gen/main.libsonnet @@ -14,6 +14,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); hvn_route: (import 'resources/hvn_route.libsonnet'), iam_workload_identity_provider: (import 'resources/iam_workload_identity_provider.libsonnet'), log_streaming_destination: (import 'resources/log_streaming_destination.libsonnet'), + notifications_webhook: (import 'resources/notifications_webhook.libsonnet'), organization_iam_binding: (import 'resources/organization_iam_binding.libsonnet'), organization_iam_policy: (import 'resources/organization_iam_policy.libsonnet'), packer_channel: (import 'resources/packer_channel.libsonnet'), diff --git a/0.x/_gen/resources/notifications_webhook.libsonnet b/0.x/_gen/resources/notifications_webhook.libsonnet new file mode 100644 index 0000000..7899300 --- /dev/null +++ b/0.x/_gen/resources/notifications_webhook.libsonnet @@ -0,0 +1,124 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='notifications_webhook', url='', help='`notifications_webhook` represents the `hcp_notifications_webhook` Terraform resource.\n\nThe webhook resource manages a HCP webhook, used to notify external systems about a project resource's lifecycle events\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`hcp.notifications_webhook.new` injects a new `hcp_notifications_webhook` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n hcp.notifications_webhook.new('some_id')\n\nYou can get the reference to the `id` field of the created `hcp.notifications_webhook` using the reference:\n\n $._ref.hcp_notifications_webhook.some_id.get('id')\n\nThis is the same as directly entering `\"${ hcp_notifications_webhook.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `config` (`obj`): The webhook configuration used to deliver event payloads.\n - `description` (`string`): The webhook\u0026#39;s description. Descriptions are useful for helping others understand the purpose of the webhook. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Indicates if the webhook should receive payloads for the subscribed events. Defaults to `true`. When `null`, the `enabled` field will be omitted from the resulting object.\n - `name` (`string`): The webhook\u0026#39;s name.\n - `project_id` (`string`): The ID of the project to create the webhook under. If unspecified, the webhook will be created in the project the provider is configured with. When `null`, the `project_id` field will be omitted from the resulting object.\n - `subscriptions` (`list[obj]`): Set of events to subscribe the webhook to all resources or a specific resource in the project. When `null`, the `subscriptions` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + config, + name, + description=null, + enabled=null, + project_id=null, + subscriptions=null, + _meta={} + ):: tf.withResource( + type='hcp_notifications_webhook', + label=resourceLabel, + attrs=self.newAttrs( + config=config, + description=description, + enabled=enabled, + name=name, + project_id=project_id, + subscriptions=subscriptions + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`hcp.notifications_webhook.newAttrs` constructs a new object with attributes and blocks configured for the `notifications_webhook`\nTerraform resource.\n\nUnlike [hcp.notifications_webhook.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `config` (`obj`): The webhook configuration used to deliver event payloads.\n - `description` (`string`): The webhook's description. Descriptions are useful for helping others understand the purpose of the webhook. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Indicates if the webhook should receive payloads for the subscribed events. Defaults to `true`. When `null`, the `enabled` field will be omitted from the resulting object.\n - `name` (`string`): The webhook's name.\n - `project_id` (`string`): The ID of the project to create the webhook under. If unspecified, the webhook will be created in the project the provider is configured with. When `null`, the `project_id` field will be omitted from the resulting object.\n - `subscriptions` (`list[obj]`): Set of events to subscribe the webhook to all resources or a specific resource in the project. When `null`, the `subscriptions` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `notifications_webhook` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + config, + name, + description=null, + enabled=null, + project_id=null, + subscriptions=null + ):: std.prune(a={ + config: config, + description: description, + enabled: enabled, + name: name, + project_id: project_id, + subscriptions: subscriptions, + }), + '#withConfig':: d.fn(help='`hcp.obj.withConfig` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the config field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `config` field.\n', args=[]), + withConfig(resourceLabel, value): { + resource+: { + hcp_notifications_webhook+: { + [resourceLabel]+: { + config: value, + }, + }, + }, + }, + '#withConfigMixin':: d.fn(help='`hcp.obj.withConfigMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the config field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [hcp.obj.withConfig](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `config` field.\n', args=[]), + withConfigMixin(resourceLabel, value):: { + resource+: { + hcp_notifications_webhook+: { + [resourceLabel]+: { + config+: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`hcp.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + hcp_notifications_webhook+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withEnabled':: d.fn(help='`hcp.bool.withEnabled` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the enabled field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `enabled` field.\n', args=[]), + withEnabled(resourceLabel, value): { + resource+: { + hcp_notifications_webhook+: { + [resourceLabel]+: { + enabled: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`hcp.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + hcp_notifications_webhook+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProjectId':: d.fn(help='`hcp.string.withProjectId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project_id` field.\n', args=[]), + withProjectId(resourceLabel, value): { + resource+: { + hcp_notifications_webhook+: { + [resourceLabel]+: { + project_id: value, + }, + }, + }, + }, + '#withSubscriptions':: d.fn(help='`hcp.list[obj].withSubscriptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the subscriptions field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `subscriptions` field.\n', args=[]), + withSubscriptions(resourceLabel, value): { + resource+: { + hcp_notifications_webhook+: { + [resourceLabel]+: { + subscriptions: value, + }, + }, + }, + }, + '#withSubscriptionsMixin':: d.fn(help='`hcp.list[obj].withSubscriptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the subscriptions field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [hcp.list[obj].withSubscriptions](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `subscriptions` field.\n', args=[]), + withSubscriptionsMixin(resourceLabel, value):: { + resource+: { + hcp_notifications_webhook+: { + [resourceLabel]+: { + subscriptions+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, +} diff --git a/0.x/_gen/resources/packer_channel.libsonnet b/0.x/_gen/resources/packer_channel.libsonnet index 310f42a..7309f3c 100644 --- a/0.x/_gen/resources/packer_channel.libsonnet +++ b/0.x/_gen/resources/packer_channel.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='packer_channel', url='', help='`packer_channel` represents the `hcp_packer_channel` Terraform resource.\n\nThe Packer Channel resource allows you to manage a bucket channel within an active HCP Packer Registry.\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`hcp.packer_channel.new` injects a new `hcp_packer_channel` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n hcp.packer_channel.new('some_id')\n\nYou can get the reference to the `id` field of the created `hcp.packer_channel` using the reference:\n\n $._ref.hcp_packer_channel.some_id.get('id')\n\nThis is the same as directly entering `\"${ hcp_packer_channel.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `bucket_name` (`string`): The slug of the HCP Packer Registry bucket where the channel should be created.\n - `name` (`string`): The name of the channel being managed.\n - `project_id` (`string`): \nThe ID of the HCP project where this channel is located. \nIf not specified, the project specified in the HCP Provider config block will be used, if configured.\nIf a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object.\n - `restricted` (`bool`): If true, the channel is only visible to users with permission to create and manage it. If false, the channel is visible to every member of the organization. When `null`, the `restricted` field will be omitted from the resulting object.\n - `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 [hcp.packer_channel.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`hcp.packer_channel.new` injects a new `hcp_packer_channel` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n hcp.packer_channel.new('some_id')\n\nYou can get the reference to the `id` field of the created `hcp.packer_channel` using the reference:\n\n $._ref.hcp_packer_channel.some_id.get('id')\n\nThis is the same as directly entering `\"${ hcp_packer_channel.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `bucket_name` (`string`): The name of the HCP Packer Registry bucket where the channel should be created.\n - `name` (`string`): The name of the channel being managed.\n - `project_id` (`string`): \nThe ID of the HCP project where this channel is located. \nIf not specified, the project specified in the HCP Provider config block will be used, if configured.\nIf a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object.\n - `restricted` (`bool`): If true, the channel is only visible to users with permission to create and manage it. If false, the channel is visible to every member of the organization. When `null`, the `restricted` field will be omitted from the resulting object.\n - `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 [hcp.packer_channel.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, bucket_name, @@ -23,7 +23,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`hcp.packer_channel.newAttrs` constructs a new object with attributes and blocks configured for the `packer_channel`\nTerraform resource.\n\nUnlike [hcp.packer_channel.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket_name` (`string`): The slug of the HCP Packer Registry bucket where the channel should be created.\n - `name` (`string`): The name of the channel being managed.\n - `project_id` (`string`): \nThe ID of the HCP project where this channel is located. \nIf not specified, the project specified in the HCP Provider config block will be used, if configured.\nIf a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object.\n - `restricted` (`bool`): If true, the channel is only visible to users with permission to create and manage it. If false, the channel is visible to every member of the organization. When `null`, the `restricted` field will be omitted from the resulting object.\n - `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 [hcp.packer_channel.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `packer_channel` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`hcp.packer_channel.newAttrs` constructs a new object with attributes and blocks configured for the `packer_channel`\nTerraform resource.\n\nUnlike [hcp.packer_channel.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket_name` (`string`): The name of the HCP Packer Registry bucket where the channel should be created.\n - `name` (`string`): The name of the channel being managed.\n - `project_id` (`string`): \nThe ID of the HCP project where this channel is located. \nIf not specified, the project specified in the HCP Provider config block will be used, if configured.\nIf a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object.\n - `restricted` (`bool`): If true, the channel is only visible to users with permission to create and manage it. If false, the channel is visible to every member of the organization. When `null`, the `restricted` field will be omitted from the resulting object.\n - `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 [hcp.packer_channel.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `packer_channel` resource into the root Terraform configuration.\n', args=[]), newAttrs( bucket_name, name, diff --git a/0.x/_gen/resources/packer_channel_assignment.libsonnet b/0.x/_gen/resources/packer_channel_assignment.libsonnet index a49fd59..d642707 100644 --- a/0.x/_gen/resources/packer_channel_assignment.libsonnet +++ b/0.x/_gen/resources/packer_channel_assignment.libsonnet @@ -1,17 +1,16 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { - '#':: d.pkg(name='packer_channel_assignment', url='', help='`packer_channel_assignment` represents the `hcp_packer_channel_assignment` Terraform resource.\n\nThe Packer Channel Assignment resource allows you to manage the iteration assigned to a bucket channel in an active HCP Packer Registry.\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`hcp.packer_channel_assignment.new` injects a new `hcp_packer_channel_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n hcp.packer_channel_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `hcp.packer_channel_assignment` using the reference:\n\n $._ref.hcp_packer_channel_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ hcp_packer_channel_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `bucket_name` (`string`): The slug of the HCP Packer Registry bucket where the channel is located.\n - `channel_name` (`string`): The name of the HCP Packer channel being managed.\n - `iteration_fingerprint` (`string`): The fingerprint of the iteration assigned to the channel. When `null`, the `iteration_fingerprint` field will be omitted from the resulting object.\n - `iteration_id` (`string`): The ID of the iteration assigned to the channel. When `null`, the `iteration_id` field will be omitted from the resulting object.\n - `iteration_version` (`number`): The incremental version of the iteration assigned to the channel. When `null`, the `iteration_version` field will be omitted from the resulting object.\n - `project_id` (`string`): \nThe ID of the HCP project where the channel is located. \nIf not specified, the project specified in the HCP Provider config block will be used, if configured.\nIf a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object.\n - `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 [hcp.packer_channel_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#':: d.pkg(name='packer_channel_assignment', url='', help='`packer_channel_assignment` represents the `hcp_packer_channel_assignment` Terraform resource.\n\nThe Packer Channel Assignment resource allows you to manage the version assigned to a channel in an active HCP Packer Registry.\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`hcp.packer_channel_assignment.new` injects a new `hcp_packer_channel_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n hcp.packer_channel_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `hcp.packer_channel_assignment` using the reference:\n\n $._ref.hcp_packer_channel_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ hcp_packer_channel_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `bucket_name` (`string`): The slug of the HCP Packer bucket where the channel is located.\n - `channel_name` (`string`): The name of the HCP Packer channel being managed.\n - `iteration_fingerprint` (`string`): The fingerprint of the version assigned to the channel. When `null`, the `iteration_fingerprint` field will be omitted from the resulting object.\n - `project_id` (`string`): \nThe ID of the HCP project where the channel is located. \nIf not specified, the project specified in the HCP Provider config block will be used, if configured.\nIf a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object.\n - `version_fingerprint` (`string`): The fingerprint of the version assigned to the channel. When `null`, the `version_fingerprint` field will be omitted from the resulting object.\n - `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 [hcp.packer_channel_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, bucket_name, channel_name, iteration_fingerprint=null, - iteration_id=null, - iteration_version=null, project_id=null, timeouts=null, + version_fingerprint=null, _meta={} ):: tf.withResource( type='hcp_packer_channel_assignment', @@ -20,30 +19,27 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bucket_name=bucket_name, channel_name=channel_name, iteration_fingerprint=iteration_fingerprint, - iteration_id=iteration_id, - iteration_version=iteration_version, project_id=project_id, - timeouts=timeouts + timeouts=timeouts, + version_fingerprint=version_fingerprint ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`hcp.packer_channel_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `packer_channel_assignment`\nTerraform resource.\n\nUnlike [hcp.packer_channel_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket_name` (`string`): The slug of the HCP Packer Registry bucket where the channel is located.\n - `channel_name` (`string`): The name of the HCP Packer channel being managed.\n - `iteration_fingerprint` (`string`): The fingerprint of the iteration assigned to the channel. When `null`, the `iteration_fingerprint` field will be omitted from the resulting object.\n - `iteration_id` (`string`): The ID of the iteration assigned to the channel. When `null`, the `iteration_id` field will be omitted from the resulting object.\n - `iteration_version` (`number`): The incremental version of the iteration assigned to the channel. When `null`, the `iteration_version` field will be omitted from the resulting object.\n - `project_id` (`string`): \nThe ID of the HCP project where the channel is located. \nIf not specified, the project specified in the HCP Provider config block will be used, if configured.\nIf a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object.\n - `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 [hcp.packer_channel_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `packer_channel_assignment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`hcp.packer_channel_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `packer_channel_assignment`\nTerraform resource.\n\nUnlike [hcp.packer_channel_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket_name` (`string`): The slug of the HCP Packer bucket where the channel is located.\n - `channel_name` (`string`): The name of the HCP Packer channel being managed.\n - `iteration_fingerprint` (`string`): The fingerprint of the version assigned to the channel. When `null`, the `iteration_fingerprint` field will be omitted from the resulting object.\n - `project_id` (`string`): \nThe ID of the HCP project where the channel is located. \nIf not specified, the project specified in the HCP Provider config block will be used, if configured.\nIf a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object.\n - `version_fingerprint` (`string`): The fingerprint of the version assigned to the channel. When `null`, the `version_fingerprint` field will be omitted from the resulting object.\n - `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 [hcp.packer_channel_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `packer_channel_assignment` resource into the root Terraform configuration.\n', args=[]), newAttrs( bucket_name, channel_name, iteration_fingerprint=null, - iteration_id=null, - iteration_version=null, project_id=null, - timeouts=null + timeouts=null, + version_fingerprint=null ):: std.prune(a={ bucket_name: bucket_name, channel_name: channel_name, iteration_fingerprint: iteration_fingerprint, - iteration_id: iteration_id, - iteration_version: iteration_version, project_id: project_id, timeouts: timeouts, + version_fingerprint: version_fingerprint, }), timeouts:: { '#new':: d.fn(help='\n`hcp.packer_channel_assignment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `default` (`string`): Set the `default` field on the resulting object. When `null`, the `default` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), @@ -89,26 +85,6 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#withIterationId':: d.fn(help='`hcp.string.withIterationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the iteration_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `iteration_id` field.\n', args=[]), - withIterationId(resourceLabel, value): { - resource+: { - hcp_packer_channel_assignment+: { - [resourceLabel]+: { - iteration_id: value, - }, - }, - }, - }, - '#withIterationVersion':: d.fn(help='`hcp.number.withIterationVersion` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the iteration_version field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`number`): The value to set for the `iteration_version` field.\n', args=[]), - withIterationVersion(resourceLabel, value): { - resource+: { - hcp_packer_channel_assignment+: { - [resourceLabel]+: { - iteration_version: value, - }, - }, - }, - }, '#withProjectId':: d.fn(help='`hcp.string.withProjectId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project_id` field.\n', args=[]), withProjectId(resourceLabel, value): { resource+: { @@ -139,4 +115,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withVersionFingerprint':: d.fn(help='`hcp.string.withVersionFingerprint` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the version_fingerprint field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `version_fingerprint` field.\n', args=[]), + withVersionFingerprint(resourceLabel, value): { + resource+: { + hcp_packer_channel_assignment+: { + [resourceLabel]+: { + version_fingerprint: value, + }, + }, + }, + }, } diff --git a/docs/0.x/README.md b/docs/0.x/README.md index ce560ed..6442951 100644 --- a/docs/0.x/README.md +++ b/docs/0.x/README.md @@ -24,6 +24,7 @@ project. * [hvn_route](hvn_route.md) * [iam_workload_identity_provider](iam_workload_identity_provider.md) * [log_streaming_destination](log_streaming_destination.md) +* [notifications_webhook](notifications_webhook.md) * [organization_iam_binding](organization_iam_binding.md) * [organization_iam_policy](organization_iam_policy.md) * [packer_channel](packer_channel.md) diff --git a/docs/0.x/data/index.md b/docs/0.x/data/index.md index 6a9736c..dbe480f 100644 --- a/docs/0.x/data/index.md +++ b/docs/0.x/data/index.md @@ -19,10 +19,12 @@ permalink: /data/ * [hvn_route](hvn_route.md) * [iam_policy](iam_policy.md) * [organization](organization.md) +* [packer_artifact](packer_artifact.md) * [packer_bucket_names](packer_bucket_names.md) * [packer_image](packer_image.md) * [packer_iteration](packer_iteration.md) * [packer_run_task](packer_run_task.md) +* [packer_version](packer_version.md) * [project](project.md) * [service_principal](service_principal.md) * [vault_cluster](vault_cluster.md) diff --git a/docs/0.x/data/packer_artifact.md b/docs/0.x/data/packer_artifact.md new file mode 100644 index 0000000..4d6772a --- /dev/null +++ b/docs/0.x/data/packer_artifact.md @@ -0,0 +1,218 @@ +--- +permalink: /data/packer_artifact/ +--- + +# data.packer_artifact + +`packer_artifact` represents the `hcp_packer_artifact` Terraform data source. + +The HCP Packer Artifact data source retrieves information about an Artifact. + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withBucketName()`](#fn-withbucketname) +* [`fn withChannelName()`](#fn-withchannelname) +* [`fn withComponentType()`](#fn-withcomponenttype) +* [`fn withPlatform()`](#fn-withplatform) +* [`fn withProjectId()`](#fn-withprojectid) +* [`fn withRegion()`](#fn-withregion) +* [`fn withVersionFingerprint()`](#fn-withversionfingerprint) + +## Fields + +### fn new + +```ts +new() +``` + + +`hcp.data.packer_artifact.new` injects a new `data_hcp_packer_artifact` Terraform `data source` +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 + hcp.data.packer_artifact.new('some_id') + +You can get the reference to the `id` field of the created `hcp.data.packer_artifact` using the reference: + + $._ref.data_hcp_packer_artifact.some_id.get('id') + +This is the same as directly entering `"${ data_hcp_packer_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**: + - `dataSrcLabel` (`string`): The name label of the block. + - `bucket_name` (`string`): The name of the HCP Packer Bucket where the Artifact is located. + - `channel_name` (`string`): +The name of the HCP Packer Channel the Version containing this Artifact is assigned to. +The Version currently assigned to the Channel will be fetched. +Exactly one of `channel_name` or `version_fingerprint` must be provided. When `null`, the `channel_name` field will be omitted from the resulting object. + - `component_type` (`string`): Name of the Packer builder that built this Artifact. Ex: `amazon-ebs.example`. When `null`, the `component_type` field will be omitted from the resulting object. + - `platform` (`string`): Name of the platform where the HCP Packer Artifact is stored. + - `project_id` (`string`): The ID of the HCP Organization where the Artifact is located When `null`, the `project_id` field will be omitted from the resulting object. + - `region` (`string`): The Region where the HCP Packer Artifact is stored, if any. + - `version_fingerprint` (`string`): +The fingerprint of the HCP Packer Version where the Artifact is located. +If provided in the config, it is used to fetch the Version. +Exactly one of `channel_name` or `version_fingerprint` must be provided. When `null`, the `version_fingerprint` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`hcp.data.packer_artifact.newAttrs` constructs a new object with attributes and blocks configured for the `packer_artifact` +Terraform data source. + +Unlike [hcp.data.packer_artifact.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) 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**: + - `bucket_name` (`string`): The name of the HCP Packer Bucket where the Artifact is located. + - `channel_name` (`string`): +The name of the HCP Packer Channel the Version containing this Artifact is assigned to. +The Version currently assigned to the Channel will be fetched. +Exactly one of `channel_name` or `version_fingerprint` must be provided. When `null`, the `channel_name` field will be omitted from the resulting object. + - `component_type` (`string`): Name of the Packer builder that built this Artifact. Ex: `amazon-ebs.example`. When `null`, the `component_type` field will be omitted from the resulting object. + - `platform` (`string`): Name of the platform where the HCP Packer Artifact is stored. + - `project_id` (`string`): The ID of the HCP Organization where the Artifact is located When `null`, the `project_id` field will be omitted from the resulting object. + - `region` (`string`): The Region where the HCP Packer Artifact is stored, if any. + - `version_fingerprint` (`string`): +The fingerprint of the HCP Packer Version where the Artifact is located. +If provided in the config, it is used to fetch the Version. +Exactly one of `channel_name` or `version_fingerprint` must be provided. When `null`, the `version_fingerprint` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `packer_artifact` data source into the root Terraform configuration. + + +### fn withBucketName + +```ts +withBucketName() +``` + +`hcp.string.withBucketName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the bucket_name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `bucket_name` field. + + +### fn withChannelName + +```ts +withChannelName() +``` + +`hcp.string.withChannelName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the channel_name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `channel_name` field. + + +### fn withComponentType + +```ts +withComponentType() +``` + +`hcp.string.withComponentType` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the component_type field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `component_type` field. + + +### fn withPlatform + +```ts +withPlatform() +``` + +`hcp.string.withPlatform` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the platform field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `platform` field. + + +### fn withProjectId + +```ts +withProjectId() +``` + +`hcp.string.withProjectId` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the project_id field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project_id` field. + + +### fn withRegion + +```ts +withRegion() +``` + +`hcp.string.withRegion` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the region field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `region` field. + + +### fn withVersionFingerprint + +```ts +withVersionFingerprint() +``` + +`hcp.string.withVersionFingerprint` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the version_fingerprint field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `version_fingerprint` field. diff --git a/docs/0.x/data/packer_version.md b/docs/0.x/data/packer_version.md new file mode 100644 index 0000000..c8bfbda --- /dev/null +++ b/docs/0.x/data/packer_version.md @@ -0,0 +1,134 @@ +--- +permalink: /data/packer_version/ +--- + +# data.packer_version + +`packer_version` represents the `hcp_packer_version` Terraform data source. + +The HCP Packer Version data source retrieves information about a Version. + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withBucketName()`](#fn-withbucketname) +* [`fn withChannelName()`](#fn-withchannelname) +* [`fn withProjectId()`](#fn-withprojectid) + +## Fields + +### fn new + +```ts +new() +``` + + +`hcp.data.packer_version.new` injects a new `data_hcp_packer_version` Terraform `data source` +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 + hcp.data.packer_version.new('some_id') + +You can get the reference to the `id` field of the created `hcp.data.packer_version` using the reference: + + $._ref.data_hcp_packer_version.some_id.get('id') + +This is the same as directly entering `"${ data_hcp_packer_version.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**: + - `dataSrcLabel` (`string`): The name label of the block. + - `bucket_name` (`string`): The name of the HCP Packer Bucket where the Version is located + - `channel_name` (`string`): +The name of the HCP Packer Channel the Version is assigned to. +The version currently assigned to the Channel will be fetched. + - `project_id` (`string`): The ID of the HCP Organization where the Version is located When `null`, the `project_id` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`hcp.data.packer_version.newAttrs` constructs a new object with attributes and blocks configured for the `packer_version` +Terraform data source. + +Unlike [hcp.data.packer_version.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) 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**: + - `bucket_name` (`string`): The name of the HCP Packer Bucket where the Version is located + - `channel_name` (`string`): +The name of the HCP Packer Channel the Version is assigned to. +The version currently assigned to the Channel will be fetched. + - `project_id` (`string`): The ID of the HCP Organization where the Version is located When `null`, the `project_id` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `packer_version` data source into the root Terraform configuration. + + +### fn withBucketName + +```ts +withBucketName() +``` + +`hcp.string.withBucketName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the bucket_name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `bucket_name` field. + + +### fn withChannelName + +```ts +withChannelName() +``` + +`hcp.string.withChannelName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the channel_name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `channel_name` field. + + +### fn withProjectId + +```ts +withProjectId() +``` + +`hcp.string.withProjectId` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the project_id field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project_id` field. diff --git a/docs/0.x/notifications_webhook.md b/docs/0.x/notifications_webhook.md new file mode 100644 index 0000000..4a22a3f --- /dev/null +++ b/docs/0.x/notifications_webhook.md @@ -0,0 +1,227 @@ +--- +permalink: /notifications_webhook/ +--- + +# notifications_webhook + +`notifications_webhook` represents the `hcp_notifications_webhook` Terraform resource. + +The webhook resource manages a HCP webhook, used to notify external systems about a project resource's lifecycle events + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withConfig()`](#fn-withconfig) +* [`fn withConfigMixin()`](#fn-withconfigmixin) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withEnabled()`](#fn-withenabled) +* [`fn withName()`](#fn-withname) +* [`fn withProjectId()`](#fn-withprojectid) +* [`fn withSubscriptions()`](#fn-withsubscriptions) +* [`fn withSubscriptionsMixin()`](#fn-withsubscriptionsmixin) + +## Fields + +### fn new + +```ts +new() +``` + + +`hcp.notifications_webhook.new` injects a new `hcp_notifications_webhook` 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 + hcp.notifications_webhook.new('some_id') + +You can get the reference to the `id` field of the created `hcp.notifications_webhook` using the reference: + + $._ref.hcp_notifications_webhook.some_id.get('id') + +This is the same as directly entering `"${ hcp_notifications_webhook.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. + - `config` (`obj`): The webhook configuration used to deliver event payloads. + - `description` (`string`): The webhook's description. Descriptions are useful for helping others understand the purpose of the webhook. When `null`, the `description` field will be omitted from the resulting object. + - `enabled` (`bool`): Indicates if the webhook should receive payloads for the subscribed events. Defaults to `true`. When `null`, the `enabled` field will be omitted from the resulting object. + - `name` (`string`): The webhook's name. + - `project_id` (`string`): The ID of the project to create the webhook under. If unspecified, the webhook will be created in the project the provider is configured with. When `null`, the `project_id` field will be omitted from the resulting object. + - `subscriptions` (`list[obj]`): Set of events to subscribe the webhook to all resources or a specific resource in the project. When `null`, the `subscriptions` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`hcp.notifications_webhook.newAttrs` constructs a new object with attributes and blocks configured for the `notifications_webhook` +Terraform resource. + +Unlike [hcp.notifications_webhook.new](#fn-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](https://github.com/tf-libsonnet/core/tree/main/docs#fn-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**: + - `config` (`obj`): The webhook configuration used to deliver event payloads. + - `description` (`string`): The webhook's description. Descriptions are useful for helping others understand the purpose of the webhook. When `null`, the `description` field will be omitted from the resulting object. + - `enabled` (`bool`): Indicates if the webhook should receive payloads for the subscribed events. Defaults to `true`. When `null`, the `enabled` field will be omitted from the resulting object. + - `name` (`string`): The webhook's name. + - `project_id` (`string`): The ID of the project to create the webhook under. If unspecified, the webhook will be created in the project the provider is configured with. When `null`, the `project_id` field will be omitted from the resulting object. + - `subscriptions` (`list[obj]`): Set of events to subscribe the webhook to all resources or a specific resource in the project. When `null`, the `subscriptions` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `notifications_webhook` resource into the root Terraform configuration. + + +### fn withConfig + +```ts +withConfig() +``` + +`hcp.obj.withConfig` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the config field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `config` field. + + +### fn withConfigMixin + +```ts +withConfigMixin() +``` + +`hcp.obj.withConfigMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the config 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 [hcp.obj.withConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `config` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`hcp.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 withEnabled + +```ts +withEnabled() +``` + +`hcp.bool.withEnabled` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the enabled field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `enabled` field. + + +### fn withName + +```ts +withName() +``` + +`hcp.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 withProjectId + +```ts +withProjectId() +``` + +`hcp.string.withProjectId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project_id` field. + + +### fn withSubscriptions + +```ts +withSubscriptions() +``` + +`hcp.list[obj].withSubscriptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the subscriptions field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `subscriptions` field. + + +### fn withSubscriptionsMixin + +```ts +withSubscriptionsMixin() +``` + +`hcp.list[obj].withSubscriptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the subscriptions 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 [hcp.list[obj].withSubscriptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `subscriptions` field. diff --git a/docs/0.x/packer_channel.md b/docs/0.x/packer_channel.md index b318937..bf6633f 100644 --- a/docs/0.x/packer_channel.md +++ b/docs/0.x/packer_channel.md @@ -53,7 +53,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `bucket_name` (`string`): The slug of the HCP Packer Registry bucket where the channel should be created. + - `bucket_name` (`string`): The name of the HCP Packer Registry bucket where the channel should be created. - `name` (`string`): The name of the channel being managed. - `project_id` (`string`): The ID of the HCP project where this channel is located. @@ -84,7 +84,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `bucket_name` (`string`): The slug of the HCP Packer Registry bucket where the channel should be created. + - `bucket_name` (`string`): The name of the HCP Packer Registry bucket where the channel should be created. - `name` (`string`): The name of the channel being managed. - `project_id` (`string`): The ID of the HCP project where this channel is located. diff --git a/docs/0.x/packer_channel_assignment.md b/docs/0.x/packer_channel_assignment.md index b94e011..cf0d8a8 100644 --- a/docs/0.x/packer_channel_assignment.md +++ b/docs/0.x/packer_channel_assignment.md @@ -6,7 +6,7 @@ permalink: /packer_channel_assignment/ `packer_channel_assignment` represents the `hcp_packer_channel_assignment` Terraform resource. -The Packer Channel Assignment resource allows you to manage the iteration assigned to a bucket channel in an active HCP Packer Registry. +The Packer Channel Assignment resource allows you to manage the version assigned to a channel in an active HCP Packer Registry. This package contains functions and utilities for setting up the resource using Jsonnet code. @@ -18,11 +18,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withBucketName()`](#fn-withbucketname) * [`fn withChannelName()`](#fn-withchannelname) * [`fn withIterationFingerprint()`](#fn-withiterationfingerprint) -* [`fn withIterationId()`](#fn-withiterationid) -* [`fn withIterationVersion()`](#fn-withiterationversion) * [`fn withProjectId()`](#fn-withprojectid) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withVersionFingerprint()`](#fn-withversionfingerprint) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -55,15 +54,14 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `bucket_name` (`string`): The slug of the HCP Packer Registry bucket where the channel is located. + - `bucket_name` (`string`): The slug of the HCP Packer bucket where the channel is located. - `channel_name` (`string`): The name of the HCP Packer channel being managed. - - `iteration_fingerprint` (`string`): The fingerprint of the iteration assigned to the channel. When `null`, the `iteration_fingerprint` field will be omitted from the resulting object. - - `iteration_id` (`string`): The ID of the iteration assigned to the channel. When `null`, the `iteration_id` field will be omitted from the resulting object. - - `iteration_version` (`number`): The incremental version of the iteration assigned to the channel. When `null`, the `iteration_version` field will be omitted from the resulting object. + - `iteration_fingerprint` (`string`): The fingerprint of the version assigned to the channel. When `null`, the `iteration_fingerprint` field will be omitted from the resulting object. - `project_id` (`string`): The ID of the HCP project where the channel is located. If not specified, the project specified in the HCP Provider config block will be used, if configured. If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object. + - `version_fingerprint` (`string`): The fingerprint of the version assigned to the channel. When `null`, the `version_fingerprint` 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 [hcp.packer_channel_assignment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -88,15 +86,14 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `bucket_name` (`string`): The slug of the HCP Packer Registry bucket where the channel is located. + - `bucket_name` (`string`): The slug of the HCP Packer bucket where the channel is located. - `channel_name` (`string`): The name of the HCP Packer channel being managed. - - `iteration_fingerprint` (`string`): The fingerprint of the iteration assigned to the channel. When `null`, the `iteration_fingerprint` field will be omitted from the resulting object. - - `iteration_id` (`string`): The ID of the iteration assigned to the channel. When `null`, the `iteration_id` field will be omitted from the resulting object. - - `iteration_version` (`number`): The incremental version of the iteration assigned to the channel. When `null`, the `iteration_version` field will be omitted from the resulting object. + - `iteration_fingerprint` (`string`): The fingerprint of the version assigned to the channel. When `null`, the `iteration_fingerprint` field will be omitted from the resulting object. - `project_id` (`string`): The ID of the HCP project where the channel is located. If not specified, the project specified in the HCP Provider config block will be used, if configured. If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used. When `null`, the `project_id` field will be omitted from the resulting object. + - `version_fingerprint` (`string`): The fingerprint of the version assigned to the channel. When `null`, the `version_fingerprint` 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 [hcp.packer_channel_assignment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -151,38 +148,6 @@ Terraform resource block to set or update the iteration_fingerprint field. - `value` (`string`): The value to set for the `iteration_fingerprint` field. -### fn withIterationId - -```ts -withIterationId() -``` - -`hcp.string.withIterationId` constructs a mixin object that can be merged into the `string` -Terraform resource block to set or update the iteration_id field. - - - -**Args**: - - `resourceLabel` (`string`): The name label of the block to update. - - `value` (`string`): The value to set for the `iteration_id` field. - - -### fn withIterationVersion - -```ts -withIterationVersion() -``` - -`hcp.number.withIterationVersion` constructs a mixin object that can be merged into the `number` -Terraform resource block to set or update the iteration_version field. - - - -**Args**: - - `resourceLabel` (`string`): The name label of the block to update. - - `value` (`number`): The value to set for the `iteration_version` field. - - ### fn withProjectId ```ts @@ -235,6 +200,22 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +### fn withVersionFingerprint + +```ts +withVersionFingerprint() +``` + +`hcp.string.withVersionFingerprint` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the version_fingerprint field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `version_fingerprint` field. + + ## obj timeouts