diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index 3a24ee8..671a774 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -11,6 +11,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); access_context_manager_access_policy_iam_policy: (import 'resources/access_context_manager_access_policy_iam_policy.libsonnet'), access_context_manager_authorized_orgs_desc: (import 'resources/access_context_manager_authorized_orgs_desc.libsonnet'), access_context_manager_gcp_user_access_binding: (import 'resources/access_context_manager_gcp_user_access_binding.libsonnet'), + access_context_manager_ingress_policy: (import 'resources/access_context_manager_ingress_policy.libsonnet'), access_context_manager_service_perimeter: (import 'resources/access_context_manager_service_perimeter.libsonnet'), access_context_manager_service_perimeter_resource: (import 'resources/access_context_manager_service_perimeter_resource.libsonnet'), access_context_manager_service_perimeters: (import 'resources/access_context_manager_service_perimeters.libsonnet'), @@ -211,8 +212,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); compute_project_default_network_tier: (import 'resources/compute_project_default_network_tier.libsonnet'), compute_project_metadata: (import 'resources/compute_project_metadata.libsonnet'), compute_project_metadata_item: (import 'resources/compute_project_metadata_item.libsonnet'), + compute_public_advertised_prefix: (import 'resources/compute_public_advertised_prefix.libsonnet'), + compute_public_delegated_prefix: (import 'resources/compute_public_delegated_prefix.libsonnet'), compute_region_autoscaler: (import 'resources/compute_region_autoscaler.libsonnet'), compute_region_backend_service: (import 'resources/compute_region_backend_service.libsonnet'), + compute_region_commitment: (import 'resources/compute_region_commitment.libsonnet'), compute_region_disk: (import 'resources/compute_region_disk.libsonnet'), compute_region_disk_iam_binding: (import 'resources/compute_region_disk_iam_binding.libsonnet'), compute_region_disk_iam_member: (import 'resources/compute_region_disk_iam_member.libsonnet'), diff --git a/4.x/_gen/resources/access_context_manager_ingress_policy.libsonnet b/4.x/_gen/resources/access_context_manager_ingress_policy.libsonnet new file mode 100644 index 0000000..16346b3 --- /dev/null +++ b/4.x/_gen/resources/access_context_manager_ingress_policy.libsonnet @@ -0,0 +1,78 @@ +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='access_context_manager_ingress_policy', url='', help='`access_context_manager_ingress_policy` represents the `google_access_context_manager_ingress_policy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google.access_context_manager_ingress_policy.new` injects a new `google_access_context_manager_ingress_policy` 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 google.access_context_manager_ingress_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.access_context_manager_ingress_policy` using the reference:\n\n $._ref.google_access_context_manager_ingress_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_access_context_manager_ingress_policy.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 - `ingress_policy_name` (`string`): The name of the Service Perimeter to add this resource to.\n - `resource` (`string`): A GCP resource that is inside of the service perimeter.\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 [google.access_context_manager_ingress_policy.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, + ingress_policy_name, + resource, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_access_context_manager_ingress_policy', + label=resourceLabel, + attrs=self.newAttrs(ingress_policy_name=ingress_policy_name, resource=resource, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.access_context_manager_ingress_policy.newAttrs` constructs a new object with attributes and blocks configured for the `access_context_manager_ingress_policy`\nTerraform resource.\n\nUnlike [google.access_context_manager_ingress_policy.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 - `ingress_policy_name` (`string`): The name of the Service Perimeter to add this resource to.\n - `resource` (`string`): A GCP resource that is inside of the service perimeter.\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 [google.access_context_manager_ingress_policy.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 `access_context_manager_ingress_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + ingress_policy_name, + resource, + timeouts=null + ):: std.prune(a={ + ingress_policy_name: ingress_policy_name, + resource: resource, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.access_context_manager_ingress_policy.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 - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withIngressPolicyName':: d.fn(help='`google.string.withIngressPolicyName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the ingress_policy_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 `ingress_policy_name` field.\n', args=[]), + withIngressPolicyName(resourceLabel, value): { + resource+: { + google_access_context_manager_ingress_policy+: { + [resourceLabel]+: { + ingress_policy_name: value, + }, + }, + }, + }, + '#withResource':: d.fn(help='`google.string.withResource` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the resource 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 `resource` field.\n', args=[]), + withResource(resourceLabel, value): { + resource+: { + google_access_context_manager_ingress_policy+: { + [resourceLabel]+: { + resource: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_access_context_manager_ingress_policy+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts 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 [google.obj.withTimeouts](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 `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_access_context_manager_ingress_policy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/alloydb_backup.libsonnet b/4.x/_gen/resources/alloydb_backup.libsonnet index 92023ea..2c38420 100644 --- a/4.x/_gen/resources/alloydb_backup.libsonnet +++ b/4.x/_gen/resources/alloydb_backup.libsonnet @@ -2,14 +2,14 @@ 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='alloydb_backup', url='', help='`alloydb_backup` represents the `google_alloydb_backup` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google.alloydb_backup.new` injects a new `google_alloydb_backup` 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 google.alloydb_backup.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.alloydb_backup` using the reference:\n\n $._ref.google_alloydb_backup.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_alloydb_backup.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 - `backup_id` (`string`): The ID of the alloydb backup.\n - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).\n - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb backup should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` 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 [google.alloydb_backup.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`google.alloydb_backup.new` injects a new `google_alloydb_backup` 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 google.alloydb_backup.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.alloydb_backup` using the reference:\n\n $._ref.google_alloydb_backup.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_alloydb_backup.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 - `backup_id` (`string`): The ID of the alloydb backup.\n - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).\n - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb backup should reside.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` 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 [google.alloydb_backup.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, backup_id, cluster_name, + location, description=null, labels=null, - location=null, project=null, timeouts=null, _meta={} @@ -27,13 +27,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.alloydb_backup.newAttrs` constructs a new object with attributes and blocks configured for the `alloydb_backup`\nTerraform resource.\n\nUnlike [google.alloydb_backup.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 - `backup_id` (`string`): The ID of the alloydb backup.\n - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).\n - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb backup should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` 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 [google.alloydb_backup.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 `alloydb_backup` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.alloydb_backup.newAttrs` constructs a new object with attributes and blocks configured for the `alloydb_backup`\nTerraform resource.\n\nUnlike [google.alloydb_backup.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 - `backup_id` (`string`): The ID of the alloydb backup.\n - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).\n - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb backup should reside.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` 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 [google.alloydb_backup.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 `alloydb_backup` resource into the root Terraform configuration.\n', args=[]), newAttrs( backup_id, cluster_name, + location, description=null, labels=null, - location=null, project=null, timeouts=null ):: std.prune(a={ diff --git a/4.x/_gen/resources/alloydb_cluster.libsonnet b/4.x/_gen/resources/alloydb_cluster.libsonnet index 453366c..6c5b457 100644 --- a/4.x/_gen/resources/alloydb_cluster.libsonnet +++ b/4.x/_gen/resources/alloydb_cluster.libsonnet @@ -72,16 +72,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user: user, }), }, - '#new':: d.fn(help="\n`google.alloydb_cluster.new` injects a new `google_alloydb_cluster` 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 google.alloydb_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.alloydb_cluster` using the reference:\n\n $._ref.google_alloydb_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_alloydb_cluster.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 - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n\u0026#34;projects/{projectNumber}/global/networks/{network_id}\u0026#34;.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\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 [google.alloydb_cluster.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`google.alloydb_cluster.new` injects a new `google_alloydb_cluster` 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 google.alloydb_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.alloydb_cluster` using the reference:\n\n $._ref.google_alloydb_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_alloydb_cluster.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 - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n\u0026#34;projects/{projectNumber}/global/networks/{network_id}\u0026#34;.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\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 [google.alloydb_cluster.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, cluster_id, + location, network, automated_backup_policy=null, display_name=null, initial_user=null, labels=null, - location=null, project=null, timeouts=null, _meta={} @@ -101,15 +101,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.alloydb_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `alloydb_cluster`\nTerraform resource.\n\nUnlike [google.alloydb_cluster.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 - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n"projects/{projectNumber}/global/networks/{network_id}".\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\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 [google.alloydb_cluster.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 `alloydb_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.alloydb_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `alloydb_cluster`\nTerraform resource.\n\nUnlike [google.alloydb_cluster.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 - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n"projects/{projectNumber}/global/networks/{network_id}".\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\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 [google.alloydb_cluster.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 `alloydb_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster_id, + location, network, automated_backup_policy=null, display_name=null, initial_user=null, labels=null, - location=null, project=null, timeouts=null ):: std.prune(a={ diff --git a/4.x/_gen/resources/alloydb_instance.libsonnet b/4.x/_gen/resources/alloydb_instance.libsonnet index 19c4a9d..d9baab6 100644 --- a/4.x/_gen/resources/alloydb_instance.libsonnet +++ b/4.x/_gen/resources/alloydb_instance.libsonnet @@ -10,7 +10,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cpu_count: cpu_count, }), }, - '#new':: d.fn(help="\n`google.alloydb_instance.new` injects a new `google_alloydb_instance` 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 google.alloydb_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.alloydb_instance` using the reference:\n\n $._ref.google_alloydb_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_alloydb_instance.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 - `annotations` (`obj`): Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `availability_type` (`string`): Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types. Possible values: [\u0026#34;AVAILABILITY_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;ZONAL\u0026#34;, \u0026#34;REGIONAL\u0026#34;] When `null`, the `availability_type` field will be omitted from the resulting object.\n - `cluster` (`string`): Identifies the alloydb cluster. Must be in the format\n\u0026#39;projects/{project}/locations/{location}/clusters/{cluster_id}\u0026#39;\n - `database_flags` (`obj`): Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object.\n - `instance_id` (`string`): The ID of the alloydb instance.\n - `instance_type` (`string`): The type of the instance. Possible values: [\u0026#34;PRIMARY\u0026#34;, \u0026#34;READ_POOL\u0026#34;]\n - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.machine_config.new](#fn-machine_confignew) constructor.\n - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor.\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 [google.alloydb_instance.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`google.alloydb_instance.new` injects a new `google_alloydb_instance` 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 google.alloydb_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.alloydb_instance` using the reference:\n\n $._ref.google_alloydb_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_alloydb_instance.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 - `annotations` (`obj`): Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `availability_type` (`string`): Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types. Possible values: [\u0026#34;AVAILABILITY_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;ZONAL\u0026#34;, \u0026#34;REGIONAL\u0026#34;] When `null`, the `availability_type` field will be omitted from the resulting object.\n - `cluster` (`string`): Identifies the alloydb cluster. Must be in the format\n\u0026#39;projects/{project}/locations/{location}/clusters/{cluster_id}\u0026#39;\n - `database_flags` (`obj`): Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object.\n - `instance_id` (`string`): The ID of the alloydb instance.\n - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the \u0026#39;depends_on\u0026#39; meta-data attribute. Possible values: [\u0026#34;PRIMARY\u0026#34;, \u0026#34;READ_POOL\u0026#34;]\n - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.machine_config.new](#fn-machine_confignew) constructor.\n - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor.\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 [google.alloydb_instance.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, cluster, @@ -45,7 +45,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.alloydb_instance.newAttrs` constructs a new object with attributes and blocks configured for the `alloydb_instance`\nTerraform resource.\n\nUnlike [google.alloydb_instance.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 - `annotations` (`obj`): Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `availability_type` (`string`): Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types. Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"] When `null`, the `availability_type` field will be omitted from the resulting object.\n - `cluster` (`string`): Identifies the alloydb cluster. Must be in the format\n'projects/{project}/locations/{location}/clusters/{cluster_id}'\n - `database_flags` (`obj`): Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object.\n - `instance_id` (`string`): The ID of the alloydb instance.\n - `instance_type` (`string`): The type of the instance. Possible values: ["PRIMARY", "READ_POOL"]\n - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.machine_config.new](#fn-machine_confignew) constructor.\n - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor.\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 [google.alloydb_instance.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 `alloydb_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.alloydb_instance.newAttrs` constructs a new object with attributes and blocks configured for the `alloydb_instance`\nTerraform resource.\n\nUnlike [google.alloydb_instance.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 - `annotations` (`obj`): Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `availability_type` (`string`): Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types. Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"] When `null`, the `availability_type` field will be omitted from the resulting object.\n - `cluster` (`string`): Identifies the alloydb cluster. Must be in the format\n'projects/{project}/locations/{location}/clusters/{cluster_id}'\n - `database_flags` (`obj`): Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object.\n - `instance_id` (`string`): The ID of the alloydb instance.\n - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the 'depends_on' meta-data attribute. Possible values: ["PRIMARY", "READ_POOL"]\n - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.machine_config.new](#fn-machine_confignew) constructor.\n - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor.\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 [google.alloydb_instance.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 `alloydb_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster, instance_id, diff --git a/4.x/_gen/resources/apigee_sharedflow.libsonnet b/4.x/_gen/resources/apigee_sharedflow.libsonnet index 94864b6..deadf9a 100644 --- a/4.x/_gen/resources/apigee_sharedflow.libsonnet +++ b/4.x/_gen/resources/apigee_sharedflow.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='apigee_sharedflow', url='', help='`apigee_sharedflow` represents the `google_apigee_sharedflow` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google.apigee_sharedflow.new` injects a new `google_apigee_sharedflow` 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 google.apigee_sharedflow.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.apigee_sharedflow` using the reference:\n\n $._ref.google_apigee_sharedflow.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_apigee_sharedflow.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_bundle` (`string`): A path to the config bundle zip you want to upload. Must be defined if content is not.\n - `detect_md5hash` (`string`): A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update. When `null`, the `detect_md5hash` field will be omitted from the resulting object.\n - `name` (`string`): The ID of the shared flow.\n - `org_id` (`string`): The Apigee Organization name associated with the Apigee instance.\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 [google.apigee_sharedflow.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`google.apigee_sharedflow.new` injects a new `google_apigee_sharedflow` 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 google.apigee_sharedflow.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.apigee_sharedflow` using the reference:\n\n $._ref.google_apigee_sharedflow.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_apigee_sharedflow.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_bundle` (`string`): Path to the config zip bundle\n - `detect_md5hash` (`string`): A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update. When `null`, the `detect_md5hash` field will be omitted from the resulting object.\n - `name` (`string`): The ID of the shared flow.\n - `org_id` (`string`): The Apigee Organization name associated with the Apigee instance.\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 [google.apigee_sharedflow.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, config_bundle, @@ -23,7 +23,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.apigee_sharedflow.newAttrs` constructs a new object with attributes and blocks configured for the `apigee_sharedflow`\nTerraform resource.\n\nUnlike [google.apigee_sharedflow.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_bundle` (`string`): A path to the config bundle zip you want to upload. Must be defined if content is not.\n - `detect_md5hash` (`string`): A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update. When `null`, the `detect_md5hash` field will be omitted from the resulting object.\n - `name` (`string`): The ID of the shared flow.\n - `org_id` (`string`): The Apigee Organization name associated with the Apigee instance.\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 [google.apigee_sharedflow.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 `apigee_sharedflow` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.apigee_sharedflow.newAttrs` constructs a new object with attributes and blocks configured for the `apigee_sharedflow`\nTerraform resource.\n\nUnlike [google.apigee_sharedflow.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_bundle` (`string`): Path to the config zip bundle\n - `detect_md5hash` (`string`): A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update. When `null`, the `detect_md5hash` field will be omitted from the resulting object.\n - `name` (`string`): The ID of the shared flow.\n - `org_id` (`string`): The Apigee Organization name associated with the Apigee instance.\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 [google.apigee_sharedflow.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 `apigee_sharedflow` resource into the root Terraform configuration.\n', args=[]), newAttrs( config_bundle, name, diff --git a/4.x/_gen/resources/cloud_run_service.libsonnet b/4.x/_gen/resources/cloud_run_service.libsonnet index 6d9e8b1..cc96a88 100644 --- a/4.x/_gen/resources/cloud_run_service.libsonnet +++ b/4.x/_gen/resources/cloud_run_service.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='cloud_run_service', url='', help='`cloud_run_service` represents the `google_cloud_run_service` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), metadata:: { - '#new':: d.fn(help='\n`google.cloud_run_service.metadata.new` constructs a new object with attributes and blocks configured for the `metadata`\nTerraform sub block.\n\n\n\n**Args**:\n - `annotations` (`obj`): Annotations is a key value map stored with a resource that\nmay be set by external tools to store and retrieve arbitrary metadata. More\ninfo: http://kubernetes.io/docs/user-guide/annotations\n\n**Note**: The Cloud Run API may add additional annotations that were not provided in your config.\nIf terraform plan shows a diff where a server-side annotation is added, you can add it to your config\nor apply the lifecycle.ignore_changes rule to the metadata.0.annotations field.\n\nCloud Run (fully managed) uses the following annotation keys to configure features on a Service:\n\n- 'run.googleapis.com/ingress' sets the [ingress settings](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--ingress)\n for the Service. For example, '"run.googleapis.com/ingress" = "all"'. When `null`, the `annotations` field will be omitted from the resulting object.\n - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand routes. When `null`, the `labels` field will be omitted from the resulting object.\n - `namespace` (`string`): In Cloud Run the namespace must be equal to either the\nproject ID or project number. When `null`, the `namespace` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `metadata` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.cloud_run_service.metadata.new` constructs a new object with attributes and blocks configured for the `metadata`\nTerraform sub block.\n\n\n\n**Args**:\n - `annotations` (`obj`): Annotations is a key value map stored with a resource that\nmay be set by external tools to store and retrieve arbitrary metadata. More\ninfo: http://kubernetes.io/docs/user-guide/annotations\n\n**Note**: The Cloud Run API may add additional annotations that were not provided in your config.\nIf terraform plan shows a diff where a server-side annotation is added, you can add it to your config\nor apply the lifecycle.ignore_changes rule to the metadata.0.annotations field.\n\nAnnotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted. Use the following annotation\nkeys to configure features on a Service:\n\n- 'run.googleapis.com/binary-authorization-breakglass' sets the [Binary Authorization breakglass](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--breakglass).\n- 'run.googleapis.com/binary-authorization' sets the [Binary Authorization](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--binary-authorization).\n- 'run.googleapis.com/client-name' sets the client name calling the Cloud Run API.\n- 'run.googleapis.com/custom-audiences' sets the [custom audiences](https://cloud.google.com/sdk/gcloud/reference/alpha/run/deploy#--add-custom-audiences)\n that can be used in the audience field of ID token for authenticated requests.\n- 'run.googleapis.com/description' sets a user defined description for the Service.\n- 'run.googleapis.com/ingress' sets the [ingress settings](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--ingress)\n for the Service. For example, '"run.googleapis.com/ingress" = "all"'.\n- 'run.googleapis.com/launch-stage' sets the [launch stage](https://cloud.google.com/run/docs/troubleshooting#launch-stage-validation)\n when a preview feature is used. For example, '"run.googleapis.com/launch-stage": "BETA"' When `null`, the `annotations` field will be omitted from the resulting object.\n - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand routes. When `null`, the `labels` field will be omitted from the resulting object.\n - `namespace` (`string`): In Cloud Run the namespace must be equal to either the\nproject ID or project number. When `null`, the `namespace` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `metadata` sub block.\n', args=[]), new( annotations=null, labels=null, @@ -63,7 +63,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), template:: { metadata:: { - '#new':: d.fn(help='\n`google.cloud_run_service.template.metadata.new` constructs a new object with attributes and blocks configured for the `metadata`\nTerraform sub block.\n\n\n\n**Args**:\n - `annotations` (`obj`): Annotations is a key value map stored with a resource that\nmay be set by external tools to store and retrieve arbitrary metadata.\n\n**Note**: The Cloud Run API may add additional annotations that were not provided in your config.\nIf terraform plan shows a diff where a server-side annotation is added, you can add it to your config\nor apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. When `null`, the `annotations` field will be omitted from the resulting object.\n - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name must be unique within a Google Cloud project and region.\nIs required when creating resources. Name is primarily intended\nfor creation idempotence and configuration definition. Cannot be updated. When `null`, the `name` field will be omitted from the resulting object.\n - `namespace` (`string`): In Cloud Run the namespace must be equal to either the\nproject ID or project number. It will default to the resource's project. When `null`, the `namespace` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `metadata` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.cloud_run_service.template.metadata.new` constructs a new object with attributes and blocks configured for the `metadata`\nTerraform sub block.\n\n\n\n**Args**:\n - `annotations` (`obj`): Annotations is a key value map stored with a resource that\nmay be set by external tools to store and retrieve arbitrary metadata. More\ninfo: http://kubernetes.io/docs/user-guide/annotations\n\n**Note**: The Cloud Run API may add additional annotations that were not provided in your config.\nIf terraform plan shows a diff where a server-side annotation is added, you can add it to your config\nor apply the lifecycle.ignore_changes rule to the metadata.0.annotations field.\n\nAnnotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted. Use the following annotation\nkeys to configure features on a Revision template:\n\n- 'autoscaling.knative.dev/maxScale' sets the [maximum number of container\n instances](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--max-instances) of the Revision to run.\n- 'autoscaling.knative.dev/minScale' sets the [minimum number of container\n instances](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--min-instances) of the Revision to run.\n- 'run.googleapis.com/client-name' sets the client name calling the Cloud Run API.\n- 'run.googleapis.com/cloudsql-instances' sets the [Cloud SQL\n instances](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--add-cloudsql-instances) the Revision connects to.\n- 'run.googleapis.com/cpu-throttling' sets whether to throttle the CPU when the container is not actively serving\n requests. See https://cloud.google.com/sdk/gcloud/reference/run/deploy#--[no-]cpu-throttling.\n- 'run.googleapis.com/encryption-key-shutdown-hours' sets the number of hours to wait before an automatic shutdown\n server after CMEK key revocation is detected.\n- 'run.googleapis.com/encryption-key' sets the [CMEK key](https://cloud.google.com/run/docs/securing/using-cmek)\n reference to encrypt the container with.\n- 'run.googleapis.com/execution-environment' sets the [execution\n environment](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--execution-environment)\n where the application will run.\n- 'run.googleapis.com/post-key-revocation-action-type' sets the\n [action type](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--post-key-revocation-action-type)\n after CMEK key revocation.\n- 'run.googleapis.com/secrets' sets a list of key-value pairs to set as\n [secrets](https://cloud.google.com/run/docs/configuring/secrets#yaml).\n- 'run.googleapis.com/sessionAffinity' sets whether to enable\n [session affinity](https://cloud.google.com/sdk/gcloud/reference/beta/run/deploy#--[no-]session-affinity)\n for connections to the Revision.\n- 'run.googleapis.com/startup-cpu-boost' sets whether to allocate extra CPU to containers on startup.\n See https://cloud.google.com/sdk/gcloud/reference/run/deploy#--[no-]cpu-boost.\n- 'run.googleapis.com/vpc-access-connector' sets a [VPC connector](https://cloud.google.com/run/docs/configuring/connecting-vpc#terraform_1)\n for the Revision.\n- 'run.googleapis.com/vpc-access-egress' sets the outbound traffic to send through the VPC connector for this resource.\n See https://cloud.google.com/sdk/gcloud/reference/run/deploy#--vpc-egress. When `null`, the `annotations` field will be omitted from the resulting object.\n - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name must be unique within a Google Cloud project and region.\nIs required when creating resources. Name is primarily intended\nfor creation idempotence and configuration definition. Cannot be updated. When `null`, the `name` field will be omitted from the resulting object.\n - `namespace` (`string`): In Cloud Run the namespace must be equal to either the\nproject ID or project number. It will default to the resource's project. When `null`, the `namespace` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `metadata` sub block.\n', args=[]), new( annotations=null, labels=null, diff --git a/4.x/_gen/resources/compute_firewall.libsonnet b/4.x/_gen/resources/compute_firewall.libsonnet index 83484d5..7d36f8a 100644 --- a/4.x/_gen/resources/compute_firewall.libsonnet +++ b/4.x/_gen/resources/compute_firewall.libsonnet @@ -30,7 +30,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); metadata: metadata, }), }, - '#new':: d.fn(help="\n`google.compute_firewall.new` injects a new `google_compute_firewall` 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 google.compute_firewall.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_firewall` using the reference:\n\n $._ref.google_compute_firewall.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_firewall.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 - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `destination_ranges` (`list`): If destination ranges are specified, the firewall will apply only to\ntraffic that has destination IP address in these ranges. These ranges\nmust be expressed in CIDR format. IPv4 or IPv6 ranges are supported. When `null`, the `destination_ranges` field will be omitted from the resulting object.\n - `direction` (`string`): Direction of traffic to which this firewall applies; default is\nINGRESS. Note: For INGRESS traffic, it is NOT supported to specify\ndestinationRanges; For EGRESS traffic, it is NOT supported to specify\n\u0026#39;source_ranges\u0026#39; OR \u0026#39;source_tags\u0026#39;. For INGRESS traffic, one of \u0026#39;source_ranges\u0026#39;,\n\u0026#39;source_tags\u0026#39; or \u0026#39;source_service_accounts\u0026#39; is required. Possible values: [\u0026#34;INGRESS\u0026#34;, \u0026#34;EGRESS\u0026#34;] When `null`, the `direction` field will be omitted from the resulting object.\n - `disabled` (`bool`): Denotes whether the firewall rule is disabled, i.e not applied to the\nnetwork it is associated with. When set to true, the firewall rule is\nnot enforced and the network behaves as if it did not exist. If this\nis unspecified, the firewall rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object.\n - `enable_logging` (`bool`): This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `network` (`string`): The name or self_link of the network to attach this firewall to.\n - `priority` (`number`): Priority for this rule. This is an integer between 0 and 65535, both\ninclusive. When not specified, the value assumed is 1000. Relative\npriorities determine precedence of conflicting rules. Lower value of\npriority implies higher precedence (eg, a rule with priority 0 has\nhigher precedence than a rule with priority 1). DENY rules take\nprecedence over ALLOW rules having equal priority. When `null`, the `priority` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `source_ranges` (`list`): If source ranges are specified, the firewall will apply only to\ntraffic that has source IP address in these ranges. These ranges must\nbe expressed in CIDR format. One or both of sourceRanges and\nsourceTags may be set. If both properties are set, the firewall will\napply to traffic that has source IP address within sourceRanges OR the\nsource IP that belongs to a tag listed in the sourceTags property. The\nconnection does not need to match both properties for the firewall to\napply. IPv4 or IPv6 ranges are supported. For INGRESS traffic, one of\n\u0026#39;source_ranges\u0026#39;, \u0026#39;source_tags\u0026#39; or \u0026#39;source_service_accounts\u0026#39; is required. When `null`, the `source_ranges` field will be omitted from the resulting object.\n - `source_service_accounts` (`list`): If source service accounts are specified, the firewall will apply only\nto traffic originating from an instance with a service account in this\nlist. Source service accounts cannot be used to control traffic to an\ninstance\u0026#39;s external IP address because service accounts are associated\nwith an instance, not an IP address. sourceRanges can be set at the\nsame time as sourceServiceAccounts. If both are set, the firewall will\napply to traffic that has source IP address within sourceRanges OR the\nsource IP belongs to an instance with service account listed in\nsourceServiceAccount. The connection does not need to match both\nproperties for the firewall to apply. sourceServiceAccounts cannot be\nused at the same time as sourceTags or targetTags. For INGRESS traffic,\none of \u0026#39;source_ranges\u0026#39;, \u0026#39;source_tags\u0026#39; or \u0026#39;source_service_accounts\u0026#39; is required. When `null`, the `source_service_accounts` field will be omitted from the resulting object.\n - `source_tags` (`list`): If source tags are specified, the firewall will apply only to traffic\nwith source IP that belongs to a tag listed in source tags. Source\ntags cannot be used to control traffic to an instance\u0026#39;s external IP\naddress. Because tags are associated with an instance, not an IP\naddress. One or both of sourceRanges and sourceTags may be set. If\nboth properties are set, the firewall will apply to traffic that has\nsource IP address within sourceRanges OR the source IP that belongs to\na tag listed in the sourceTags property. The connection does not need\nto match both properties for the firewall to apply. For INGRESS traffic,\none of \u0026#39;source_ranges\u0026#39;, \u0026#39;source_tags\u0026#39; or \u0026#39;source_service_accounts\u0026#39; is required. When `null`, the `source_tags` field will be omitted from the resulting object.\n - `target_service_accounts` (`list`): A list of service accounts indicating sets of instances located in the\nnetwork that may make network connections as specified in allowed[].\ntargetServiceAccounts cannot be used at the same time as targetTags or\nsourceTags. If neither targetServiceAccounts nor targetTags are\nspecified, the firewall rule applies to all instances on the specified\nnetwork. When `null`, the `target_service_accounts` field will be omitted from the resulting object.\n - `target_tags` (`list`): A list of instance tags indicating sets of instances located in the\nnetwork that may make network connections as specified in allowed[].\nIf no targetTags are specified, the firewall rule applies to all\ninstances on the specified network. When `null`, the `target_tags` field will be omitted from the resulting object.\n - `allow` (`list[obj]`): The list of ALLOW rules specified by this firewall. Each rule\nspecifies a protocol and port-range tuple that describes a permitted\nconnection. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.allow.new](#fn-allownew) constructor.\n - `deny` (`list[obj]`): The list of DENY rules specified by this firewall. Each rule specifies\na protocol and port-range tuple that describes a denied connection. When `null`, the `deny` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.deny.new](#fn-denynew) constructor.\n - `log_config` (`list[obj]`): This field denotes the logging options for a particular firewall rule.\nIf defined, logging is enabled, and logs will be exported to Cloud Logging. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.log_config.new](#fn-log_confignew) constructor.\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 [google.compute_firewall.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`google.compute_firewall.new` injects a new `google_compute_firewall` 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 google.compute_firewall.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_firewall` using the reference:\n\n $._ref.google_compute_firewall.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_firewall.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 - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `destination_ranges` (`list`): If destination ranges are specified, the firewall will apply only to\ntraffic that has destination IP address in these ranges. These ranges\nmust be expressed in CIDR format. IPv4 or IPv6 ranges are supported. When `null`, the `destination_ranges` field will be omitted from the resulting object.\n - `direction` (`string`): Direction of traffic to which this firewall applies; default is\nINGRESS. Note: For INGRESS traffic, one of \u0026#39;source_ranges\u0026#39;,\n\u0026#39;source_tags\u0026#39; or \u0026#39;source_service_accounts\u0026#39; is required. Possible values: [\u0026#34;INGRESS\u0026#34;, \u0026#34;EGRESS\u0026#34;] When `null`, the `direction` field will be omitted from the resulting object.\n - `disabled` (`bool`): Denotes whether the firewall rule is disabled, i.e not applied to the\nnetwork it is associated with. When set to true, the firewall rule is\nnot enforced and the network behaves as if it did not exist. If this\nis unspecified, the firewall rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object.\n - `enable_logging` (`bool`): This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `network` (`string`): The name or self_link of the network to attach this firewall to.\n - `priority` (`number`): Priority for this rule. This is an integer between 0 and 65535, both\ninclusive. When not specified, the value assumed is 1000. Relative\npriorities determine precedence of conflicting rules. Lower value of\npriority implies higher precedence (eg, a rule with priority 0 has\nhigher precedence than a rule with priority 1). DENY rules take\nprecedence over ALLOW rules having equal priority. When `null`, the `priority` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `source_ranges` (`list`): If source ranges are specified, the firewall will apply only to\ntraffic that has source IP address in these ranges. These ranges must\nbe expressed in CIDR format. One or both of sourceRanges and\nsourceTags may be set. If both properties are set, the firewall will\napply to traffic that has source IP address within sourceRanges OR the\nsource IP that belongs to a tag listed in the sourceTags property. The\nconnection does not need to match both properties for the firewall to\napply. IPv4 or IPv6 ranges are supported. For INGRESS traffic, one of\n\u0026#39;source_ranges\u0026#39;, \u0026#39;source_tags\u0026#39; or \u0026#39;source_service_accounts\u0026#39; is required. When `null`, the `source_ranges` field will be omitted from the resulting object.\n - `source_service_accounts` (`list`): If source service accounts are specified, the firewall will apply only\nto traffic originating from an instance with a service account in this\nlist. Source service accounts cannot be used to control traffic to an\ninstance\u0026#39;s external IP address because service accounts are associated\nwith an instance, not an IP address. sourceRanges can be set at the\nsame time as sourceServiceAccounts. If both are set, the firewall will\napply to traffic that has source IP address within sourceRanges OR the\nsource IP belongs to an instance with service account listed in\nsourceServiceAccount. The connection does not need to match both\nproperties for the firewall to apply. sourceServiceAccounts cannot be\nused at the same time as sourceTags or targetTags. For INGRESS traffic,\none of \u0026#39;source_ranges\u0026#39;, \u0026#39;source_tags\u0026#39; or \u0026#39;source_service_accounts\u0026#39; is required. When `null`, the `source_service_accounts` field will be omitted from the resulting object.\n - `source_tags` (`list`): If source tags are specified, the firewall will apply only to traffic\nwith source IP that belongs to a tag listed in source tags. Source\ntags cannot be used to control traffic to an instance\u0026#39;s external IP\naddress. Because tags are associated with an instance, not an IP\naddress. One or both of sourceRanges and sourceTags may be set. If\nboth properties are set, the firewall will apply to traffic that has\nsource IP address within sourceRanges OR the source IP that belongs to\na tag listed in the sourceTags property. The connection does not need\nto match both properties for the firewall to apply. For INGRESS traffic,\none of \u0026#39;source_ranges\u0026#39;, \u0026#39;source_tags\u0026#39; or \u0026#39;source_service_accounts\u0026#39; is required. When `null`, the `source_tags` field will be omitted from the resulting object.\n - `target_service_accounts` (`list`): A list of service accounts indicating sets of instances located in the\nnetwork that may make network connections as specified in allowed[].\ntargetServiceAccounts cannot be used at the same time as targetTags or\nsourceTags. If neither targetServiceAccounts nor targetTags are\nspecified, the firewall rule applies to all instances on the specified\nnetwork. When `null`, the `target_service_accounts` field will be omitted from the resulting object.\n - `target_tags` (`list`): A list of instance tags indicating sets of instances located in the\nnetwork that may make network connections as specified in allowed[].\nIf no targetTags are specified, the firewall rule applies to all\ninstances on the specified network. When `null`, the `target_tags` field will be omitted from the resulting object.\n - `allow` (`list[obj]`): The list of ALLOW rules specified by this firewall. Each rule\nspecifies a protocol and port-range tuple that describes a permitted\nconnection. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.allow.new](#fn-allownew) constructor.\n - `deny` (`list[obj]`): The list of DENY rules specified by this firewall. Each rule specifies\na protocol and port-range tuple that describes a denied connection. When `null`, the `deny` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.deny.new](#fn-denynew) constructor.\n - `log_config` (`list[obj]`): This field denotes the logging options for a particular firewall rule.\nIf defined, logging is enabled, and logs will be exported to Cloud Logging. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.log_config.new](#fn-log_confignew) constructor.\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 [google.compute_firewall.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, name, @@ -77,7 +77,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.compute_firewall.newAttrs` constructs a new object with attributes and blocks configured for the `compute_firewall`\nTerraform resource.\n\nUnlike [google.compute_firewall.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 - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `destination_ranges` (`list`): If destination ranges are specified, the firewall will apply only to\ntraffic that has destination IP address in these ranges. These ranges\nmust be expressed in CIDR format. IPv4 or IPv6 ranges are supported. When `null`, the `destination_ranges` field will be omitted from the resulting object.\n - `direction` (`string`): Direction of traffic to which this firewall applies; default is\nINGRESS. Note: For INGRESS traffic, it is NOT supported to specify\ndestinationRanges; For EGRESS traffic, it is NOT supported to specify\n'source_ranges' OR 'source_tags'. For INGRESS traffic, one of 'source_ranges',\n'source_tags' or 'source_service_accounts' is required. Possible values: ["INGRESS", "EGRESS"] When `null`, the `direction` field will be omitted from the resulting object.\n - `disabled` (`bool`): Denotes whether the firewall rule is disabled, i.e not applied to the\nnetwork it is associated with. When set to true, the firewall rule is\nnot enforced and the network behaves as if it did not exist. If this\nis unspecified, the firewall rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object.\n - `enable_logging` (`bool`): This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `network` (`string`): The name or self_link of the network to attach this firewall to.\n - `priority` (`number`): Priority for this rule. This is an integer between 0 and 65535, both\ninclusive. When not specified, the value assumed is 1000. Relative\npriorities determine precedence of conflicting rules. Lower value of\npriority implies higher precedence (eg, a rule with priority 0 has\nhigher precedence than a rule with priority 1). DENY rules take\nprecedence over ALLOW rules having equal priority. When `null`, the `priority` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `source_ranges` (`list`): If source ranges are specified, the firewall will apply only to\ntraffic that has source IP address in these ranges. These ranges must\nbe expressed in CIDR format. One or both of sourceRanges and\nsourceTags may be set. If both properties are set, the firewall will\napply to traffic that has source IP address within sourceRanges OR the\nsource IP that belongs to a tag listed in the sourceTags property. The\nconnection does not need to match both properties for the firewall to\napply. IPv4 or IPv6 ranges are supported. For INGRESS traffic, one of\n'source_ranges', 'source_tags' or 'source_service_accounts' is required. When `null`, the `source_ranges` field will be omitted from the resulting object.\n - `source_service_accounts` (`list`): If source service accounts are specified, the firewall will apply only\nto traffic originating from an instance with a service account in this\nlist. Source service accounts cannot be used to control traffic to an\ninstance's external IP address because service accounts are associated\nwith an instance, not an IP address. sourceRanges can be set at the\nsame time as sourceServiceAccounts. If both are set, the firewall will\napply to traffic that has source IP address within sourceRanges OR the\nsource IP belongs to an instance with service account listed in\nsourceServiceAccount. The connection does not need to match both\nproperties for the firewall to apply. sourceServiceAccounts cannot be\nused at the same time as sourceTags or targetTags. For INGRESS traffic,\none of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. When `null`, the `source_service_accounts` field will be omitted from the resulting object.\n - `source_tags` (`list`): If source tags are specified, the firewall will apply only to traffic\nwith source IP that belongs to a tag listed in source tags. Source\ntags cannot be used to control traffic to an instance's external IP\naddress. Because tags are associated with an instance, not an IP\naddress. One or both of sourceRanges and sourceTags may be set. If\nboth properties are set, the firewall will apply to traffic that has\nsource IP address within sourceRanges OR the source IP that belongs to\na tag listed in the sourceTags property. The connection does not need\nto match both properties for the firewall to apply. For INGRESS traffic,\none of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. When `null`, the `source_tags` field will be omitted from the resulting object.\n - `target_service_accounts` (`list`): A list of service accounts indicating sets of instances located in the\nnetwork that may make network connections as specified in allowed[].\ntargetServiceAccounts cannot be used at the same time as targetTags or\nsourceTags. If neither targetServiceAccounts nor targetTags are\nspecified, the firewall rule applies to all instances on the specified\nnetwork. When `null`, the `target_service_accounts` field will be omitted from the resulting object.\n - `target_tags` (`list`): A list of instance tags indicating sets of instances located in the\nnetwork that may make network connections as specified in allowed[].\nIf no targetTags are specified, the firewall rule applies to all\ninstances on the specified network. When `null`, the `target_tags` field will be omitted from the resulting object.\n - `allow` (`list[obj]`): The list of ALLOW rules specified by this firewall. Each rule\nspecifies a protocol and port-range tuple that describes a permitted\nconnection. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.allow.new](#fn-allownew) constructor.\n - `deny` (`list[obj]`): The list of DENY rules specified by this firewall. Each rule specifies\na protocol and port-range tuple that describes a denied connection. When `null`, the `deny` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.deny.new](#fn-denynew) constructor.\n - `log_config` (`list[obj]`): This field denotes the logging options for a particular firewall rule.\nIf defined, logging is enabled, and logs will be exported to Cloud Logging. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.log_config.new](#fn-log_confignew) constructor.\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 [google.compute_firewall.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 `compute_firewall` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.compute_firewall.newAttrs` constructs a new object with attributes and blocks configured for the `compute_firewall`\nTerraform resource.\n\nUnlike [google.compute_firewall.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 - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `destination_ranges` (`list`): If destination ranges are specified, the firewall will apply only to\ntraffic that has destination IP address in these ranges. These ranges\nmust be expressed in CIDR format. IPv4 or IPv6 ranges are supported. When `null`, the `destination_ranges` field will be omitted from the resulting object.\n - `direction` (`string`): Direction of traffic to which this firewall applies; default is\nINGRESS. Note: For INGRESS traffic, one of 'source_ranges',\n'source_tags' or 'source_service_accounts' is required. Possible values: ["INGRESS", "EGRESS"] When `null`, the `direction` field will be omitted from the resulting object.\n - `disabled` (`bool`): Denotes whether the firewall rule is disabled, i.e not applied to the\nnetwork it is associated with. When set to true, the firewall rule is\nnot enforced and the network behaves as if it did not exist. If this\nis unspecified, the firewall rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object.\n - `enable_logging` (`bool`): This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `network` (`string`): The name or self_link of the network to attach this firewall to.\n - `priority` (`number`): Priority for this rule. This is an integer between 0 and 65535, both\ninclusive. When not specified, the value assumed is 1000. Relative\npriorities determine precedence of conflicting rules. Lower value of\npriority implies higher precedence (eg, a rule with priority 0 has\nhigher precedence than a rule with priority 1). DENY rules take\nprecedence over ALLOW rules having equal priority. When `null`, the `priority` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `source_ranges` (`list`): If source ranges are specified, the firewall will apply only to\ntraffic that has source IP address in these ranges. These ranges must\nbe expressed in CIDR format. One or both of sourceRanges and\nsourceTags may be set. If both properties are set, the firewall will\napply to traffic that has source IP address within sourceRanges OR the\nsource IP that belongs to a tag listed in the sourceTags property. The\nconnection does not need to match both properties for the firewall to\napply. IPv4 or IPv6 ranges are supported. For INGRESS traffic, one of\n'source_ranges', 'source_tags' or 'source_service_accounts' is required. When `null`, the `source_ranges` field will be omitted from the resulting object.\n - `source_service_accounts` (`list`): If source service accounts are specified, the firewall will apply only\nto traffic originating from an instance with a service account in this\nlist. Source service accounts cannot be used to control traffic to an\ninstance's external IP address because service accounts are associated\nwith an instance, not an IP address. sourceRanges can be set at the\nsame time as sourceServiceAccounts. If both are set, the firewall will\napply to traffic that has source IP address within sourceRanges OR the\nsource IP belongs to an instance with service account listed in\nsourceServiceAccount. The connection does not need to match both\nproperties for the firewall to apply. sourceServiceAccounts cannot be\nused at the same time as sourceTags or targetTags. For INGRESS traffic,\none of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. When `null`, the `source_service_accounts` field will be omitted from the resulting object.\n - `source_tags` (`list`): If source tags are specified, the firewall will apply only to traffic\nwith source IP that belongs to a tag listed in source tags. Source\ntags cannot be used to control traffic to an instance's external IP\naddress. Because tags are associated with an instance, not an IP\naddress. One or both of sourceRanges and sourceTags may be set. If\nboth properties are set, the firewall will apply to traffic that has\nsource IP address within sourceRanges OR the source IP that belongs to\na tag listed in the sourceTags property. The connection does not need\nto match both properties for the firewall to apply. For INGRESS traffic,\none of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. When `null`, the `source_tags` field will be omitted from the resulting object.\n - `target_service_accounts` (`list`): A list of service accounts indicating sets of instances located in the\nnetwork that may make network connections as specified in allowed[].\ntargetServiceAccounts cannot be used at the same time as targetTags or\nsourceTags. If neither targetServiceAccounts nor targetTags are\nspecified, the firewall rule applies to all instances on the specified\nnetwork. When `null`, the `target_service_accounts` field will be omitted from the resulting object.\n - `target_tags` (`list`): A list of instance tags indicating sets of instances located in the\nnetwork that may make network connections as specified in allowed[].\nIf no targetTags are specified, the firewall rule applies to all\ninstances on the specified network. When `null`, the `target_tags` field will be omitted from the resulting object.\n - `allow` (`list[obj]`): The list of ALLOW rules specified by this firewall. Each rule\nspecifies a protocol and port-range tuple that describes a permitted\nconnection. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.allow.new](#fn-allownew) constructor.\n - `deny` (`list[obj]`): The list of DENY rules specified by this firewall. Each rule specifies\na protocol and port-range tuple that describes a denied connection. When `null`, the `deny` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.deny.new](#fn-denynew) constructor.\n - `log_config` (`list[obj]`): This field denotes the logging options for a particular firewall rule.\nIf defined, logging is enabled, and logs will be exported to Cloud Logging. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_firewall.log_config.new](#fn-log_confignew) constructor.\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 [google.compute_firewall.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 `compute_firewall` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, network, diff --git a/4.x/_gen/resources/compute_public_advertised_prefix.libsonnet b/4.x/_gen/resources/compute_public_advertised_prefix.libsonnet new file mode 100644 index 0000000..d1c1a01 --- /dev/null +++ b/4.x/_gen/resources/compute_public_advertised_prefix.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='compute_public_advertised_prefix', url='', help='`compute_public_advertised_prefix` represents the `google_compute_public_advertised_prefix` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google.compute_public_advertised_prefix.new` injects a new `google_compute_public_advertised_prefix` 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 google.compute_public_advertised_prefix.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_public_advertised_prefix` using the reference:\n\n $._ref.google_compute_public_advertised_prefix.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_public_advertised_prefix.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 - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `dns_verification_ip` (`string`): The IPv4 address to be used for reverse DNS verification.\n - `ip_cidr_range` (`string`): The IPv4 address range, in CIDR format, represented by this public advertised prefix.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long, and\ncomply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39;\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` 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 [google.compute_public_advertised_prefix.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, + dns_verification_ip, + ip_cidr_range, + name, + description=null, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_compute_public_advertised_prefix', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + dns_verification_ip=dns_verification_ip, + ip_cidr_range=ip_cidr_range, + name=name, + project=project, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.compute_public_advertised_prefix.newAttrs` constructs a new object with attributes and blocks configured for the `compute_public_advertised_prefix`\nTerraform resource.\n\nUnlike [google.compute_public_advertised_prefix.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 - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `dns_verification_ip` (`string`): The IPv4 address to be used for reverse DNS verification.\n - `ip_cidr_range` (`string`): The IPv4 address range, in CIDR format, represented by this public advertised prefix.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long, and\ncomply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?'\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` 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 [google.compute_public_advertised_prefix.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 `compute_public_advertised_prefix` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + dns_verification_ip, + ip_cidr_range, + name, + description=null, + project=null, + timeouts=null + ):: std.prune(a={ + description: description, + dns_verification_ip: dns_verification_ip, + ip_cidr_range: ip_cidr_range, + name: name, + project: project, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.compute_public_advertised_prefix.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 - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withDescription':: d.fn(help='`google.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+: { + google_compute_public_advertised_prefix+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDnsVerificationIp':: d.fn(help='`google.string.withDnsVerificationIp` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the dns_verification_ip 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 `dns_verification_ip` field.\n', args=[]), + withDnsVerificationIp(resourceLabel, value): { + resource+: { + google_compute_public_advertised_prefix+: { + [resourceLabel]+: { + dns_verification_ip: value, + }, + }, + }, + }, + '#withIpCidrRange':: d.fn(help='`google.string.withIpCidrRange` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the ip_cidr_range 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 `ip_cidr_range` field.\n', args=[]), + withIpCidrRange(resourceLabel, value): { + resource+: { + google_compute_public_advertised_prefix+: { + [resourceLabel]+: { + ip_cidr_range: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.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+: { + google_compute_public_advertised_prefix+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project 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` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_compute_public_advertised_prefix+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_compute_public_advertised_prefix+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts 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 [google.obj.withTimeouts](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 `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_compute_public_advertised_prefix+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/compute_public_delegated_prefix.libsonnet b/4.x/_gen/resources/compute_public_delegated_prefix.libsonnet new file mode 100644 index 0000000..28999da --- /dev/null +++ b/4.x/_gen/resources/compute_public_delegated_prefix.libsonnet @@ -0,0 +1,152 @@ +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='compute_public_delegated_prefix', url='', help='`compute_public_delegated_prefix` represents the `google_compute_public_delegated_prefix` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google.compute_public_delegated_prefix.new` injects a new `google_compute_public_delegated_prefix` 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 google.compute_public_delegated_prefix.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_public_delegated_prefix` using the reference:\n\n $._ref.google_compute_public_delegated_prefix.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_public_delegated_prefix.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 - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_cidr_range` (`string`): The IPv4 address range, in CIDR format, represented by this public advertised prefix.\n - `is_live_migration` (`bool`): If true, the prefix will be live migrated. When `null`, the `is_live_migration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long, and\ncomply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39;\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `parent_prefix` (`string`): The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A region where the prefix will reside.\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 [google.compute_public_delegated_prefix.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, + ip_cidr_range, + name, + parent_prefix, + region, + description=null, + is_live_migration=null, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_compute_public_delegated_prefix', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + ip_cidr_range=ip_cidr_range, + is_live_migration=is_live_migration, + name=name, + parent_prefix=parent_prefix, + project=project, + region=region, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.compute_public_delegated_prefix.newAttrs` constructs a new object with attributes and blocks configured for the `compute_public_delegated_prefix`\nTerraform resource.\n\nUnlike [google.compute_public_delegated_prefix.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 - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_cidr_range` (`string`): The IPv4 address range, in CIDR format, represented by this public advertised prefix.\n - `is_live_migration` (`bool`): If true, the prefix will be live migrated. When `null`, the `is_live_migration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long, and\ncomply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?'\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `parent_prefix` (`string`): The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A region where the prefix will reside.\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 [google.compute_public_delegated_prefix.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 `compute_public_delegated_prefix` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + ip_cidr_range, + name, + parent_prefix, + region, + description=null, + is_live_migration=null, + project=null, + timeouts=null + ):: std.prune(a={ + description: description, + ip_cidr_range: ip_cidr_range, + is_live_migration: is_live_migration, + name: name, + parent_prefix: parent_prefix, + project: project, + region: region, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.compute_public_delegated_prefix.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 - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withDescription':: d.fn(help='`google.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+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withIpCidrRange':: d.fn(help='`google.string.withIpCidrRange` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the ip_cidr_range 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 `ip_cidr_range` field.\n', args=[]), + withIpCidrRange(resourceLabel, value): { + resource+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + ip_cidr_range: value, + }, + }, + }, + }, + '#withIsLiveMigration':: d.fn(help='`google.bool.withIsLiveMigration` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the is_live_migration 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 `is_live_migration` field.\n', args=[]), + withIsLiveMigration(resourceLabel, value): { + resource+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + is_live_migration: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.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+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withParentPrefix':: d.fn(help='`google.string.withParentPrefix` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the parent_prefix 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 `parent_prefix` field.\n', args=[]), + withParentPrefix(resourceLabel, value): { + resource+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + parent_prefix: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project 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` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRegion':: d.fn(help='`google.string.withRegion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the region 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 `region` field.\n', args=[]), + withRegion(resourceLabel, value): { + resource+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + region: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts 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 [google.obj.withTimeouts](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 `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_compute_public_delegated_prefix+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/compute_region_commitment.libsonnet b/4.x/_gen/resources/compute_region_commitment.libsonnet new file mode 100644 index 0000000..ea6d3ac --- /dev/null +++ b/4.x/_gen/resources/compute_region_commitment.libsonnet @@ -0,0 +1,238 @@ +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='compute_region_commitment', url='', help='`compute_region_commitment` represents the `google_compute_region_commitment` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + license_resource:: { + '#new':: d.fn(help='\n`google.compute_region_commitment.license_resource.new` constructs a new object with attributes and blocks configured for the `license_resource`\nTerraform sub block.\n\n\n\n**Args**:\n - `amount` (`string`): The number of licenses purchased. When `null`, the `amount` field will be omitted from the resulting object.\n - `cores_per_license` (`string`): Specifies the core range of the instance for which this license applies. When `null`, the `cores_per_license` field will be omitted from the resulting object.\n - `license` (`string`): Any applicable license URI.\n\n**Returns**:\n - An attribute object that represents the `license_resource` sub block.\n', args=[]), + new( + license, + amount=null, + cores_per_license=null + ):: std.prune(a={ + amount: amount, + cores_per_license: cores_per_license, + license: license, + }), + }, + '#new':: d.fn(help="\n`google.compute_region_commitment.new` injects a new `google_compute_region_commitment` 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 google.compute_region_commitment.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_region_commitment` using the reference:\n\n $._ref.google_compute_region_commitment.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_region_commitment.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 - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. \nThe default value is false if not specified. \nIf the field is set to true, the commitment will be automatically renewed for either \none or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object.\n - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of\nmachine resources such as VCPU or MEMORY, listed in resources. Category LICENSE\nspecifies commitments composed of software licenses, listed in licenseResources.\nNote that only MACHINE commitments should have a Type specified. Possible values: [\u0026#34;LICENSE\u0026#34;, \u0026#34;MACHINE\u0026#34;] When `null`, the `category` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `plan` (`string`): The plan for this commitment, which determines duration and discount rate.\nThe currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: [\u0026#34;TWELVE_MONTH\u0026#34;, \u0026#34;THIRTY_SIX_MONTH\u0026#34;]\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. \nType MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized\nmachines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to\naccelerator optimized machines. Possible values: [\u0026#34;MEMORY_OPTIMIZED\u0026#34;, \u0026#34;ACCELERATOR_OPTIMIZED\u0026#34;] When `null`, the `type` field will be omitted from the resulting object.\n - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor.\n - `resources` (`list[obj]`): A list of commitment amounts for particular resources. \nNote that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_commitment.resources.new](#fn-resourcesnew) constructor.\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 [google.compute_region_commitment.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, + name, + plan, + auto_renew=null, + category=null, + description=null, + license_resource=null, + project=null, + region=null, + resources=null, + timeouts=null, + type=null, + _meta={} + ):: tf.withResource( + type='google_compute_region_commitment', + label=resourceLabel, + attrs=self.newAttrs( + auto_renew=auto_renew, + category=category, + description=description, + license_resource=license_resource, + name=name, + plan=plan, + project=project, + region=region, + resources=resources, + timeouts=timeouts, + type=type + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.compute_region_commitment.newAttrs` constructs a new object with attributes and blocks configured for the `compute_region_commitment`\nTerraform resource.\n\nUnlike [google.compute_region_commitment.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 - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. \nThe default value is false if not specified. \nIf the field is set to true, the commitment will be automatically renewed for either \none or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object.\n - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of\nmachine resources such as VCPU or MEMORY, listed in resources. Category LICENSE\nspecifies commitments composed of software licenses, listed in licenseResources.\nNote that only MACHINE commitments should have a Type specified. Possible values: ["LICENSE", "MACHINE"] When `null`, the `category` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `plan` (`string`): The plan for this commitment, which determines duration and discount rate.\nThe currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: ["TWELVE_MONTH", "THIRTY_SIX_MONTH"]\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. \nType MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized\nmachines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to\naccelerator optimized machines. Possible values: ["MEMORY_OPTIMIZED", "ACCELERATOR_OPTIMIZED"] When `null`, the `type` field will be omitted from the resulting object.\n - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor.\n - `resources` (`list[obj]`): A list of commitment amounts for particular resources. \nNote that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_commitment.resources.new](#fn-resourcesnew) constructor.\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 [google.compute_region_commitment.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 `compute_region_commitment` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + plan, + auto_renew=null, + category=null, + description=null, + license_resource=null, + project=null, + region=null, + resources=null, + timeouts=null, + type=null + ):: std.prune(a={ + auto_renew: auto_renew, + category: category, + description: description, + license_resource: license_resource, + name: name, + plan: plan, + project: project, + region: region, + resources: resources, + timeouts: timeouts, + type: type, + }), + resources:: { + '#new':: d.fn(help='\n`google.compute_region_commitment.resources.new` constructs a new object with attributes and blocks configured for the `resources`\nTerraform sub block.\n\n\n\n**Args**:\n - `accelerator_type` (`string`): Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. When `null`, the `accelerator_type` field will be omitted from the resulting object.\n - `amount` (`string`): The amount of the resource purchased (in a type-dependent unit,\nsuch as bytes). For vCPUs, this can just be an integer. For memory,\nthis must be provided in MB. Memory must be a multiple of 256 MB,\nwith up to 6.5GB of memory per every vCPU. When `null`, the `amount` field will be omitted from the resulting object.\n - `type` (`string`): Type of resource for which this commitment applies.\nPossible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. When `null`, the `type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resources` sub block.\n', args=[]), + new( + accelerator_type=null, + amount=null, + type=null + ):: std.prune(a={ + accelerator_type: accelerator_type, + amount: amount, + type: type, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google.compute_region_commitment.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 - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withAutoRenew':: d.fn(help='`google.bool.withAutoRenew` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the auto_renew 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 `auto_renew` field.\n', args=[]), + withAutoRenew(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + auto_renew: value, + }, + }, + }, + }, + '#withCategory':: d.fn(help='`google.string.withCategory` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the category 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 `category` field.\n', args=[]), + withCategory(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + category: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`google.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+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withLicenseResource':: d.fn(help='`google.list[obj].withLicenseResource` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the license_resource field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withLicenseResourceMixin](TODO) function.\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 `license_resource` field.\n', args=[]), + withLicenseResource(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + license_resource: value, + }, + }, + }, + }, + '#withLicenseResourceMixin':: d.fn(help='`google.list[obj].withLicenseResourceMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the license_resource 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 [google.list[obj].withLicenseResource](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 `license_resource` field.\n', args=[]), + withLicenseResourceMixin(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + license_resource+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withName':: d.fn(help='`google.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+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withPlan':: d.fn(help='`google.string.withPlan` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the plan 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 `plan` field.\n', args=[]), + withPlan(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + plan: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project 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` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRegion':: d.fn(help='`google.string.withRegion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the region 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 `region` field.\n', args=[]), + withRegion(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + region: value, + }, + }, + }, + }, + '#withResources':: d.fn(help='`google.list[obj].withResources` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the resources field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withResourcesMixin](TODO) function.\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 `resources` field.\n', args=[]), + withResources(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + resources: value, + }, + }, + }, + }, + '#withResourcesMixin':: d.fn(help='`google.list[obj].withResourcesMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the resources 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 [google.list[obj].withResources](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 `resources` field.\n', args=[]), + withResourcesMixin(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + resources+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts 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 [google.obj.withTimeouts](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 `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withType':: d.fn(help='`google.string.withType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the type 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 `type` field.\n', args=[]), + withType(resourceLabel, value): { + resource+: { + google_compute_region_commitment+: { + [resourceLabel]+: { + type: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/compute_target_https_proxy.libsonnet b/4.x/_gen/resources/compute_target_https_proxy.libsonnet index 8e3d738..65d9caa 100644 --- a/4.x/_gen/resources/compute_target_https_proxy.libsonnet +++ b/4.x/_gen/resources/compute_target_https_proxy.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='compute_target_https_proxy', url='', help='`compute_target_https_proxy` represents the `google_compute_target_https_proxy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google.compute_target_https_proxy.new` injects a new `google_compute_target_https_proxy` 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 google.compute_target_https_proxy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_target_https_proxy` using the reference:\n\n $._ref.google_compute_target_https_proxy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_target_https_proxy.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 - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map \nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is \u0026#39;//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}\u0026#39;. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, uses the QUIC policy with no user overrides, which is\nequivalent to DISABLE. Default value: \u0026#34;NONE\u0026#34; Possible values: [\u0026#34;NONE\u0026#34;, \u0026#34;ENABLE\u0026#34;, \u0026#34;DISABLE\u0026#34;] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\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 [google.compute_target_https_proxy.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`google.compute_target_https_proxy.new` injects a new `google_compute_target_https_proxy` 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 google.compute_target_https_proxy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_target_https_proxy` using the reference:\n\n $._ref.google_compute_target_https_proxy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_target_https_proxy.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 - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map \nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is \u0026#39;//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}\u0026#39;. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: \u0026#34;NONE\u0026#34; Possible values: [\u0026#34;NONE\u0026#34;, \u0026#34;ENABLE\u0026#34;, \u0026#34;DISABLE\u0026#34;] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\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 [google.compute_target_https_proxy.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, name, @@ -33,7 +33,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.compute_target_https_proxy.newAttrs` constructs a new object with attributes and blocks configured for the `compute_target_https_proxy`\nTerraform resource.\n\nUnlike [google.compute_target_https_proxy.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 - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map \nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is '//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}'. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, uses the QUIC policy with no user overrides, which is\nequivalent to DISABLE. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\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 [google.compute_target_https_proxy.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 `compute_target_https_proxy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.compute_target_https_proxy.newAttrs` constructs a new object with attributes and blocks configured for the `compute_target_https_proxy`\nTerraform resource.\n\nUnlike [google.compute_target_https_proxy.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 - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map \nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is '//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}'. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\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 [google.compute_target_https_proxy.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 `compute_target_https_proxy` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, url_map, diff --git a/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet b/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet index 0509332..9682487 100644 --- a/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet +++ b/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet @@ -4,13 +4,69 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); '#':: d.pkg(name='data_loss_prevention_job_trigger', url='', help='`data_loss_prevention_job_trigger` represents the `google_data_loss_prevention_job_trigger` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), inspect_job:: { actions:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.actions.new` constructs a new object with attributes and blocks configured for the `actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `pub_sub` (`list[obj]`): Publish a message into a given Pub/Sub topic when the job completes. When `null`, the `pub_sub` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.pub_sub.new](#fn-inspect_jobinspect_jobpub_subnew) constructor.\n - `publish_findings_to_cloud_data_catalog` (`list[obj]`): Publish findings of a DlpJob to Data Catalog. When `null`, the `publish_findings_to_cloud_data_catalog` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.publish_findings_to_cloud_data_catalog.new](#fn-inspect_jobinspect_jobpublish_findings_to_cloud_data_catalognew) constructor.\n - `publish_summary_to_cscc` (`list[obj]`): Publish the result summary of a DlpJob to the Cloud Security Command Center. When `null`, the `publish_summary_to_cscc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.publish_summary_to_cscc.new](#fn-inspect_jobinspect_jobpublish_summary_to_csccnew) constructor.\n - `save_findings` (`list[obj]`): If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk When `null`, the `save_findings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.save_findings.new](#fn-inspect_jobinspect_jobsave_findingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `actions` sub block.\n', args=[]), + deidentify:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.new` constructs a new object with attributes and blocks configured for the `deidentify`\nTerraform sub block.\n\n\n\n**Args**:\n - `cloud_storage_output` (`string`): User settable Cloud Storage bucket and folders to store de-identified files.\n\nThis field must be set for cloud storage deidentification.\n\nThe output Cloud Storage bucket must be different from the input bucket.\n\nDe-identified files will overwrite files in the output path.\n\nForm of: gs://bucket/folder/ or gs://bucket\n - `file_types_to_transform` (`list`): List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed.\n\nIf empty, all supported files will be transformed. Supported types may be automatically added over time. \n\nIf a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Possible values: ["IMAGE", "TEXT_FILE", "CSV", "TSV"] When `null`, the `file_types_to_transform` field will be omitted from the resulting object.\n - `transformation_config` (`list[obj]`): User specified deidentify templates and configs for structured, unstructured, and image files. When `null`, the `transformation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_config.new](#fn-inspect_jobinspect_jobactionstransformation_confignew) constructor.\n - `transformation_details_storage_config` (`list[obj]`): Config for storing transformation details. When `null`, the `transformation_details_storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.new](#fn-inspect_jobinspect_jobactionstransformation_details_storage_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `deidentify` sub block.\n', args=[]), + new( + cloud_storage_output, + file_types_to_transform=null, + transformation_config=null, + transformation_details_storage_config=null + ):: std.prune(a={ + cloud_storage_output: cloud_storage_output, + file_types_to_transform: file_types_to_transform, + transformation_config: transformation_config, + transformation_details_storage_config: transformation_details_storage_config, + }), + transformation_config:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_config.new` constructs a new object with attributes and blocks configured for the `transformation_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `deidentify_template` (`string`): If this template is specified, it will serve as the default de-identify template. When `null`, the `deidentify_template` field will be omitted from the resulting object.\n - `image_redact_template` (`string`): If this template is specified, it will serve as the de-identify template for images. When `null`, the `image_redact_template` field will be omitted from the resulting object.\n - `structured_deidentify_template` (`string`): If this template is specified, it will serve as the de-identify template for structured content such as delimited files and tables. When `null`, the `structured_deidentify_template` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `transformation_config` sub block.\n', args=[]), + new( + deidentify_template=null, + image_redact_template=null, + structured_deidentify_template=null + ):: std.prune(a={ + deidentify_template: deidentify_template, + image_redact_template: image_redact_template, + structured_deidentify_template: structured_deidentify_template, + }), + }, + transformation_details_storage_config:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.new` constructs a new object with attributes and blocks configured for the `transformation_details_storage_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `table` (`list[obj]`): The BigQuery table in which to store the output. When `null`, the `table` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.table.new](#fn-inspect_jobinspect_jobactionsdeidentifytablenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transformation_details_storage_config` sub block.\n', args=[]), + new( + table=null + ):: std.prune(a={ + table: table, + }), + table:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.table.new` constructs a new object with attributes and blocks configured for the `table`\nTerraform sub block.\n\n\n\n**Args**:\n - `dataset_id` (`string`): The ID of the dataset containing this table.\n - `project_id` (`string`): The ID of the project containing this table.\n - `table_id` (`string`): The ID of the table. The ID must contain only letters (a-z,\nA-Z), numbers (0-9), or underscores (_). The maximum length\nis 1,024 characters. When `null`, the `table_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `table` sub block.\n', args=[]), + new( + dataset_id, + project_id, + table_id=null + ):: std.prune(a={ + dataset_id: dataset_id, + project_id: project_id, + table_id: table_id, + }), + }, + }, + }, + job_notification_emails:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.actions.job_notification_emails.new` constructs a new object with attributes and blocks configured for the `job_notification_emails`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `job_notification_emails` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.actions.new` constructs a new object with attributes and blocks configured for the `actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `deidentify` (`list[obj]`): Create a de-identified copy of the requested table or files. When `null`, the `deidentify` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.new](#fn-inspect_jobinspect_jobdeidentifynew) constructor.\n - `job_notification_emails` (`list[obj]`): Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts. When `null`, the `job_notification_emails` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.job_notification_emails.new](#fn-inspect_jobinspect_jobjob_notification_emailsnew) constructor.\n - `pub_sub` (`list[obj]`): Publish a message into a given Pub/Sub topic when the job completes. When `null`, the `pub_sub` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.pub_sub.new](#fn-inspect_jobinspect_jobpub_subnew) constructor.\n - `publish_findings_to_cloud_data_catalog` (`list[obj]`): Publish findings of a DlpJob to Data Catalog. When `null`, the `publish_findings_to_cloud_data_catalog` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.publish_findings_to_cloud_data_catalog.new](#fn-inspect_jobinspect_jobpublish_findings_to_cloud_data_catalognew) constructor.\n - `publish_summary_to_cscc` (`list[obj]`): Publish the result summary of a DlpJob to the Cloud Security Command Center. When `null`, the `publish_summary_to_cscc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.publish_summary_to_cscc.new](#fn-inspect_jobinspect_jobpublish_summary_to_csccnew) constructor.\n - `save_findings` (`list[obj]`): If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk When `null`, the `save_findings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.save_findings.new](#fn-inspect_jobinspect_jobsave_findingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `actions` sub block.\n', args=[]), new( + deidentify=null, + job_notification_emails=null, pub_sub=null, publish_findings_to_cloud_data_catalog=null, publish_summary_to_cscc=null, save_findings=null ):: std.prune(a={ + deidentify: deidentify, + job_notification_emails: job_notification_emails, pub_sub: pub_sub, publish_findings_to_cloud_data_catalog: publish_findings_to_cloud_data_catalog, publish_summary_to_cscc: publish_summary_to_cscc, @@ -182,16 +238,48 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.storage_config.new` constructs a new object with attributes and blocks configured for the `storage_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `big_query_options` (`list[obj]`): Options defining BigQuery table and row identifiers. When `null`, the `big_query_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.new](#fn-inspect_jobinspect_jobbig_query_optionsnew) constructor.\n - `cloud_storage_options` (`list[obj]`): Options defining a file or a set of files within a Google Cloud Storage bucket. When `null`, the `cloud_storage_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.cloud_storage_options.new](#fn-inspect_jobinspect_jobcloud_storage_optionsnew) constructor.\n - `datastore_options` (`list[obj]`): Options defining a data set within Google Cloud Datastore. When `null`, the `datastore_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.datastore_options.new](#fn-inspect_jobinspect_jobdatastore_optionsnew) constructor.\n - `timespan_config` (`list[obj]`): Information on where to inspect When `null`, the `timespan_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.timespan_config.new](#fn-inspect_jobinspect_jobtimespan_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `storage_config` sub block.\n', args=[]), + hybrid_options:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.new` constructs a new object with attributes and blocks configured for the `hybrid_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): A short description of where the data is coming from. Will be stored once in the job. 256 max length. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): To organize findings, these labels will be added to each finding.\n\nLabel keys must be between 1 and 63 characters long and must conform to the following regular expression: '[a-z]([-a-z0-9]*[a-z0-9])?'.\n\nLabel values must be between 0 and 63 characters long and must conform to the regular expression '([a-z]([-a-z0-9]*[a-z0-9])?)?'.\n\nNo more than 10 labels can be associated with a given finding.\n\nExamples:\n* '"environment" : "production"'\n* '"pipeline" : "etl"' When `null`, the `labels` field will be omitted from the resulting object.\n - `required_finding_label_keys` (`list`): These are labels that each inspection request must include within their 'finding_labels' map. Request\nmay contain others, but any missing one of these will be rejected.\n\nLabel keys must be between 1 and 63 characters long and must conform to the following regular expression: '[a-z]([-a-z0-9]*[a-z0-9])?'.\n\nNo more than 10 keys can be required. When `null`, the `required_finding_label_keys` field will be omitted from the resulting object.\n - `table_options` (`list[obj]`): If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. When `null`, the `table_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.table_options.new](#fn-inspect_jobinspect_jobstorage_configtable_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `hybrid_options` sub block.\n', args=[]), + new( + description=null, + labels=null, + required_finding_label_keys=null, + table_options=null + ):: std.prune(a={ + description: description, + labels: labels, + required_finding_label_keys: required_finding_label_keys, + table_options: table_options, + }), + table_options:: { + identifying_fields:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.table_options.identifying_fields.new` constructs a new object with attributes and blocks configured for the `identifying_fields`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name describing the field.\n\n**Returns**:\n - An attribute object that represents the `identifying_fields` sub block.\n', args=[]), + new( + name + ):: std.prune(a={ + name: name, + }), + }, + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.table_options.new` constructs a new object with attributes and blocks configured for the `table_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `identifying_fields` (`list[obj]`): The columns that are the primary keys for table objects included in ContentItem. A copy of this\ncell's value will stored alongside alongside each finding so that the finding can be traced to\nthe specific row it came from. No more than 3 may be provided. When `null`, the `identifying_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.table_options.identifying_fields.new](#fn-inspect_jobinspect_jobstorage_confighybrid_optionsidentifying_fieldsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `table_options` sub block.\n', args=[]), + new( + identifying_fields=null + ):: std.prune(a={ + identifying_fields: identifying_fields, + }), + }, + }, + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.storage_config.new` constructs a new object with attributes and blocks configured for the `storage_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `big_query_options` (`list[obj]`): Options defining BigQuery table and row identifiers. When `null`, the `big_query_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.new](#fn-inspect_jobinspect_jobbig_query_optionsnew) constructor.\n - `cloud_storage_options` (`list[obj]`): Options defining a file or a set of files within a Google Cloud Storage bucket. When `null`, the `cloud_storage_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.cloud_storage_options.new](#fn-inspect_jobinspect_jobcloud_storage_optionsnew) constructor.\n - `datastore_options` (`list[obj]`): Options defining a data set within Google Cloud Datastore. When `null`, the `datastore_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.datastore_options.new](#fn-inspect_jobinspect_jobdatastore_optionsnew) constructor.\n - `hybrid_options` (`list[obj]`): Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. When `null`, the `hybrid_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.new](#fn-inspect_jobinspect_jobhybrid_optionsnew) constructor.\n - `timespan_config` (`list[obj]`): Information on where to inspect When `null`, the `timespan_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.timespan_config.new](#fn-inspect_jobinspect_jobtimespan_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `storage_config` sub block.\n', args=[]), new( big_query_options=null, cloud_storage_options=null, datastore_options=null, + hybrid_options=null, timespan_config=null ):: std.prune(a={ big_query_options: big_query_options, cloud_storage_options: cloud_storage_options, datastore_options: datastore_options, + hybrid_options: hybrid_options, timespan_config: timespan_config, }), timespan_config:: { @@ -274,10 +362,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, triggers:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.triggers.new` constructs a new object with attributes and blocks configured for the `triggers`\nTerraform sub block.\n\n\n\n**Args**:\n - `schedule` (`list[obj]`): Schedule for triggered jobs When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.schedule.new](#fn-triggersschedulenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `triggers` sub block.\n', args=[]), + manual:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.triggers.manual.new` constructs a new object with attributes and blocks configured for the `manual`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `manual` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.triggers.new` constructs a new object with attributes and blocks configured for the `triggers`\nTerraform sub block.\n\n\n\n**Args**:\n - `manual` (`list[obj]`): For use with hybrid jobs. Jobs must be manually created and finished. When `null`, the `manual` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.manual.new](#fn-triggersmanualnew) constructor.\n - `schedule` (`list[obj]`): Schedule for triggered jobs When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.schedule.new](#fn-triggersschedulenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `triggers` sub block.\n', args=[]), new( + manual=null, schedule=null ):: std.prune(a={ + manual: manual, schedule: schedule, }), schedule:: { diff --git a/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet b/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet index 1076e9c..59a4e0c 100644 --- a/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet +++ b/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet @@ -62,14 +62,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); workforce_pool_id: workforce_pool_id, }), oidc:: { - '#new':: d.fn(help='\n`google.iam_workforce_pool_provider.oidc.new` constructs a new object with attributes and blocks configured for the `oidc`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_id` (`string`): The client ID. Must match the audience claim of the JWT issued by the identity provider.\n - `issuer_uri` (`string`): The OIDC issuer URI. Must be a valid URI using the 'https' scheme.\n\n**Returns**:\n - An attribute object that represents the `oidc` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.iam_workforce_pool_provider.oidc.new` constructs a new object with attributes and blocks configured for the `oidc`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_id` (`string`): The client ID. Must match the audience claim of the JWT issued by the identity provider.\n - `issuer_uri` (`string`): The OIDC issuer URI. Must be a valid URI using the 'https' scheme.\n - `web_sso_config` (`list[obj]`): Configuration for web single sign-on for the OIDC provider. Here, web sign-in refers to console sign-in and gcloud sign-in through the browser. When `null`, the `web_sso_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.iam_workforce_pool_provider.oidc.web_sso_config.new](#fn-oidcweb_sso_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `oidc` sub block.\n', args=[]), new( client_id, - issuer_uri + issuer_uri, + web_sso_config=null ):: std.prune(a={ client_id: client_id, issuer_uri: issuer_uri, + web_sso_config: web_sso_config, }), + web_sso_config:: { + '#new':: d.fn(help='\n`google.iam_workforce_pool_provider.oidc.web_sso_config.new` constructs a new object with attributes and blocks configured for the `web_sso_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `assertion_claims_behavior` (`string`): The behavior for how OIDC Claims are included in the 'assertion' object used for attribute mapping and attribute condition.\n* ONLY_ID_TOKEN_CLAIMS: Only include ID Token Claims. Possible values: ["ONLY_ID_TOKEN_CLAIMS"]\n - `response_type` (`string`): The Response Type to request for in the OIDC Authorization Request for web sign-in.\n* ID_TOKEN: The 'response_type=id_token' selection uses the Implicit Flow for web sign-in. Possible values: ["ID_TOKEN"]\n\n**Returns**:\n - An attribute object that represents the `web_sso_config` sub block.\n', args=[]), + new( + assertion_claims_behavior, + response_type + ):: std.prune(a={ + assertion_claims_behavior: assertion_claims_behavior, + response_type: response_type, + }), + }, }, saml:: { '#new':: d.fn(help='\n`google.iam_workforce_pool_provider.saml.new` constructs a new object with attributes and blocks configured for the `saml`\nTerraform sub block.\n\n\n\n**Args**:\n - `idp_metadata_xml` (`string`): SAML Identity provider configuration metadata xml doc.\nThe xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf).\nThe max size of the acceptable xml document will be bounded to 128k characters.\n\nThe metadata xml document should satisfy the following constraints:\n1) Must contain an Identity Provider Entity ID.\n2) Must contain at least one non-expired signing key certificate.\n3) For each signing key: \n a) Valid from should be no more than 7 days from now. \n b) Valid to should be no more than 10 years in the future. \n4) Up to 3 IdP signing keys are allowed in the metadata xml.\n\nWhen updating the provider's metadata xml, at least one non-expired signing key\nmust overlap with the existing metadata. This requirement is skipped if there are\nno non-expired signing keys present in the existing metadata.\n\n**Returns**:\n - An attribute object that represents the `saml` sub block.\n', args=[]), diff --git a/4.x/_gen/resources/tags_tag_key.libsonnet b/4.x/_gen/resources/tags_tag_key.libsonnet index b0482c5..cfde9fd 100644 --- a/4.x/_gen/resources/tags_tag_key.libsonnet +++ b/4.x/_gen/resources/tags_tag_key.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='tags_tag_key', url='', help='`tags_tag_key` represents the `google_tags_tag_key` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google.tags_tag_key.new` injects a new `google_tags_tag_key` 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 google.tags_tag_key.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.tags_tag_key` using the reference:\n\n $._ref.google_tags_tag_key.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_tags_tag_key.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 - `description` (`string`): User-assigned description of the TagKey. Must not exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `parent` (`string`): Input only. The resource name of the new TagKey\u0026#39;s parent. Must be of the form organizations/{org_id}.\n - `purpose` (`string`): Optional. A purpose cannot be changed once set.\n\nA purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. Possible values: [\u0026#34;GCE_FIREWALL\u0026#34;] When `null`, the `purpose` field will be omitted from the resulting object.\n - `purpose_data` (`obj`): Optional. Purpose data cannot be changed once set.\n\nPurpose data corresponds to the policy system that the tag is intended for. For example, the GCE_FIREWALL purpose expects data in the following format: \u0026#39;network = \u0026#34;\u0026lt;project-name\u0026gt;/\u0026lt;vpc-name\u0026gt;\u0026#34;\u0026#39;. When `null`, the `purpose_data` field will be omitted from the resulting object.\n - `short_name` (`string`): Input only. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.\n\nThe short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.\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 [google.tags_tag_key.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`google.tags_tag_key.new` injects a new `google_tags_tag_key` 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 google.tags_tag_key.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.tags_tag_key` using the reference:\n\n $._ref.google_tags_tag_key.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_tags_tag_key.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 - `description` (`string`): User-assigned description of the TagKey. Must not exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `parent` (`string`): Input only. The resource name of the new TagKey\u0026#39;s parent. Must be of the form organizations/{org_id} or projects/{project_id_or_number}.\n - `purpose` (`string`): Optional. A purpose cannot be changed once set.\n\nA purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. Possible values: [\u0026#34;GCE_FIREWALL\u0026#34;] When `null`, the `purpose` field will be omitted from the resulting object.\n - `purpose_data` (`obj`): Optional. Purpose data cannot be changed once set.\n\nPurpose data corresponds to the policy system that the tag is intended for. For example, the GCE_FIREWALL purpose expects data in the following format: \u0026#39;network = \u0026#34;\u0026lt;project-name\u0026gt;/\u0026lt;vpc-name\u0026gt;\u0026#34;\u0026#39;. When `null`, the `purpose_data` field will be omitted from the resulting object.\n - `short_name` (`string`): Input only. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.\n\nThe short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.\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 [google.tags_tag_key.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, parent, @@ -25,7 +25,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.tags_tag_key.newAttrs` constructs a new object with attributes and blocks configured for the `tags_tag_key`\nTerraform resource.\n\nUnlike [google.tags_tag_key.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 - `description` (`string`): User-assigned description of the TagKey. Must not exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `parent` (`string`): Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.\n - `purpose` (`string`): Optional. A purpose cannot be changed once set.\n\nA purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. Possible values: ["GCE_FIREWALL"] When `null`, the `purpose` field will be omitted from the resulting object.\n - `purpose_data` (`obj`): Optional. Purpose data cannot be changed once set.\n\nPurpose data corresponds to the policy system that the tag is intended for. For example, the GCE_FIREWALL purpose expects data in the following format: 'network = "<project-name>/<vpc-name>"'. When `null`, the `purpose_data` field will be omitted from the resulting object.\n - `short_name` (`string`): Input only. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.\n\nThe short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.\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 [google.tags_tag_key.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 `tags_tag_key` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.tags_tag_key.newAttrs` constructs a new object with attributes and blocks configured for the `tags_tag_key`\nTerraform resource.\n\nUnlike [google.tags_tag_key.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 - `description` (`string`): User-assigned description of the TagKey. Must not exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `parent` (`string`): Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id} or projects/{project_id_or_number}.\n - `purpose` (`string`): Optional. A purpose cannot be changed once set.\n\nA purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. Possible values: ["GCE_FIREWALL"] When `null`, the `purpose` field will be omitted from the resulting object.\n - `purpose_data` (`obj`): Optional. Purpose data cannot be changed once set.\n\nPurpose data corresponds to the policy system that the tag is intended for. For example, the GCE_FIREWALL purpose expects data in the following format: 'network = "<project-name>/<vpc-name>"'. When `null`, the `purpose_data` field will be omitted from the resulting object.\n - `short_name` (`string`): Input only. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.\n\nThe short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.\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 [google.tags_tag_key.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 `tags_tag_key` resource into the root Terraform configuration.\n', args=[]), newAttrs( parent, short_name, diff --git a/docs/4.x/README.md b/docs/4.x/README.md index cb651f1..0dc7a85 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -20,6 +20,7 @@ project. * [access_context_manager_access_policy_iam_policy](access_context_manager_access_policy_iam_policy.md) * [access_context_manager_authorized_orgs_desc](access_context_manager_authorized_orgs_desc.md) * [access_context_manager_gcp_user_access_binding](access_context_manager_gcp_user_access_binding.md) +* [access_context_manager_ingress_policy](access_context_manager_ingress_policy.md) * [access_context_manager_service_perimeter](access_context_manager_service_perimeter.md) * [access_context_manager_service_perimeter_resource](access_context_manager_service_perimeter_resource.md) * [access_context_manager_service_perimeters](access_context_manager_service_perimeters.md) @@ -220,8 +221,11 @@ project. * [compute_project_default_network_tier](compute_project_default_network_tier.md) * [compute_project_metadata](compute_project_metadata.md) * [compute_project_metadata_item](compute_project_metadata_item.md) +* [compute_public_advertised_prefix](compute_public_advertised_prefix.md) +* [compute_public_delegated_prefix](compute_public_delegated_prefix.md) * [compute_region_autoscaler](compute_region_autoscaler.md) * [compute_region_backend_service](compute_region_backend_service.md) +* [compute_region_commitment](compute_region_commitment.md) * [compute_region_disk](compute_region_disk.md) * [compute_region_disk_iam_binding](compute_region_disk_iam_binding.md) * [compute_region_disk_iam_member](compute_region_disk_iam_member.md) diff --git a/docs/4.x/access_context_manager_ingress_policy.md b/docs/4.x/access_context_manager_ingress_policy.md new file mode 100644 index 0000000..c2bf222 --- /dev/null +++ b/docs/4.x/access_context_manager_ingress_policy.md @@ -0,0 +1,177 @@ +--- +permalink: /access_context_manager_ingress_policy/ +--- + +# access_context_manager_ingress_policy + +`access_context_manager_ingress_policy` represents the `google_access_context_manager_ingress_policy` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withIngressPolicyName()`](#fn-withingresspolicyname) +* [`fn withResource()`](#fn-withresource) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.access_context_manager_ingress_policy.new` injects a new `google_access_context_manager_ingress_policy` 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 + google.access_context_manager_ingress_policy.new('some_id') + +You can get the reference to the `id` field of the created `google.access_context_manager_ingress_policy` using the reference: + + $._ref.google_access_context_manager_ingress_policy.some_id.get('id') + +This is the same as directly entering `"${ google_access_context_manager_ingress_policy.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. + - `ingress_policy_name` (`string`): The name of the Service Perimeter to add this resource to. + - `resource` (`string`): A GCP resource that is inside of the service perimeter. + - `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 [google.access_context_manager_ingress_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.access_context_manager_ingress_policy.newAttrs` constructs a new object with attributes and blocks configured for the `access_context_manager_ingress_policy` +Terraform resource. + +Unlike [google.access_context_manager_ingress_policy.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**: + - `ingress_policy_name` (`string`): The name of the Service Perimeter to add this resource to. + - `resource` (`string`): A GCP resource that is inside of the service perimeter. + - `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 [google.access_context_manager_ingress_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**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 `access_context_manager_ingress_policy` resource into the root Terraform configuration. + + +### fn withIngressPolicyName + +```ts +withIngressPolicyName() +``` + +`google.string.withIngressPolicyName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the ingress_policy_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `ingress_policy_name` field. + + +### fn withResource + +```ts +withResource() +``` + +`google.string.withResource` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the resource field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `resource` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.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 [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.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 [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.access_context_manager_ingress_policy.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. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/alloydb_backup.md b/docs/4.x/alloydb_backup.md index ea4b153..117f182 100644 --- a/docs/4.x/alloydb_backup.md +++ b/docs/4.x/alloydb_backup.md @@ -59,7 +59,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}). - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object. - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object. - - `location` (`string`): The location where the alloydb backup should reside. When `null`, the `location` field will be omitted from the resulting object. + - `location` (`string`): The location where the alloydb backup should reside. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` 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 [google.alloydb_backup.timeouts.new](#fn-timeoutsnew) constructor. @@ -89,7 +89,7 @@ injecting into a complete block. - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}). - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object. - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object. - - `location` (`string`): The location where the alloydb backup should reside. When `null`, the `location` field will be omitted from the resulting object. + - `location` (`string`): The location where the alloydb backup should reside. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` 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 [google.alloydb_backup.timeouts.new](#fn-timeoutsnew) constructor. diff --git a/docs/4.x/alloydb_cluster.md b/docs/4.x/alloydb_cluster.md index 7381b21..b4b422f 100644 --- a/docs/4.x/alloydb_cluster.md +++ b/docs/4.x/alloydb_cluster.md @@ -74,7 +74,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `cluster_id` (`string`): The ID of the alloydb cluster. - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object. - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object. - - `location` (`string`): The location where the alloydb cluster should reside. When `null`, the `location` field will be omitted from the resulting object. + - `location` (`string`): The location where the alloydb cluster should reside. - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}". @@ -110,7 +110,7 @@ injecting into a complete block. - `cluster_id` (`string`): The ID of the alloydb cluster. - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object. - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object. - - `location` (`string`): The location where the alloydb cluster should reside. When `null`, the `location` field will be omitted from the resulting object. + - `location` (`string`): The location where the alloydb cluster should reside. - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}". diff --git a/docs/4.x/alloydb_instance.md b/docs/4.x/alloydb_instance.md index b72d144..c99b058 100644 --- a/docs/4.x/alloydb_instance.md +++ b/docs/4.x/alloydb_instance.md @@ -74,7 +74,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object. - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object. - `instance_id` (`string`): The ID of the alloydb instance. - - `instance_type` (`string`): The type of the instance. Possible values: ["PRIMARY", "READ_POOL"] + - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the 'depends_on' meta-data attribute. Possible values: ["PRIMARY", "READ_POOL"] - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object. - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.machine_config.new](#fn-machine_confignew) constructor. - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor. @@ -110,7 +110,7 @@ injecting into a complete block. - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object. - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object. - `instance_id` (`string`): The ID of the alloydb instance. - - `instance_type` (`string`): The type of the instance. Possible values: ["PRIMARY", "READ_POOL"] + - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the 'depends_on' meta-data attribute. Possible values: ["PRIMARY", "READ_POOL"] - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object. - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.machine_config.new](#fn-machine_confignew) constructor. - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor. diff --git a/docs/4.x/apigee_sharedflow.md b/docs/4.x/apigee_sharedflow.md index 1af1986..f132c8a 100644 --- a/docs/4.x/apigee_sharedflow.md +++ b/docs/4.x/apigee_sharedflow.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. - - `config_bundle` (`string`): A path to the config bundle zip you want to upload. Must be defined if content is not. + - `config_bundle` (`string`): Path to the config zip bundle - `detect_md5hash` (`string`): A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update. When `null`, the `detect_md5hash` field will be omitted from the resulting object. - `name` (`string`): The ID of the shared flow. - `org_id` (`string`): The Apigee Organization name associated with the Apigee instance. @@ -81,7 +81,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `config_bundle` (`string`): A path to the config bundle zip you want to upload. Must be defined if content is not. + - `config_bundle` (`string`): Path to the config zip bundle - `detect_md5hash` (`string`): A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update. When `null`, the `detect_md5hash` field will be omitted from the resulting object. - `name` (`string`): The ID of the shared flow. - `org_id` (`string`): The Apigee Organization name associated with the Apigee instance. diff --git a/docs/4.x/cloud_run_service.md b/docs/4.x/cloud_run_service.md index 8c4f584..cf3fe4b 100644 --- a/docs/4.x/cloud_run_service.md +++ b/docs/4.x/cloud_run_service.md @@ -415,10 +415,19 @@ info: http://kubernetes.io/docs/user-guide/annotations If terraform plan shows a diff where a server-side annotation is added, you can add it to your config or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. -Cloud Run (fully managed) uses the following annotation keys to configure features on a Service: - +Annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted. Use the following annotation +keys to configure features on a Service: + +- 'run.googleapis.com/binary-authorization-breakglass' sets the [Binary Authorization breakglass](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--breakglass). +- 'run.googleapis.com/binary-authorization' sets the [Binary Authorization](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--binary-authorization). +- 'run.googleapis.com/client-name' sets the client name calling the Cloud Run API. +- 'run.googleapis.com/custom-audiences' sets the [custom audiences](https://cloud.google.com/sdk/gcloud/reference/alpha/run/deploy#--add-custom-audiences) + that can be used in the audience field of ID token for authenticated requests. +- 'run.googleapis.com/description' sets a user defined description for the Service. - 'run.googleapis.com/ingress' sets the [ingress settings](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--ingress) - for the Service. For example, '"run.googleapis.com/ingress" = "all"'. When `null`, the `annotations` field will be omitted from the resulting object. + for the Service. For example, '"run.googleapis.com/ingress" = "all"'. +- 'run.googleapis.com/launch-stage' sets the [launch stage](https://cloud.google.com/run/docs/troubleshooting#launch-stage-validation) + when a preview feature is used. For example, '"run.googleapis.com/launch-stage": "BETA"' When `null`, the `annotations` field will be omitted from the resulting object. - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. When `null`, the `labels` field will be omitted from the resulting object. @@ -477,11 +486,46 @@ Terraform sub block. **Args**: - `annotations` (`obj`): Annotations is a key value map stored with a resource that -may be set by external tools to store and retrieve arbitrary metadata. +may be set by external tools to store and retrieve arbitrary metadata. More +info: http://kubernetes.io/docs/user-guide/annotations **Note**: The Cloud Run API may add additional annotations that were not provided in your config. If terraform plan shows a diff where a server-side annotation is added, you can add it to your config -or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. When `null`, the `annotations` field will be omitted from the resulting object. +or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. + +Annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted. Use the following annotation +keys to configure features on a Revision template: + +- 'autoscaling.knative.dev/maxScale' sets the [maximum number of container + instances](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--max-instances) of the Revision to run. +- 'autoscaling.knative.dev/minScale' sets the [minimum number of container + instances](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--min-instances) of the Revision to run. +- 'run.googleapis.com/client-name' sets the client name calling the Cloud Run API. +- 'run.googleapis.com/cloudsql-instances' sets the [Cloud SQL + instances](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--add-cloudsql-instances) the Revision connects to. +- 'run.googleapis.com/cpu-throttling' sets whether to throttle the CPU when the container is not actively serving + requests. See https://cloud.google.com/sdk/gcloud/reference/run/deploy#--[no-]cpu-throttling. +- 'run.googleapis.com/encryption-key-shutdown-hours' sets the number of hours to wait before an automatic shutdown + server after CMEK key revocation is detected. +- 'run.googleapis.com/encryption-key' sets the [CMEK key](https://cloud.google.com/run/docs/securing/using-cmek) + reference to encrypt the container with. +- 'run.googleapis.com/execution-environment' sets the [execution + environment](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--execution-environment) + where the application will run. +- 'run.googleapis.com/post-key-revocation-action-type' sets the + [action type](https://cloud.google.com/sdk/gcloud/reference/run/deploy#--post-key-revocation-action-type) + after CMEK key revocation. +- 'run.googleapis.com/secrets' sets a list of key-value pairs to set as + [secrets](https://cloud.google.com/run/docs/configuring/secrets#yaml). +- 'run.googleapis.com/sessionAffinity' sets whether to enable + [session affinity](https://cloud.google.com/sdk/gcloud/reference/beta/run/deploy#--[no-]session-affinity) + for connections to the Revision. +- 'run.googleapis.com/startup-cpu-boost' sets whether to allocate extra CPU to containers on startup. + See https://cloud.google.com/sdk/gcloud/reference/run/deploy#--[no-]cpu-boost. +- 'run.googleapis.com/vpc-access-connector' sets a [VPC connector](https://cloud.google.com/run/docs/configuring/connecting-vpc#terraform_1) + for the Revision. +- 'run.googleapis.com/vpc-access-egress' sets the outbound traffic to send through the VPC connector for this resource. + See https://cloud.google.com/sdk/gcloud/reference/run/deploy#--vpc-egress. When `null`, the `annotations` field will be omitted from the resulting object. - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize (scope and select) objects. When `null`, the `labels` field will be omitted from the resulting object. - `name` (`string`): Name must be unique within a Google Cloud project and region. diff --git a/docs/4.x/compute_firewall.md b/docs/4.x/compute_firewall.md index 6677a61..8d2cc44 100644 --- a/docs/4.x/compute_firewall.md +++ b/docs/4.x/compute_firewall.md @@ -81,9 +81,7 @@ you create the resource. When `null`, the `description` field will be omitted fr traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. IPv4 or IPv6 ranges are supported. When `null`, the `destination_ranges` field will be omitted from the resulting object. - `direction` (`string`): Direction of traffic to which this firewall applies; default is -INGRESS. Note: For INGRESS traffic, it is NOT supported to specify -destinationRanges; For EGRESS traffic, it is NOT supported to specify -'source_ranges' OR 'source_tags'. For INGRESS traffic, one of 'source_ranges', +INGRESS. Note: For INGRESS traffic, one of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. Possible values: ["INGRESS", "EGRESS"] When `null`, the `direction` field will be omitted from the resulting object. - `disabled` (`bool`): Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is @@ -183,9 +181,7 @@ you create the resource. When `null`, the `description` field will be omitted fr traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. IPv4 or IPv6 ranges are supported. When `null`, the `destination_ranges` field will be omitted from the resulting object. - `direction` (`string`): Direction of traffic to which this firewall applies; default is -INGRESS. Note: For INGRESS traffic, it is NOT supported to specify -destinationRanges; For EGRESS traffic, it is NOT supported to specify -'source_ranges' OR 'source_tags'. For INGRESS traffic, one of 'source_ranges', +INGRESS. Note: For INGRESS traffic, one of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. Possible values: ["INGRESS", "EGRESS"] When `null`, the `direction` field will be omitted from the resulting object. - `disabled` (`bool`): Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is diff --git a/docs/4.x/compute_public_advertised_prefix.md b/docs/4.x/compute_public_advertised_prefix.md new file mode 100644 index 0000000..f8fa53f --- /dev/null +++ b/docs/4.x/compute_public_advertised_prefix.md @@ -0,0 +1,244 @@ +--- +permalink: /compute_public_advertised_prefix/ +--- + +# compute_public_advertised_prefix + +`compute_public_advertised_prefix` represents the `google_compute_public_advertised_prefix` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDnsVerificationIp()`](#fn-withdnsverificationip) +* [`fn withIpCidrRange()`](#fn-withipcidrrange) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.compute_public_advertised_prefix.new` injects a new `google_compute_public_advertised_prefix` 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 + google.compute_public_advertised_prefix.new('some_id') + +You can get the reference to the `id` field of the created `google.compute_public_advertised_prefix` using the reference: + + $._ref.google_compute_public_advertised_prefix.some_id.get('id') + +This is the same as directly entering `"${ google_compute_public_advertised_prefix.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. + - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. + - `dns_verification_ip` (`string`): The IPv4 address to be used for reverse DNS verification. + - `ip_cidr_range` (`string`): The IPv4 address range, in CIDR format, represented by this public advertised prefix. + - `name` (`string`): Name of the resource. The name must be 1-63 characters long, and +comply with RFC1035. Specifically, the name must be 1-63 characters +long and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' +which means the first character must be a lowercase letter, and all +following characters must be a dash, lowercase letter, or digit, +except the last character, which cannot be a dash. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` 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 [google.compute_public_advertised_prefix.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.compute_public_advertised_prefix.newAttrs` constructs a new object with attributes and blocks configured for the `compute_public_advertised_prefix` +Terraform resource. + +Unlike [google.compute_public_advertised_prefix.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**: + - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. + - `dns_verification_ip` (`string`): The IPv4 address to be used for reverse DNS verification. + - `ip_cidr_range` (`string`): The IPv4 address range, in CIDR format, represented by this public advertised prefix. + - `name` (`string`): Name of the resource. The name must be 1-63 characters long, and +comply with RFC1035. Specifically, the name must be 1-63 characters +long and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' +which means the first character must be a lowercase letter, and all +following characters must be a dash, lowercase letter, or digit, +except the last character, which cannot be a dash. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` 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 [google.compute_public_advertised_prefix.timeouts.new](#fn-timeoutsnew) constructor. + +**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 `compute_public_advertised_prefix` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`google.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 withDnsVerificationIp + +```ts +withDnsVerificationIp() +``` + +`google.string.withDnsVerificationIp` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the dns_verification_ip field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `dns_verification_ip` field. + + +### fn withIpCidrRange + +```ts +withIpCidrRange() +``` + +`google.string.withIpCidrRange` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the ip_cidr_range field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `ip_cidr_range` field. + + +### fn withName + +```ts +withName() +``` + +`google.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 withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.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 [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.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 [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.compute_public_advertised_prefix.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. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/compute_public_delegated_prefix.md b/docs/4.x/compute_public_delegated_prefix.md new file mode 100644 index 0000000..90ed259 --- /dev/null +++ b/docs/4.x/compute_public_delegated_prefix.md @@ -0,0 +1,282 @@ +--- +permalink: /compute_public_delegated_prefix/ +--- + +# compute_public_delegated_prefix + +`compute_public_delegated_prefix` represents the `google_compute_public_delegated_prefix` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withIpCidrRange()`](#fn-withipcidrrange) +* [`fn withIsLiveMigration()`](#fn-withislivemigration) +* [`fn withName()`](#fn-withname) +* [`fn withParentPrefix()`](#fn-withparentprefix) +* [`fn withProject()`](#fn-withproject) +* [`fn withRegion()`](#fn-withregion) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.compute_public_delegated_prefix.new` injects a new `google_compute_public_delegated_prefix` 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 + google.compute_public_delegated_prefix.new('some_id') + +You can get the reference to the `id` field of the created `google.compute_public_delegated_prefix` using the reference: + + $._ref.google_compute_public_delegated_prefix.some_id.get('id') + +This is the same as directly entering `"${ google_compute_public_delegated_prefix.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. + - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. + - `ip_cidr_range` (`string`): The IPv4 address range, in CIDR format, represented by this public advertised prefix. + - `is_live_migration` (`bool`): If true, the prefix will be live migrated. When `null`, the `is_live_migration` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource. The name must be 1-63 characters long, and +comply with RFC1035. Specifically, the name must be 1-63 characters +long and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' +which means the first character must be a lowercase letter, and all +following characters must be a dash, lowercase letter, or digit, +except the last character, which cannot be a dash. + - `parent_prefix` (`string`): The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): A region where the prefix will reside. + - `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 [google.compute_public_delegated_prefix.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.compute_public_delegated_prefix.newAttrs` constructs a new object with attributes and blocks configured for the `compute_public_delegated_prefix` +Terraform resource. + +Unlike [google.compute_public_delegated_prefix.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**: + - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. + - `ip_cidr_range` (`string`): The IPv4 address range, in CIDR format, represented by this public advertised prefix. + - `is_live_migration` (`bool`): If true, the prefix will be live migrated. When `null`, the `is_live_migration` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource. The name must be 1-63 characters long, and +comply with RFC1035. Specifically, the name must be 1-63 characters +long and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' +which means the first character must be a lowercase letter, and all +following characters must be a dash, lowercase letter, or digit, +except the last character, which cannot be a dash. + - `parent_prefix` (`string`): The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): A region where the prefix will reside. + - `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 [google.compute_public_delegated_prefix.timeouts.new](#fn-timeoutsnew) constructor. + +**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 `compute_public_delegated_prefix` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`google.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 withIpCidrRange + +```ts +withIpCidrRange() +``` + +`google.string.withIpCidrRange` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the ip_cidr_range field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `ip_cidr_range` field. + + +### fn withIsLiveMigration + +```ts +withIsLiveMigration() +``` + +`google.bool.withIsLiveMigration` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the is_live_migration field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `is_live_migration` field. + + +### fn withName + +```ts +withName() +``` + +`google.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 withParentPrefix + +```ts +withParentPrefix() +``` + +`google.string.withParentPrefix` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the parent_prefix field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `parent_prefix` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withRegion + +```ts +withRegion() +``` + +`google.string.withRegion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the region field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `region` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.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 [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.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 [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.compute_public_delegated_prefix.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. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/compute_region_commitment.md b/docs/4.x/compute_region_commitment.md new file mode 100644 index 0000000..2c739f8 --- /dev/null +++ b/docs/4.x/compute_region_commitment.md @@ -0,0 +1,461 @@ +--- +permalink: /compute_region_commitment/ +--- + +# compute_region_commitment + +`compute_region_commitment` represents the `google_compute_region_commitment` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withAutoRenew()`](#fn-withautorenew) +* [`fn withCategory()`](#fn-withcategory) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withLicenseResource()`](#fn-withlicenseresource) +* [`fn withLicenseResourceMixin()`](#fn-withlicenseresourcemixin) +* [`fn withName()`](#fn-withname) +* [`fn withPlan()`](#fn-withplan) +* [`fn withProject()`](#fn-withproject) +* [`fn withRegion()`](#fn-withregion) +* [`fn withResources()`](#fn-withresources) +* [`fn withResourcesMixin()`](#fn-withresourcesmixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withType()`](#fn-withtype) +* [`obj license_resource`](#obj-license_resource) + * [`fn new()`](#fn-license_resourcenew) +* [`obj resources`](#obj-resources) + * [`fn new()`](#fn-resourcesnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.compute_region_commitment.new` injects a new `google_compute_region_commitment` 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 + google.compute_region_commitment.new('some_id') + +You can get the reference to the `id` field of the created `google.compute_region_commitment` using the reference: + + $._ref.google_compute_region_commitment.some_id.get('id') + +This is the same as directly entering `"${ google_compute_region_commitment.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. + - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. +The default value is false if not specified. +If the field is set to true, the commitment will be automatically renewed for either +one or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object. + - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of +machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE +specifies commitments composed of software licenses, listed in licenseResources. +Note that only MACHINE commitments should have a Type specified. Possible values: ["LICENSE", "MACHINE"] When `null`, the `category` field will be omitted from the resulting object. + - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource. The name must be 1-63 characters long and match +the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the +first character must be a lowercase letter, and all following +characters must be a dash, lowercase letter, or digit, except the last +character, which cannot be a dash. + - `plan` (`string`): The plan for this commitment, which determines duration and discount rate. +The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: ["TWELVE_MONTH", "THIRTY_SIX_MONTH"] + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object. + - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. +Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized +machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to +accelerator optimized machines. Possible values: ["MEMORY_OPTIMIZED", "ACCELERATOR_OPTIMIZED"] When `null`, the `type` field will be omitted from the resulting object. + - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor. + - `resources` (`list[obj]`): A list of commitment amounts for particular resources. +Note that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_commitment.resources.new](#fn-resourcesnew) constructor. + - `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 [google.compute_region_commitment.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.compute_region_commitment.newAttrs` constructs a new object with attributes and blocks configured for the `compute_region_commitment` +Terraform resource. + +Unlike [google.compute_region_commitment.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**: + - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. +The default value is false if not specified. +If the field is set to true, the commitment will be automatically renewed for either +one or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object. + - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of +machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE +specifies commitments composed of software licenses, listed in licenseResources. +Note that only MACHINE commitments should have a Type specified. Possible values: ["LICENSE", "MACHINE"] When `null`, the `category` field will be omitted from the resulting object. + - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource. The name must be 1-63 characters long and match +the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the +first character must be a lowercase letter, and all following +characters must be a dash, lowercase letter, or digit, except the last +character, which cannot be a dash. + - `plan` (`string`): The plan for this commitment, which determines duration and discount rate. +The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: ["TWELVE_MONTH", "THIRTY_SIX_MONTH"] + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object. + - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. +Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized +machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to +accelerator optimized machines. Possible values: ["MEMORY_OPTIMIZED", "ACCELERATOR_OPTIMIZED"] When `null`, the `type` field will be omitted from the resulting object. + - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor. + - `resources` (`list[obj]`): A list of commitment amounts for particular resources. +Note that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_commitment.resources.new](#fn-resourcesnew) constructor. + - `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 [google.compute_region_commitment.timeouts.new](#fn-timeoutsnew) constructor. + +**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 `compute_region_commitment` resource into the root Terraform configuration. + + +### fn withAutoRenew + +```ts +withAutoRenew() +``` + +`google.bool.withAutoRenew` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the auto_renew field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `auto_renew` field. + + +### fn withCategory + +```ts +withCategory() +``` + +`google.string.withCategory` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the category field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `category` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`google.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 withLicenseResource + +```ts +withLicenseResource() +``` + +`google.list[obj].withLicenseResource` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the license_resource field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withLicenseResourceMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `license_resource` field. + + +### fn withLicenseResourceMixin + +```ts +withLicenseResourceMixin() +``` + +`google.list[obj].withLicenseResourceMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the license_resource 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 [google.list[obj].withLicenseResource](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `license_resource` field. + + +### fn withName + +```ts +withName() +``` + +`google.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 withPlan + +```ts +withPlan() +``` + +`google.string.withPlan` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the plan field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `plan` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withRegion + +```ts +withRegion() +``` + +`google.string.withRegion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the region field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `region` field. + + +### fn withResources + +```ts +withResources() +``` + +`google.list[obj].withResources` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the resources field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withResourcesMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `resources` field. + + +### fn withResourcesMixin + +```ts +withResourcesMixin() +``` + +`google.list[obj].withResourcesMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the resources 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 [google.list[obj].withResources](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `resources` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.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 [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.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 [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withType + +```ts +withType() +``` + +`google.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 license_resource + + + +### fn license_resource.new + +```ts +new() +``` + + +`google.compute_region_commitment.license_resource.new` constructs a new object with attributes and blocks configured for the `license_resource` +Terraform sub block. + + + +**Args**: + - `amount` (`string`): The number of licenses purchased. When `null`, the `amount` field will be omitted from the resulting object. + - `cores_per_license` (`string`): Specifies the core range of the instance for which this license applies. When `null`, the `cores_per_license` field will be omitted from the resulting object. + - `license` (`string`): Any applicable license URI. + +**Returns**: + - An attribute object that represents the `license_resource` sub block. + + +## obj resources + + + +### fn resources.new + +```ts +new() +``` + + +`google.compute_region_commitment.resources.new` constructs a new object with attributes and blocks configured for the `resources` +Terraform sub block. + + + +**Args**: + - `accelerator_type` (`string`): Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. When `null`, the `accelerator_type` field will be omitted from the resulting object. + - `amount` (`string`): The amount of the resource purchased (in a type-dependent unit, +such as bytes). For vCPUs, this can just be an integer. For memory, +this must be provided in MB. Memory must be a multiple of 256 MB, +with up to 6.5GB of memory per every vCPU. When `null`, the `amount` field will be omitted from the resulting object. + - `type` (`string`): Type of resource for which this commitment applies. +Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. When `null`, the `type` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `resources` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.compute_region_commitment.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. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/compute_target_https_proxy.md b/docs/4.x/compute_target_https_proxy.md index d3e2f9e..2b81598 100644 --- a/docs/4.x/compute_target_https_proxy.md +++ b/docs/4.x/compute_target_https_proxy.md @@ -75,8 +75,7 @@ this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When ` - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is -specified, uses the QUIC policy with no user overrides, which is -equivalent to DISABLE. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object. +specified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object. - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object. @@ -126,8 +125,7 @@ this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When ` - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is -specified, uses the QUIC policy with no user overrides, which is -equivalent to DISABLE. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object. +specified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object. - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object. diff --git a/docs/4.x/data_loss_prevention_job_trigger.md b/docs/4.x/data_loss_prevention_job_trigger.md index 982e671..1be63fa 100644 --- a/docs/4.x/data_loss_prevention_job_trigger.md +++ b/docs/4.x/data_loss_prevention_job_trigger.md @@ -29,6 +29,16 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_jobnew) * [`obj inspect_job.actions`](#obj-inspect_jobactions) * [`fn new()`](#fn-inspect_jobactionsnew) + * [`obj inspect_job.actions.deidentify`](#obj-inspect_jobactionsdeidentify) + * [`fn new()`](#fn-inspect_jobactionsdeidentifynew) + * [`obj inspect_job.actions.deidentify.transformation_config`](#obj-inspect_jobactionsdeidentifytransformation_config) + * [`fn new()`](#fn-inspect_jobactionsdeidentifytransformation_confignew) + * [`obj inspect_job.actions.deidentify.transformation_details_storage_config`](#obj-inspect_jobactionsdeidentifytransformation_details_storage_config) + * [`fn new()`](#fn-inspect_jobactionsdeidentifytransformation_details_storage_confignew) + * [`obj inspect_job.actions.deidentify.transformation_details_storage_config.table`](#obj-inspect_jobactionsdeidentifytransformation_details_storage_configtable) + * [`fn new()`](#fn-inspect_jobactionsdeidentifytransformation_details_storage_configtablenew) + * [`obj inspect_job.actions.job_notification_emails`](#obj-inspect_jobactionsjob_notification_emails) + * [`fn new()`](#fn-inspect_jobactionsjob_notification_emailsnew) * [`obj inspect_job.actions.pub_sub`](#obj-inspect_jobactionspub_sub) * [`fn new()`](#fn-inspect_jobactionspub_subnew) * [`obj inspect_job.actions.publish_findings_to_cloud_data_catalog`](#obj-inspect_jobactionspublish_findings_to_cloud_data_catalog) @@ -61,6 +71,12 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_jobstorage_configdatastore_optionskindnew) * [`obj inspect_job.storage_config.datastore_options.partition_id`](#obj-inspect_jobstorage_configdatastore_optionspartition_id) * [`fn new()`](#fn-inspect_jobstorage_configdatastore_optionspartition_idnew) + * [`obj inspect_job.storage_config.hybrid_options`](#obj-inspect_jobstorage_confighybrid_options) + * [`fn new()`](#fn-inspect_jobstorage_confighybrid_optionsnew) + * [`obj inspect_job.storage_config.hybrid_options.table_options`](#obj-inspect_jobstorage_confighybrid_optionstable_options) + * [`fn new()`](#fn-inspect_jobstorage_confighybrid_optionstable_optionsnew) + * [`obj inspect_job.storage_config.hybrid_options.table_options.identifying_fields`](#obj-inspect_jobstorage_confighybrid_optionstable_optionsidentifying_fields) + * [`fn new()`](#fn-inspect_jobstorage_confighybrid_optionstable_optionsidentifying_fieldsnew) * [`obj inspect_job.storage_config.timespan_config`](#obj-inspect_jobstorage_configtimespan_config) * [`fn new()`](#fn-inspect_jobstorage_configtimespan_confignew) * [`obj inspect_job.storage_config.timespan_config.timestamp_field`](#obj-inspect_jobstorage_configtimespan_configtimestamp_field) @@ -69,6 +85,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-timeoutsnew) * [`obj triggers`](#obj-triggers) * [`fn new()`](#fn-triggersnew) + * [`obj triggers.manual`](#obj-triggersmanual) + * [`fn new()`](#fn-triggersmanualnew) * [`obj triggers.schedule`](#obj-triggersschedule) * [`fn new()`](#fn-triggersschedulenew) @@ -361,6 +379,8 @@ Terraform sub block. **Args**: + - `deidentify` (`list[obj]`): Create a de-identified copy of the requested table or files. When `null`, the `deidentify` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.new](#fn-inspect_jobinspect_jobdeidentifynew) constructor. + - `job_notification_emails` (`list[obj]`): Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts. When `null`, the `job_notification_emails` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.job_notification_emails.new](#fn-inspect_jobinspect_jobjob_notification_emailsnew) constructor. - `pub_sub` (`list[obj]`): Publish a message into a given Pub/Sub topic when the job completes. When `null`, the `pub_sub` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.pub_sub.new](#fn-inspect_jobinspect_jobpub_subnew) constructor. - `publish_findings_to_cloud_data_catalog` (`list[obj]`): Publish findings of a DlpJob to Data Catalog. When `null`, the `publish_findings_to_cloud_data_catalog` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.publish_findings_to_cloud_data_catalog.new](#fn-inspect_jobinspect_jobpublish_findings_to_cloud_data_catalognew) constructor. - `publish_summary_to_cscc` (`list[obj]`): Publish the result summary of a DlpJob to the Cloud Security Command Center. When `null`, the `publish_summary_to_cscc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.publish_summary_to_cscc.new](#fn-inspect_jobinspect_jobpublish_summary_to_csccnew) constructor. @@ -370,6 +390,139 @@ Terraform sub block. - An attribute object that represents the `actions` sub block. +## obj inspect_job.actions.deidentify + + + +### fn inspect_job.actions.deidentify.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.new` constructs a new object with attributes and blocks configured for the `deidentify` +Terraform sub block. + + + +**Args**: + - `cloud_storage_output` (`string`): User settable Cloud Storage bucket and folders to store de-identified files. + +This field must be set for cloud storage deidentification. + +The output Cloud Storage bucket must be different from the input bucket. + +De-identified files will overwrite files in the output path. + +Form of: gs://bucket/folder/ or gs://bucket + - `file_types_to_transform` (`list`): List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed. + +If empty, all supported files will be transformed. Supported types may be automatically added over time. + +If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Possible values: ["IMAGE", "TEXT_FILE", "CSV", "TSV"] When `null`, the `file_types_to_transform` field will be omitted from the resulting object. + - `transformation_config` (`list[obj]`): User specified deidentify templates and configs for structured, unstructured, and image files. When `null`, the `transformation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_config.new](#fn-inspect_jobinspect_jobactionstransformation_confignew) constructor. + - `transformation_details_storage_config` (`list[obj]`): Config for storing transformation details. When `null`, the `transformation_details_storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.new](#fn-inspect_jobinspect_jobactionstransformation_details_storage_confignew) constructor. + +**Returns**: + - An attribute object that represents the `deidentify` sub block. + + +## obj inspect_job.actions.deidentify.transformation_config + + + +### fn inspect_job.actions.deidentify.transformation_config.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_config.new` constructs a new object with attributes and blocks configured for the `transformation_config` +Terraform sub block. + + + +**Args**: + - `deidentify_template` (`string`): If this template is specified, it will serve as the default de-identify template. When `null`, the `deidentify_template` field will be omitted from the resulting object. + - `image_redact_template` (`string`): If this template is specified, it will serve as the de-identify template for images. When `null`, the `image_redact_template` field will be omitted from the resulting object. + - `structured_deidentify_template` (`string`): If this template is specified, it will serve as the de-identify template for structured content such as delimited files and tables. When `null`, the `structured_deidentify_template` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `transformation_config` sub block. + + +## obj inspect_job.actions.deidentify.transformation_details_storage_config + + + +### fn inspect_job.actions.deidentify.transformation_details_storage_config.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.new` constructs a new object with attributes and blocks configured for the `transformation_details_storage_config` +Terraform sub block. + + + +**Args**: + - `table` (`list[obj]`): The BigQuery table in which to store the output. When `null`, the `table` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.table.new](#fn-inspect_jobinspect_jobactionsdeidentifytablenew) constructor. + +**Returns**: + - An attribute object that represents the `transformation_details_storage_config` sub block. + + +## obj inspect_job.actions.deidentify.transformation_details_storage_config.table + + + +### fn inspect_job.actions.deidentify.transformation_details_storage_config.table.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.table.new` constructs a new object with attributes and blocks configured for the `table` +Terraform sub block. + + + +**Args**: + - `dataset_id` (`string`): The ID of the dataset containing this table. + - `project_id` (`string`): The ID of the project containing this table. + - `table_id` (`string`): The ID of the table. The ID must contain only letters (a-z, +A-Z), numbers (0-9), or underscores (_). The maximum length +is 1,024 characters. When `null`, the `table_id` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `table` sub block. + + +## obj inspect_job.actions.job_notification_emails + + + +### fn inspect_job.actions.job_notification_emails.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.actions.job_notification_emails.new` constructs a new object with attributes and blocks configured for the `job_notification_emails` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `job_notification_emails` sub block. + + ## obj inspect_job.actions.pub_sub @@ -533,6 +686,7 @@ Terraform sub block. - `big_query_options` (`list[obj]`): Options defining BigQuery table and row identifiers. When `null`, the `big_query_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.new](#fn-inspect_jobinspect_jobbig_query_optionsnew) constructor. - `cloud_storage_options` (`list[obj]`): Options defining a file or a set of files within a Google Cloud Storage bucket. When `null`, the `cloud_storage_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.cloud_storage_options.new](#fn-inspect_jobinspect_jobcloud_storage_optionsnew) constructor. - `datastore_options` (`list[obj]`): Options defining a data set within Google Cloud Datastore. When `null`, the `datastore_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.datastore_options.new](#fn-inspect_jobinspect_jobdatastore_optionsnew) constructor. + - `hybrid_options` (`list[obj]`): Configuration to control jobs where the content being inspected is outside of Google Cloud Platform. When `null`, the `hybrid_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.new](#fn-inspect_jobinspect_jobhybrid_optionsnew) constructor. - `timespan_config` (`list[obj]`): Information on where to inspect When `null`, the `timespan_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.timespan_config.new](#fn-inspect_jobinspect_jobtimespan_confignew) constructor. **Returns**: @@ -784,6 +938,95 @@ Terraform sub block. - An attribute object that represents the `partition_id` sub block. +## obj inspect_job.storage_config.hybrid_options + + + +### fn inspect_job.storage_config.hybrid_options.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.new` constructs a new object with attributes and blocks configured for the `hybrid_options` +Terraform sub block. + + + +**Args**: + - `description` (`string`): A short description of where the data is coming from. Will be stored once in the job. 256 max length. When `null`, the `description` field will be omitted from the resulting object. + - `labels` (`obj`): To organize findings, these labels will be added to each finding. + +Label keys must be between 1 and 63 characters long and must conform to the following regular expression: '[a-z]([-a-z0-9]*[a-z0-9])?'. + +Label values must be between 0 and 63 characters long and must conform to the regular expression '([a-z]([-a-z0-9]*[a-z0-9])?)?'. + +No more than 10 labels can be associated with a given finding. + +Examples: +* '"environment" : "production"' +* '"pipeline" : "etl"' When `null`, the `labels` field will be omitted from the resulting object. + - `required_finding_label_keys` (`list`): These are labels that each inspection request must include within their 'finding_labels' map. Request +may contain others, but any missing one of these will be rejected. + +Label keys must be between 1 and 63 characters long and must conform to the following regular expression: '[a-z]([-a-z0-9]*[a-z0-9])?'. + +No more than 10 keys can be required. When `null`, the `required_finding_label_keys` field will be omitted from the resulting object. + - `table_options` (`list[obj]`): If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. When `null`, the `table_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.table_options.new](#fn-inspect_jobinspect_jobstorage_configtable_optionsnew) constructor. + +**Returns**: + - An attribute object that represents the `hybrid_options` sub block. + + +## obj inspect_job.storage_config.hybrid_options.table_options + + + +### fn inspect_job.storage_config.hybrid_options.table_options.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.table_options.new` constructs a new object with attributes and blocks configured for the `table_options` +Terraform sub block. + + + +**Args**: + - `identifying_fields` (`list[obj]`): The columns that are the primary keys for table objects included in ContentItem. A copy of this +cell's value will stored alongside alongside each finding so that the finding can be traced to +the specific row it came from. No more than 3 may be provided. When `null`, the `identifying_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.table_options.identifying_fields.new](#fn-inspect_jobinspect_jobstorage_confighybrid_optionsidentifying_fieldsnew) constructor. + +**Returns**: + - An attribute object that represents the `table_options` sub block. + + +## obj inspect_job.storage_config.hybrid_options.table_options.identifying_fields + + + +### fn inspect_job.storage_config.hybrid_options.table_options.identifying_fields.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.storage_config.hybrid_options.table_options.identifying_fields.new` constructs a new object with attributes and blocks configured for the `identifying_fields` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name describing the field. + +**Returns**: + - An attribute object that represents the `identifying_fields` sub block. + + ## obj inspect_job.storage_config.timespan_config @@ -884,12 +1127,33 @@ Terraform sub block. **Args**: + - `manual` (`list[obj]`): For use with hybrid jobs. Jobs must be manually created and finished. When `null`, the `manual` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.manual.new](#fn-triggersmanualnew) constructor. - `schedule` (`list[obj]`): Schedule for triggered jobs When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.schedule.new](#fn-triggersschedulenew) constructor. **Returns**: - An attribute object that represents the `triggers` sub block. +## obj triggers.manual + + + +### fn triggers.manual.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.triggers.manual.new` constructs a new object with attributes and blocks configured for the `manual` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `manual` sub block. + + ## obj triggers.schedule diff --git a/docs/4.x/iam_workforce_pool_provider.md b/docs/4.x/iam_workforce_pool_provider.md index 6abfb72..56d0380 100644 --- a/docs/4.x/iam_workforce_pool_provider.md +++ b/docs/4.x/iam_workforce_pool_provider.md @@ -31,6 +31,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withWorkforcePoolId()`](#fn-withworkforcepoolid) * [`obj oidc`](#obj-oidc) * [`fn new()`](#fn-oidcnew) + * [`obj oidc.web_sso_config`](#obj-oidcweb_sso_config) + * [`fn new()`](#fn-oidcweb_sso_confignew) * [`obj saml`](#obj-saml) * [`fn new()`](#fn-samlnew) * [`obj timeouts`](#obj-timeouts) @@ -520,11 +522,38 @@ Terraform sub block. **Args**: - `client_id` (`string`): The client ID. Must match the audience claim of the JWT issued by the identity provider. - `issuer_uri` (`string`): The OIDC issuer URI. Must be a valid URI using the 'https' scheme. + - `web_sso_config` (`list[obj]`): Configuration for web single sign-on for the OIDC provider. Here, web sign-in refers to console sign-in and gcloud sign-in through the browser. When `null`, the `web_sso_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.iam_workforce_pool_provider.oidc.web_sso_config.new](#fn-oidcweb_sso_confignew) constructor. **Returns**: - An attribute object that represents the `oidc` sub block. +## obj oidc.web_sso_config + + + +### fn oidc.web_sso_config.new + +```ts +new() +``` + + +`google.iam_workforce_pool_provider.oidc.web_sso_config.new` constructs a new object with attributes and blocks configured for the `web_sso_config` +Terraform sub block. + + + +**Args**: + - `assertion_claims_behavior` (`string`): The behavior for how OIDC Claims are included in the 'assertion' object used for attribute mapping and attribute condition. +* ONLY_ID_TOKEN_CLAIMS: Only include ID Token Claims. Possible values: ["ONLY_ID_TOKEN_CLAIMS"] + - `response_type` (`string`): The Response Type to request for in the OIDC Authorization Request for web sign-in. +* ID_TOKEN: The 'response_type=id_token' selection uses the Implicit Flow for web sign-in. Possible values: ["ID_TOKEN"] + +**Returns**: + - An attribute object that represents the `web_sso_config` sub block. + + ## obj saml diff --git a/docs/4.x/tags_tag_key.md b/docs/4.x/tags_tag_key.md index 585b3e3..d7c424a 100644 --- a/docs/4.x/tags_tag_key.md +++ b/docs/4.x/tags_tag_key.md @@ -55,7 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `description` (`string`): User-assigned description of the TagKey. Must not exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object. - - `parent` (`string`): Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}. + - `parent` (`string`): Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id} or projects/{project_id_or_number}. - `purpose` (`string`): Optional. A purpose cannot be changed once set. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. Possible values: ["GCE_FIREWALL"] When `null`, the `purpose` field will be omitted from the resulting object. @@ -90,7 +90,7 @@ injecting into a complete block. **Args**: - `description` (`string`): User-assigned description of the TagKey. Must not exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object. - - `parent` (`string`): Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}. + - `parent` (`string`): Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id} or projects/{project_id_or_number}. - `purpose` (`string`): Optional. A purpose cannot be changed once set. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. Possible values: ["GCE_FIREWALL"] When `null`, the `purpose` field will be omitted from the resulting object.