From a8d23c4c8e72032726d252a2e6d658c0afb01b8e Mon Sep 17 00:00:00 2001 From: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Date: Wed, 8 Mar 2023 10:30:17 -0600 Subject: [PATCH] Update dependency hashicorp/terraform-provider-google to v4.56.0 (#23) Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Co-authored-by: renovate[bot] --- 4.x/_gen/main.libsonnet | 9 + 4.x/_gen/resources/alloydb_cluster.libsonnet | 2 +- .../resources/cloud_run_v2_service.libsonnet | 28 +- .../cloudbuild_worker_pool.libsonnet | 6 +- ...mpute_shared_vpc_service_project.libsonnet | 24 +- .../container_azure_cluster.libsonnet | 42 ++- .../data_catalog_policy_tag.libsonnet | 112 ++++++++ ...a_catalog_policy_tag_iam_binding.libsonnet | 98 +++++++ ...ta_catalog_policy_tag_iam_member.libsonnet | 98 +++++++ ...ta_catalog_policy_tag_iam_policy.libsonnet | 45 ++++ .../resources/data_catalog_taxonomy.libsonnet | 126 +++++++++ ...ata_catalog_taxonomy_iam_binding.libsonnet | 126 +++++++++ ...data_catalog_taxonomy_iam_member.libsonnet | 126 +++++++++ ...data_catalog_taxonomy_iam_policy.libsonnet | 76 ++++++ 4.x/_gen/resources/scc_mute_config.libsonnet | 112 ++++++++ .../resources/storage_transfer_job.libsonnet | 6 +- docs/4.x/README.md | 9 + docs/4.x/alloydb_cluster.md | 2 +- docs/4.x/cloud_run_v2_service.md | 58 ++++ docs/4.x/cloudbuild_worker_pool.md | 1 + .../4.x/compute_shared_vpc_service_project.md | 21 ++ docs/4.x/container_azure_cluster.md | 71 ++++- docs/4.x/data_catalog_policy_tag.md | 230 ++++++++++++++++ .../data_catalog_policy_tag_iam_binding.md | 198 ++++++++++++++ .../4.x/data_catalog_policy_tag_iam_member.md | 198 ++++++++++++++ .../4.x/data_catalog_policy_tag_iam_policy.md | 111 ++++++++ docs/4.x/data_catalog_taxonomy.md | 247 ++++++++++++++++++ docs/4.x/data_catalog_taxonomy_iam_binding.md | 236 +++++++++++++++++ docs/4.x/data_catalog_taxonomy_iam_member.md | 236 +++++++++++++++++ docs/4.x/data_catalog_taxonomy_iam_policy.md | 149 +++++++++++ docs/4.x/scc_mute_config.md | 228 ++++++++++++++++ docs/4.x/storage_transfer_job.md | 2 + 32 files changed, 3017 insertions(+), 16 deletions(-) create mode 100644 4.x/_gen/resources/data_catalog_policy_tag.libsonnet create mode 100644 4.x/_gen/resources/data_catalog_policy_tag_iam_binding.libsonnet create mode 100644 4.x/_gen/resources/data_catalog_policy_tag_iam_member.libsonnet create mode 100644 4.x/_gen/resources/data_catalog_policy_tag_iam_policy.libsonnet create mode 100644 4.x/_gen/resources/data_catalog_taxonomy.libsonnet create mode 100644 4.x/_gen/resources/data_catalog_taxonomy_iam_binding.libsonnet create mode 100644 4.x/_gen/resources/data_catalog_taxonomy_iam_member.libsonnet create mode 100644 4.x/_gen/resources/data_catalog_taxonomy_iam_policy.libsonnet create mode 100644 4.x/_gen/resources/scc_mute_config.libsonnet create mode 100644 docs/4.x/data_catalog_policy_tag.md create mode 100644 docs/4.x/data_catalog_policy_tag_iam_binding.md create mode 100644 docs/4.x/data_catalog_policy_tag_iam_member.md create mode 100644 docs/4.x/data_catalog_policy_tag_iam_policy.md create mode 100644 docs/4.x/data_catalog_taxonomy.md create mode 100644 docs/4.x/data_catalog_taxonomy_iam_binding.md create mode 100644 docs/4.x/data_catalog_taxonomy_iam_member.md create mode 100644 docs/4.x/data_catalog_taxonomy_iam_policy.md create mode 100644 docs/4.x/scc_mute_config.md diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index a18cec70..7fb5d897 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -263,11 +263,19 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); data_catalog_entry_group_iam_binding: (import 'resources/data_catalog_entry_group_iam_binding.libsonnet'), data_catalog_entry_group_iam_member: (import 'resources/data_catalog_entry_group_iam_member.libsonnet'), data_catalog_entry_group_iam_policy: (import 'resources/data_catalog_entry_group_iam_policy.libsonnet'), + data_catalog_policy_tag: (import 'resources/data_catalog_policy_tag.libsonnet'), + data_catalog_policy_tag_iam_binding: (import 'resources/data_catalog_policy_tag_iam_binding.libsonnet'), + data_catalog_policy_tag_iam_member: (import 'resources/data_catalog_policy_tag_iam_member.libsonnet'), + data_catalog_policy_tag_iam_policy: (import 'resources/data_catalog_policy_tag_iam_policy.libsonnet'), data_catalog_tag: (import 'resources/data_catalog_tag.libsonnet'), data_catalog_tag_template: (import 'resources/data_catalog_tag_template.libsonnet'), data_catalog_tag_template_iam_binding: (import 'resources/data_catalog_tag_template_iam_binding.libsonnet'), data_catalog_tag_template_iam_member: (import 'resources/data_catalog_tag_template_iam_member.libsonnet'), data_catalog_tag_template_iam_policy: (import 'resources/data_catalog_tag_template_iam_policy.libsonnet'), + data_catalog_taxonomy: (import 'resources/data_catalog_taxonomy.libsonnet'), + data_catalog_taxonomy_iam_binding: (import 'resources/data_catalog_taxonomy_iam_binding.libsonnet'), + data_catalog_taxonomy_iam_member: (import 'resources/data_catalog_taxonomy_iam_member.libsonnet'), + data_catalog_taxonomy_iam_policy: (import 'resources/data_catalog_taxonomy_iam_policy.libsonnet'), data_fusion_instance: (import 'resources/data_fusion_instance.libsonnet'), data_fusion_instance_iam_binding: (import 'resources/data_fusion_instance_iam_binding.libsonnet'), data_fusion_instance_iam_member: (import 'resources/data_fusion_instance_iam_member.libsonnet'), @@ -520,6 +528,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); recaptcha_enterprise_key: (import 'resources/recaptcha_enterprise_key.libsonnet'), redis_instance: (import 'resources/redis_instance.libsonnet'), resource_manager_lien: (import 'resources/resource_manager_lien.libsonnet'), + scc_mute_config: (import 'resources/scc_mute_config.libsonnet'), scc_notification_config: (import 'resources/scc_notification_config.libsonnet'), scc_source: (import 'resources/scc_source.libsonnet'), scc_source_iam_binding: (import 'resources/scc_source_iam_binding.libsonnet'), diff --git a/4.x/_gen/resources/alloydb_cluster.libsonnet b/4.x/_gen/resources/alloydb_cluster.libsonnet index 0e922ad2..453366c3 100644 --- a/4.x/_gen/resources/alloydb_cluster.libsonnet +++ b/4.x/_gen/resources/alloydb_cluster.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='alloydb_cluster', url='', help='`alloydb_cluster` represents the `google_alloydb_cluster` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), automated_backup_policy:: { - '#new':: d.fn(help='\n`google.alloydb_cluster.automated_backup_policy.new` constructs a new object with attributes and blocks configured for the `automated_backup_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `backup_window` (`string`): The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.\n\nThe backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour.\n\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `backup_window` field will be omitted from the resulting object.\n - `enabled` (`bool`): Whether automated automated backups are enabled. When `null`, the `enabled` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to backups created using this configuration. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. When `null`, the `location` field will be omitted from the resulting object.\n - `quantity_based_retention` (`list[obj]`): Quantity-based Backup retention policy to retain recent backups. When `null`, the `quantity_based_retention` 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.quantity_based_retention.new](#fn-automated_backup_policyquantity_based_retentionnew) constructor.\n - `time_based_retention` (`list[obj]`): Time-based Backup retention policy. When `null`, the `time_based_retention` 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.time_based_retention.new](#fn-automated_backup_policytime_based_retentionnew) constructor.\n - `weekly_schedule` (`list[obj]`): Weekly schedule for the Backup. When `null`, the `weekly_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.alloydb_cluster.automated_backup_policy.weekly_schedule.new](#fn-automated_backup_policyweekly_schedulenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `automated_backup_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.alloydb_cluster.automated_backup_policy.new` constructs a new object with attributes and blocks configured for the `automated_backup_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `backup_window` (`string`): The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.\n\nThe backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour.\n\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `backup_window` field will be omitted from the resulting object.\n - `enabled` (`bool`): Whether automated backups are enabled. When `null`, the `enabled` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to backups created using this configuration. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. When `null`, the `location` field will be omitted from the resulting object.\n - `quantity_based_retention` (`list[obj]`): Quantity-based Backup retention policy to retain recent backups. When `null`, the `quantity_based_retention` 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.quantity_based_retention.new](#fn-automated_backup_policyquantity_based_retentionnew) constructor.\n - `time_based_retention` (`list[obj]`): Time-based Backup retention policy. When `null`, the `time_based_retention` 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.time_based_retention.new](#fn-automated_backup_policytime_based_retentionnew) constructor.\n - `weekly_schedule` (`list[obj]`): Weekly schedule for the Backup. When `null`, the `weekly_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.alloydb_cluster.automated_backup_policy.weekly_schedule.new](#fn-automated_backup_policyweekly_schedulenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `automated_backup_policy` sub block.\n', args=[]), new( backup_window=null, enabled=null, diff --git a/4.x/_gen/resources/cloud_run_v2_service.libsonnet b/4.x/_gen/resources/cloud_run_v2_service.libsonnet index a4bff038..df3a878f 100644 --- a/4.x/_gen/resources/cloud_run_v2_service.libsonnet +++ b/4.x/_gen/resources/cloud_run_v2_service.libsonnet @@ -116,6 +116,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, liveness_probe:: { + grpc:: { + '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.containers.liveness_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), + new( + port=null, + service=null + ):: std.prune(a={ + port: port, + service: service, + }), + }, http_get:: { http_headers:: { '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.containers.liveness_probe.http_get.http_headers.new` constructs a new object with attributes and blocks configured for the `http_headers`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): The header field name\n - `value` (`string`): The header field value When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `http_headers` sub block.\n', args=[]), @@ -136,9 +146,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); path: path, }), }, - '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.containers.liveness_probe.new` constructs a new object with attributes and blocks configured for the `liveness_probe`\nTerraform sub block.\n\n\n\n**Args**:\n - `failure_threshold` (`number`): Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. When `null`, the `failure_threshold` field will be omitted from the resulting object.\n - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `initial_delay_seconds` field will be omitted from the resulting object.\n - `period_seconds` (`number`): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When `null`, the `period_seconds` field will be omitted from the resulting object.\n - `timeout_seconds` (`number`): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `timeout_seconds` field will be omitted from the resulting object.\n - `http_get` (`list[obj]`): HTTPGet specifies the http request to perform. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.liveness_probe.http_get.new](#fn-templatetemplatecontainershttp_getnew) constructor.\n - `tcp_socket` (`list[obj]`): TCPSocket specifies an action involving a TCP port. This field is not supported in liveness probe currently. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.liveness_probe.tcp_socket.new](#fn-templatetemplatecontainerstcp_socketnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `liveness_probe` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.containers.liveness_probe.new` constructs a new object with attributes and blocks configured for the `liveness_probe`\nTerraform sub block.\n\n\n\n**Args**:\n - `failure_threshold` (`number`): Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. When `null`, the `failure_threshold` field will be omitted from the resulting object.\n - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `initial_delay_seconds` field will be omitted from the resulting object.\n - `period_seconds` (`number`): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When `null`, the `period_seconds` field will be omitted from the resulting object.\n - `timeout_seconds` (`number`): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `timeout_seconds` field will be omitted from the resulting object.\n - `grpc` (`list[obj]`): GRPC specifies an action involving a GRPC port. When `null`, the `grpc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.liveness_probe.grpc.new](#fn-templatetemplatecontainersgrpcnew) constructor.\n - `http_get` (`list[obj]`): HTTPGet specifies the http request to perform. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.liveness_probe.http_get.new](#fn-templatetemplatecontainershttp_getnew) constructor.\n - `tcp_socket` (`list[obj]`): TCPSocket specifies an action involving a TCP port. This field is not supported in liveness probe currently. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.liveness_probe.tcp_socket.new](#fn-templatetemplatecontainerstcp_socketnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `liveness_probe` sub block.\n', args=[]), new( failure_threshold=null, + grpc=null, http_get=null, initial_delay_seconds=null, period_seconds=null, @@ -146,6 +157,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeout_seconds=null ):: std.prune(a={ failure_threshold: failure_threshold, + grpc: grpc, http_get: http_get, initial_delay_seconds: initial_delay_seconds, period_seconds: period_seconds, @@ -208,6 +220,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, startup_probe:: { + grpc:: { + '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.containers.startup_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), + new( + port=null, + service=null + ):: std.prune(a={ + port: port, + service: service, + }), + }, http_get:: { http_headers:: { '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.containers.startup_probe.http_get.http_headers.new` constructs a new object with attributes and blocks configured for the `http_headers`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): The header field name\n - `value` (`string`): The header field value When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `http_headers` sub block.\n', args=[]), @@ -228,9 +250,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); path: path, }), }, - '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.containers.startup_probe.new` constructs a new object with attributes and blocks configured for the `startup_probe`\nTerraform sub block.\n\n\n\n**Args**:\n - `failure_threshold` (`number`): Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. When `null`, the `failure_threshold` field will be omitted from the resulting object.\n - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `initial_delay_seconds` field will be omitted from the resulting object.\n - `period_seconds` (`number`): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When `null`, the `period_seconds` field will be omitted from the resulting object.\n - `timeout_seconds` (`number`): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `timeout_seconds` field will be omitted from the resulting object.\n - `http_get` (`list[obj]`): HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.startup_probe.http_get.new](#fn-templatetemplatecontainershttp_getnew) constructor.\n - `tcp_socket` (`list[obj]`): TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.startup_probe.tcp_socket.new](#fn-templatetemplatecontainerstcp_socketnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `startup_probe` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.containers.startup_probe.new` constructs a new object with attributes and blocks configured for the `startup_probe`\nTerraform sub block.\n\n\n\n**Args**:\n - `failure_threshold` (`number`): Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. When `null`, the `failure_threshold` field will be omitted from the resulting object.\n - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `initial_delay_seconds` field will be omitted from the resulting object.\n - `period_seconds` (`number`): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When `null`, the `period_seconds` field will be omitted from the resulting object.\n - `timeout_seconds` (`number`): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `timeout_seconds` field will be omitted from the resulting object.\n - `grpc` (`list[obj]`): GRPC specifies an action involving a GRPC port. When `null`, the `grpc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.startup_probe.grpc.new](#fn-templatetemplatecontainersgrpcnew) constructor.\n - `http_get` (`list[obj]`): HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.startup_probe.http_get.new](#fn-templatetemplatecontainershttp_getnew) constructor.\n - `tcp_socket` (`list[obj]`): TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.startup_probe.tcp_socket.new](#fn-templatetemplatecontainerstcp_socketnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `startup_probe` sub block.\n', args=[]), new( failure_threshold=null, + grpc=null, http_get=null, initial_delay_seconds=null, period_seconds=null, @@ -238,6 +261,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeout_seconds=null ):: std.prune(a={ failure_threshold: failure_threshold, + grpc: grpc, http_get: http_get, initial_delay_seconds: initial_delay_seconds, period_seconds: period_seconds, diff --git a/4.x/_gen/resources/cloudbuild_worker_pool.libsonnet b/4.x/_gen/resources/cloudbuild_worker_pool.libsonnet index 2243581c..54a51ea8 100644 --- a/4.x/_gen/resources/cloudbuild_worker_pool.libsonnet +++ b/4.x/_gen/resources/cloudbuild_worker_pool.libsonnet @@ -3,11 +3,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='cloudbuild_worker_pool', url='', help='`cloudbuild_worker_pool` represents the `google_cloudbuild_worker_pool` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), network_config:: { - '#new':: d.fn(help='\n`google.cloudbuild_worker_pool.network_config.new` constructs a new object with attributes and blocks configured for the `network_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `peered_network` (`string`): Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/cloud-build/docs/custom-workers/set-up-custom-worker-pool-environment#understanding_the_network_configuration_options)\n\n**Returns**:\n - An attribute object that represents the `network_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.cloudbuild_worker_pool.network_config.new` constructs a new object with attributes and blocks configured for the `network_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `peered_network` (`string`): Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/cloud-build/docs/custom-workers/set-up-custom-worker-pool-environment#understanding_the_network_configuration_options)\n - `peered_network_ip_range` (`string`): Optional. Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. When `null`, the `peered_network_ip_range` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `network_config` sub block.\n', args=[]), new( - peered_network + peered_network, + peered_network_ip_range=null ):: std.prune(a={ peered_network: peered_network, + peered_network_ip_range: peered_network_ip_range, }), }, '#new':: d.fn(help="\n`google.cloudbuild_worker_pool.new` injects a new `google_cloudbuild_worker_pool` 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.cloudbuild_worker_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.cloudbuild_worker_pool` using the reference:\n\n $._ref.google_cloudbuild_worker_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_cloudbuild_worker_pool.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`): User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters. When `null`, the `display_name` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): User-defined name of the `WorkerPool`.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `network_config` (`list[obj]`): Network configuration for the `WorkerPool`. When `null`, the `network_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.cloudbuild_worker_pool.network_config.new](#fn-network_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.cloudbuild_worker_pool.timeouts.new](#fn-timeoutsnew) constructor.\n - `worker_config` (`list[obj]`): Configuration to be used for a creating workers in the `WorkerPool`. When `null`, the `worker_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.cloudbuild_worker_pool.worker_config.new](#fn-worker_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), diff --git a/4.x/_gen/resources/compute_shared_vpc_service_project.libsonnet b/4.x/_gen/resources/compute_shared_vpc_service_project.libsonnet index 3cfcb513..dbfe1fd6 100644 --- a/4.x/_gen/resources/compute_shared_vpc_service_project.libsonnet +++ b/4.x/_gen/resources/compute_shared_vpc_service_project.libsonnet @@ -2,25 +2,33 @@ 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_shared_vpc_service_project', url='', help='`compute_shared_vpc_service_project` represents the `google_compute_shared_vpc_service_project` 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_shared_vpc_service_project.new` injects a new `google_compute_shared_vpc_service_project` 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_shared_vpc_service_project.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_shared_vpc_service_project` using the reference:\n\n $._ref.google_compute_shared_vpc_service_project.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_shared_vpc_service_project.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 - `host_project` (`string`): The ID of a host project to associate.\n - `service_project` (`string`): The ID of the project that will serve as a Shared VPC service project.\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_shared_vpc_service_project.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_shared_vpc_service_project.new` injects a new `google_compute_shared_vpc_service_project` 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_shared_vpc_service_project.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_shared_vpc_service_project` using the reference:\n\n $._ref.google_compute_shared_vpc_service_project.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_shared_vpc_service_project.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 - `deletion_policy` (`string`): The deletion policy for the shared VPC service. Setting ABANDON allows the resource\n\t\t\t\tto be abandoned rather than deleted. Possible values are: \u0026#34;ABANDON\u0026#34;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `host_project` (`string`): The ID of a host project to associate.\n - `service_project` (`string`): The ID of the project that will serve as a Shared VPC service project.\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_shared_vpc_service_project.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, host_project, service_project, + deletion_policy=null, timeouts=null, _meta={} ):: tf.withResource( type='google_compute_shared_vpc_service_project', label=resourceLabel, - attrs=self.newAttrs(host_project=host_project, service_project=service_project, timeouts=timeouts), + attrs=self.newAttrs( + deletion_policy=deletion_policy, + host_project=host_project, + service_project=service_project, + timeouts=timeouts + ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.compute_shared_vpc_service_project.newAttrs` constructs a new object with attributes and blocks configured for the `compute_shared_vpc_service_project`\nTerraform resource.\n\nUnlike [google.compute_shared_vpc_service_project.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 - `host_project` (`string`): The ID of a host project to associate.\n - `service_project` (`string`): The ID of the project that will serve as a Shared VPC service project.\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_shared_vpc_service_project.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_shared_vpc_service_project` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.compute_shared_vpc_service_project.newAttrs` constructs a new object with attributes and blocks configured for the `compute_shared_vpc_service_project`\nTerraform resource.\n\nUnlike [google.compute_shared_vpc_service_project.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 - `deletion_policy` (`string`): The deletion policy for the shared VPC service. Setting ABANDON allows the resource\n\t\t\t\tto be abandoned rather than deleted. Possible values are: "ABANDON". When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `host_project` (`string`): The ID of a host project to associate.\n - `service_project` (`string`): The ID of the project that will serve as a Shared VPC service project.\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_shared_vpc_service_project.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_shared_vpc_service_project` resource into the root Terraform configuration.\n', args=[]), newAttrs( host_project, service_project, + deletion_policy=null, timeouts=null ):: std.prune(a={ + deletion_policy: deletion_policy, host_project: host_project, service_project: service_project, timeouts: timeouts, @@ -35,6 +43,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); delete: delete, }), }, + '#withDeletionPolicy':: d.fn(help='`google.string.withDeletionPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the deletion_policy 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 `deletion_policy` field.\n', args=[]), + withDeletionPolicy(resourceLabel, value): { + resource+: { + google_compute_shared_vpc_service_project+: { + [resourceLabel]+: { + deletion_policy: value, + }, + }, + }, + }, '#withHostProject':: d.fn(help='`google.string.withHostProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the host_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 `host_project` field.\n', args=[]), withHostProject(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/container_azure_cluster.libsonnet b/4.x/_gen/resources/container_azure_cluster.libsonnet index 6bc455f5..9d05996f 100644 --- a/4.x/_gen/resources/container_azure_cluster.libsonnet +++ b/4.x/_gen/resources/container_azure_cluster.libsonnet @@ -18,6 +18,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); admin_users: admin_users, }), }, + azure_services_authentication:: { + '#new':: d.fn(help='\n`google.container_azure_cluster.azure_services_authentication.new` constructs a new object with attributes and blocks configured for the `azure_services_authentication`\nTerraform sub block.\n\n\n\n**Args**:\n - `application_id` (`string`): The Azure Active Directory Application ID for Authentication configuration.\n - `tenant_id` (`string`): The Azure Active Directory Tenant ID for Authentication configuration.\n\n**Returns**:\n - An attribute object that represents the `azure_services_authentication` sub block.\n', args=[]), + new( + application_id, + tenant_id + ):: std.prune(a={ + application_id: application_id, + tenant_id: tenant_id, + }), + }, control_plane:: { database_encryption:: { '#new':: d.fn(help='\n`google.container_azure_cluster.control_plane.database_encryption.new` constructs a new object with attributes and blocks configured for the `database_encryption`\nTerraform sub block.\n\n\n\n**Args**:\n - `key_id` (`string`): The ARM ID of the Azure Key Vault key to encrypt / decrypt data. For example: `/subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.KeyVault/vaults/<key-vault-id>/keys/<key-name>` Encryption will always take the latest version of the key and hence specific version is not supported.\n\n**Returns**:\n - An attribute object that represents the `database_encryption` sub block.\n', args=[]), @@ -116,16 +126,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); virtual_network_id: virtual_network_id, }), }, - '#new':: d.fn(help="\n`google.container_azure_cluster.new` injects a new `google_container_azure_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.container_azure_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_azure_cluster` using the reference:\n\n $._ref.google_container_azure_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_azure_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 - `annotations` (`obj`): Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object.\n - `azure_region` (`string`): The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call to list all supported Azure regions within a given Google Cloud region.\n - `client` (`string`): Name of the AzureClient. The `AzureClient` resource must reside on the same GCP project and region as the `AzureCluster`. `AzureClient` names are formatted as `projects/\u0026lt;project-number\u0026gt;/locations/\u0026lt;region\u0026gt;/azureClients/\u0026lt;client-id\u0026gt;`. See Resource Names (https:cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.\n - `description` (`string`): Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The name of this resource.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `resource_group_id` (`string`): The ARM ID of the resource group where the cluster resources are deployed. For example: `/subscriptions/*/resourceGroups/*`\n - `authorization` (`list[obj]`): Configuration related to the cluster RBAC settings. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.authorization.new](#fn-authorizationnew) constructor.\n - `control_plane` (`list[obj]`): Configuration related to the cluster control plane. When `null`, the `control_plane` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.control_plane.new](#fn-control_planenew) constructor.\n - `fleet` (`list[obj]`): Fleet configuration. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.fleet.new](#fn-fleetnew) constructor.\n - `networking` (`list[obj]`): Cluster-wide networking configuration. When `null`, the `networking` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.networking.new](#fn-networkingnew) 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.container_azure_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.container_azure_cluster.new` injects a new `google_container_azure_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.container_azure_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_azure_cluster` using the reference:\n\n $._ref.google_container_azure_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_azure_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 - `annotations` (`obj`): Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object.\n - `azure_region` (`string`): The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call to list all supported Azure regions within a given Google Cloud region.\n - `client` (`string`): Name of the AzureClient. The `AzureClient` resource must reside on the same GCP project and region as the `AzureCluster`. `AzureClient` names are formatted as `projects/\u0026lt;project-number\u0026gt;/locations/\u0026lt;region\u0026gt;/azureClients/\u0026lt;client-id\u0026gt;`. See Resource Names (https:cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names. When `null`, the `client` field will be omitted from the resulting object.\n - `description` (`string`): Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The name of this resource.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `resource_group_id` (`string`): The ARM ID of the resource group where the cluster resources are deployed. For example: `/subscriptions/*/resourceGroups/*`\n - `authorization` (`list[obj]`): Configuration related to the cluster RBAC settings. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.authorization.new](#fn-authorizationnew) constructor.\n - `azure_services_authentication` (`list[obj]`): Azure authentication configuration for management of Azure resources When `null`, the `azure_services_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.azure_services_authentication.new](#fn-azure_services_authenticationnew) constructor.\n - `control_plane` (`list[obj]`): Configuration related to the cluster control plane. When `null`, the `control_plane` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.control_plane.new](#fn-control_planenew) constructor.\n - `fleet` (`list[obj]`): Fleet configuration. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.fleet.new](#fn-fleetnew) constructor.\n - `networking` (`list[obj]`): Cluster-wide networking configuration. When `null`, the `networking` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.networking.new](#fn-networkingnew) 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.container_azure_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, azure_region, - client, location, name, resource_group_id, annotations=null, authorization=null, + azure_services_authentication=null, + client=null, control_plane=null, description=null, fleet=null, @@ -140,6 +151,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); annotations=annotations, authorization=authorization, azure_region=azure_region, + azure_services_authentication=azure_services_authentication, client=client, control_plane=control_plane, description=description, @@ -153,15 +165,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.container_azure_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `container_azure_cluster`\nTerraform resource.\n\nUnlike [google.container_azure_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 - `annotations` (`obj`): Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object.\n - `azure_region` (`string`): The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call to list all supported Azure regions within a given Google Cloud region.\n - `client` (`string`): Name of the AzureClient. The `AzureClient` resource must reside on the same GCP project and region as the `AzureCluster`. `AzureClient` names are formatted as `projects/<project-number>/locations/<region>/azureClients/<client-id>`. See Resource Names (https:cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.\n - `description` (`string`): Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The name of this resource.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `resource_group_id` (`string`): The ARM ID of the resource group where the cluster resources are deployed. For example: `/subscriptions/*/resourceGroups/*`\n - `authorization` (`list[obj]`): Configuration related to the cluster RBAC settings. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.authorization.new](#fn-authorizationnew) constructor.\n - `control_plane` (`list[obj]`): Configuration related to the cluster control plane. When `null`, the `control_plane` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.control_plane.new](#fn-control_planenew) constructor.\n - `fleet` (`list[obj]`): Fleet configuration. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.fleet.new](#fn-fleetnew) constructor.\n - `networking` (`list[obj]`): Cluster-wide networking configuration. When `null`, the `networking` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.networking.new](#fn-networkingnew) 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.container_azure_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 `container_azure_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.container_azure_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `container_azure_cluster`\nTerraform resource.\n\nUnlike [google.container_azure_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 - `annotations` (`obj`): Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object.\n - `azure_region` (`string`): The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call to list all supported Azure regions within a given Google Cloud region.\n - `client` (`string`): Name of the AzureClient. The `AzureClient` resource must reside on the same GCP project and region as the `AzureCluster`. `AzureClient` names are formatted as `projects/<project-number>/locations/<region>/azureClients/<client-id>`. See Resource Names (https:cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names. When `null`, the `client` field will be omitted from the resulting object.\n - `description` (`string`): Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The name of this resource.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `resource_group_id` (`string`): The ARM ID of the resource group where the cluster resources are deployed. For example: `/subscriptions/*/resourceGroups/*`\n - `authorization` (`list[obj]`): Configuration related to the cluster RBAC settings. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.authorization.new](#fn-authorizationnew) constructor.\n - `azure_services_authentication` (`list[obj]`): Azure authentication configuration for management of Azure resources When `null`, the `azure_services_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.azure_services_authentication.new](#fn-azure_services_authenticationnew) constructor.\n - `control_plane` (`list[obj]`): Configuration related to the cluster control plane. When `null`, the `control_plane` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.control_plane.new](#fn-control_planenew) constructor.\n - `fleet` (`list[obj]`): Fleet configuration. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.fleet.new](#fn-fleetnew) constructor.\n - `networking` (`list[obj]`): Cluster-wide networking configuration. When `null`, the `networking` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.networking.new](#fn-networkingnew) 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.container_azure_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 `container_azure_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( azure_region, - client, location, name, resource_group_id, annotations=null, authorization=null, + azure_services_authentication=null, + client=null, control_plane=null, description=null, fleet=null, @@ -172,6 +185,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); annotations: annotations, authorization: authorization, azure_region: azure_region, + azure_services_authentication: azure_services_authentication, client: client, control_plane: control_plane, description: description, @@ -235,6 +249,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withAzureServicesAuthentication':: d.fn(help='`google.list[obj].withAzureServicesAuthentication` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the azure_services_authentication 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].withAzureServicesAuthenticationMixin](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 `azure_services_authentication` field.\n', args=[]), + withAzureServicesAuthentication(resourceLabel, value): { + resource+: { + google_container_azure_cluster+: { + [resourceLabel]+: { + azure_services_authentication: value, + }, + }, + }, + }, + '#withAzureServicesAuthenticationMixin':: d.fn(help='`google.list[obj].withAzureServicesAuthenticationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the azure_services_authentication 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].withAzureServicesAuthentication](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 `azure_services_authentication` field.\n', args=[]), + withAzureServicesAuthenticationMixin(resourceLabel, value): { + resource+: { + google_container_azure_cluster+: { + [resourceLabel]+: { + azure_services_authentication+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withClient':: d.fn(help='`google.string.withClient` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the client 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 `client` field.\n', args=[]), withClient(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/data_catalog_policy_tag.libsonnet b/4.x/_gen/resources/data_catalog_policy_tag.libsonnet new file mode 100644 index 00000000..612e063a --- /dev/null +++ b/4.x/_gen/resources/data_catalog_policy_tag.libsonnet @@ -0,0 +1,112 @@ +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='data_catalog_policy_tag', url='', help='`data_catalog_policy_tag` represents the `google_data_catalog_policy_tag` 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.data_catalog_policy_tag.new` injects a new `google_data_catalog_policy_tag` 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.data_catalog_policy_tag.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_catalog_policy_tag` using the reference:\n\n $._ref.google_data_catalog_policy_tag.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_catalog_policy_tag.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`): Description of this policy tag. It must: contain only unicode characters, tabs,\nnewlines, carriage returns and page breaks; and be at most 2000 bytes long when\nencoded in UTF-8. If not set, defaults to an empty description.\nIf not set, defaults to an empty description. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): User defined name of this policy tag. It must: be unique within the parent\ntaxonomy; contain only unicode letters, numbers, underscores, dashes and spaces;\nnot start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.\n - `parent_policy_tag` (`string`): Resource name of this policy tag\u0026#39;s parent policy tag.\nIf empty, it means this policy tag is a top level policy tag.\nIf not set, defaults to an empty string. When `null`, the `parent_policy_tag` field will be omitted from the resulting object.\n - `taxonomy` (`string`): Taxonomy the policy tag is associated with\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.data_catalog_policy_tag.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, + display_name, + taxonomy, + description=null, + parent_policy_tag=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_data_catalog_policy_tag', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + display_name=display_name, + parent_policy_tag=parent_policy_tag, + taxonomy=taxonomy, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data_catalog_policy_tag.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_policy_tag`\nTerraform resource.\n\nUnlike [google.data_catalog_policy_tag.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`): Description of this policy tag. It must: contain only unicode characters, tabs,\nnewlines, carriage returns and page breaks; and be at most 2000 bytes long when\nencoded in UTF-8. If not set, defaults to an empty description.\nIf not set, defaults to an empty description. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): User defined name of this policy tag. It must: be unique within the parent\ntaxonomy; contain only unicode letters, numbers, underscores, dashes and spaces;\nnot start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.\n - `parent_policy_tag` (`string`): Resource name of this policy tag's parent policy tag.\nIf empty, it means this policy tag is a top level policy tag.\nIf not set, defaults to an empty string. When `null`, the `parent_policy_tag` field will be omitted from the resulting object.\n - `taxonomy` (`string`): Taxonomy the policy tag is associated with\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.data_catalog_policy_tag.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 `data_catalog_policy_tag` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + display_name, + taxonomy, + description=null, + parent_policy_tag=null, + timeouts=null + ):: std.prune(a={ + description: description, + display_name: display_name, + parent_policy_tag: parent_policy_tag, + taxonomy: taxonomy, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.data_catalog_policy_tag.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 - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#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_data_catalog_policy_tag+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDisplayName':: d.fn(help='`google.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the display_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 `display_name` field.\n', args=[]), + withDisplayName(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withParentPolicyTag':: d.fn(help='`google.string.withParentPolicyTag` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the parent_policy_tag 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_policy_tag` field.\n', args=[]), + withParentPolicyTag(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag+: { + [resourceLabel]+: { + parent_policy_tag: value, + }, + }, + }, + }, + '#withTaxonomy':: d.fn(help='`google.string.withTaxonomy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the taxonomy 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 `taxonomy` field.\n', args=[]), + withTaxonomy(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag+: { + [resourceLabel]+: { + taxonomy: 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_data_catalog_policy_tag+: { + [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_data_catalog_policy_tag+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/data_catalog_policy_tag_iam_binding.libsonnet b/4.x/_gen/resources/data_catalog_policy_tag_iam_binding.libsonnet new file mode 100644 index 00000000..bf787e04 --- /dev/null +++ b/4.x/_gen/resources/data_catalog_policy_tag_iam_binding.libsonnet @@ -0,0 +1,98 @@ +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='data_catalog_policy_tag_iam_binding', url='', help='`data_catalog_policy_tag_iam_binding` represents the `google_data_catalog_policy_tag_iam_binding` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + condition:: { + '#new':: d.fn(help='\n`google.data_catalog_policy_tag_iam_binding.condition.new` constructs a new object with attributes and blocks configured for the `condition`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `expression` (`string`): Set the `expression` field on the resulting object.\n - `title` (`string`): Set the `title` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + new( + expression, + title, + description=null + ):: std.prune(a={ + description: description, + expression: expression, + title: title, + }), + }, + '#new':: d.fn(help="\n`google.data_catalog_policy_tag_iam_binding.new` injects a new `google_data_catalog_policy_tag_iam_binding` 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.data_catalog_policy_tag_iam_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_catalog_policy_tag_iam_binding` using the reference:\n\n $._ref.google_data_catalog_policy_tag_iam_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_catalog_policy_tag_iam_binding.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 - `members` (`list`): Set the `members` field on the resulting resource block.\n - `policy_tag` (`string`): Set the `policy_tag` field on the resulting resource block.\n - `role` (`string`): Set the `role` field on the resulting resource block.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` 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_catalog_policy_tag_iam_binding.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + members, + policy_tag, + role, + condition=null, + _meta={} + ):: tf.withResource( + type='google_data_catalog_policy_tag_iam_binding', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + members=members, + policy_tag=policy_tag, + role=role + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data_catalog_policy_tag_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_policy_tag_iam_binding`\nTerraform resource.\n\nUnlike [google.data_catalog_policy_tag_iam_binding.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 - `members` (`list`): Set the `members` field on the resulting object.\n - `policy_tag` (`string`): Set the `policy_tag` field on the resulting object.\n - `role` (`string`): Set the `role` field on the resulting object.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` 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_catalog_policy_tag_iam_binding.condition.new](#fn-conditionnew) 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 `data_catalog_policy_tag_iam_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + members, + policy_tag, + role, + condition=null + ):: std.prune(a={ + condition: condition, + members: members, + policy_tag: policy_tag, + role: role, + }), + '#withCondition':: d.fn(help='`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withConditionMixin](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 `condition` field.\n', args=[]), + withCondition(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_binding+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withCondition](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 `condition` field.\n', args=[]), + withConditionMixin(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_binding+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withMembers':: d.fn(help='`google.list.withMembers` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the members field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `members` field.\n', args=[]), + withMembers(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_binding+: { + [resourceLabel]+: { + members: value, + }, + }, + }, + }, + '#withPolicyTag':: d.fn(help='`google.string.withPolicyTag` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy_tag 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 `policy_tag` field.\n', args=[]), + withPolicyTag(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_binding+: { + [resourceLabel]+: { + policy_tag: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google.string.withRole` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role 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 `role` field.\n', args=[]), + withRole(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_binding+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/data_catalog_policy_tag_iam_member.libsonnet b/4.x/_gen/resources/data_catalog_policy_tag_iam_member.libsonnet new file mode 100644 index 00000000..66b8f668 --- /dev/null +++ b/4.x/_gen/resources/data_catalog_policy_tag_iam_member.libsonnet @@ -0,0 +1,98 @@ +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='data_catalog_policy_tag_iam_member', url='', help='`data_catalog_policy_tag_iam_member` represents the `google_data_catalog_policy_tag_iam_member` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + condition:: { + '#new':: d.fn(help='\n`google.data_catalog_policy_tag_iam_member.condition.new` constructs a new object with attributes and blocks configured for the `condition`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `expression` (`string`): Set the `expression` field on the resulting object.\n - `title` (`string`): Set the `title` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + new( + expression, + title, + description=null + ):: std.prune(a={ + description: description, + expression: expression, + title: title, + }), + }, + '#new':: d.fn(help="\n`google.data_catalog_policy_tag_iam_member.new` injects a new `google_data_catalog_policy_tag_iam_member` 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.data_catalog_policy_tag_iam_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_catalog_policy_tag_iam_member` using the reference:\n\n $._ref.google_data_catalog_policy_tag_iam_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_catalog_policy_tag_iam_member.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 - `member` (`string`): Set the `member` field on the resulting resource block.\n - `policy_tag` (`string`): Set the `policy_tag` field on the resulting resource block.\n - `role` (`string`): Set the `role` field on the resulting resource block.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` 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_catalog_policy_tag_iam_member.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + member, + policy_tag, + role, + condition=null, + _meta={} + ):: tf.withResource( + type='google_data_catalog_policy_tag_iam_member', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + member=member, + policy_tag=policy_tag, + role=role + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data_catalog_policy_tag_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_policy_tag_iam_member`\nTerraform resource.\n\nUnlike [google.data_catalog_policy_tag_iam_member.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 - `member` (`string`): Set the `member` field on the resulting object.\n - `policy_tag` (`string`): Set the `policy_tag` field on the resulting object.\n - `role` (`string`): Set the `role` field on the resulting object.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` 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_catalog_policy_tag_iam_member.condition.new](#fn-conditionnew) 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 `data_catalog_policy_tag_iam_member` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + member, + policy_tag, + role, + condition=null + ):: std.prune(a={ + condition: condition, + member: member, + policy_tag: policy_tag, + role: role, + }), + '#withCondition':: d.fn(help='`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withConditionMixin](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 `condition` field.\n', args=[]), + withCondition(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_member+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withCondition](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 `condition` field.\n', args=[]), + withConditionMixin(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_member+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withMember':: d.fn(help='`google.string.withMember` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the member 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 `member` field.\n', args=[]), + withMember(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_member+: { + [resourceLabel]+: { + member: value, + }, + }, + }, + }, + '#withPolicyTag':: d.fn(help='`google.string.withPolicyTag` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy_tag 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 `policy_tag` field.\n', args=[]), + withPolicyTag(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_member+: { + [resourceLabel]+: { + policy_tag: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google.string.withRole` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role 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 `role` field.\n', args=[]), + withRole(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_member+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/data_catalog_policy_tag_iam_policy.libsonnet b/4.x/_gen/resources/data_catalog_policy_tag_iam_policy.libsonnet new file mode 100644 index 00000000..ea48931e --- /dev/null +++ b/4.x/_gen/resources/data_catalog_policy_tag_iam_policy.libsonnet @@ -0,0 +1,45 @@ +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='data_catalog_policy_tag_iam_policy', url='', help='`data_catalog_policy_tag_iam_policy` represents the `google_data_catalog_policy_tag_iam_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.data_catalog_policy_tag_iam_policy.new` injects a new `google_data_catalog_policy_tag_iam_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.data_catalog_policy_tag_iam_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_catalog_policy_tag_iam_policy` using the reference:\n\n $._ref.google_data_catalog_policy_tag_iam_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_catalog_policy_tag_iam_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 - `policy_data` (`string`): Set the `policy_data` field on the resulting resource block.\n - `policy_tag` (`string`): Set the `policy_tag` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + policy_data, + policy_tag, + _meta={} + ):: tf.withResource( + type='google_data_catalog_policy_tag_iam_policy', + label=resourceLabel, + attrs=self.newAttrs(policy_data=policy_data, policy_tag=policy_tag), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data_catalog_policy_tag_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_policy_tag_iam_policy`\nTerraform resource.\n\nUnlike [google.data_catalog_policy_tag_iam_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 - `policy_data` (`string`): Set the `policy_data` field on the resulting object.\n - `policy_tag` (`string`): Set the `policy_tag` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `data_catalog_policy_tag_iam_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + policy_data, + policy_tag + ):: std.prune(a={ + policy_data: policy_data, + policy_tag: policy_tag, + }), + '#withPolicyData':: d.fn(help='`google.string.withPolicyData` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy_data 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 `policy_data` field.\n', args=[]), + withPolicyData(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_policy+: { + [resourceLabel]+: { + policy_data: value, + }, + }, + }, + }, + '#withPolicyTag':: d.fn(help='`google.string.withPolicyTag` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy_tag 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 `policy_tag` field.\n', args=[]), + withPolicyTag(resourceLabel, value): { + resource+: { + google_data_catalog_policy_tag_iam_policy+: { + [resourceLabel]+: { + policy_tag: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/data_catalog_taxonomy.libsonnet b/4.x/_gen/resources/data_catalog_taxonomy.libsonnet new file mode 100644 index 00000000..2b60ce1e --- /dev/null +++ b/4.x/_gen/resources/data_catalog_taxonomy.libsonnet @@ -0,0 +1,126 @@ +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='data_catalog_taxonomy', url='', help='`data_catalog_taxonomy` represents the `google_data_catalog_taxonomy` 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.data_catalog_taxonomy.new` injects a new `google_data_catalog_taxonomy` 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.data_catalog_taxonomy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_catalog_taxonomy` using the reference:\n\n $._ref.google_data_catalog_taxonomy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_catalog_taxonomy.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 - `activated_policy_types` (`list`): A list of policy types that are activated for this taxonomy. If not set,\ndefaults to an empty list. Possible values: [\u0026#34;POLICY_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;FINE_GRAINED_ACCESS_CONTROL\u0026#34;] When `null`, the `activated_policy_types` field will be omitted from the resulting object.\n - `description` (`string`): Description of this taxonomy. It must: contain only unicode characters,\ntabs, newlines, carriage returns and page breaks; and be at most 2000 bytes\nlong when encoded in UTF-8. If not set, defaults to an empty description. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): User defined name of this taxonomy.\nIt must: contain only unicode letters, numbers, underscores, dashes\nand spaces; not start or end with spaces; and be at most 200 bytes\nlong when encoded in UTF-8.\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`): Taxonomy location region. When `null`, the `region` 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.data_catalog_taxonomy.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, + display_name, + activated_policy_types=null, + description=null, + project=null, + region=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_data_catalog_taxonomy', + label=resourceLabel, + attrs=self.newAttrs( + activated_policy_types=activated_policy_types, + description=description, + display_name=display_name, + project=project, + region=region, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data_catalog_taxonomy.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_taxonomy`\nTerraform resource.\n\nUnlike [google.data_catalog_taxonomy.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 - `activated_policy_types` (`list`): A list of policy types that are activated for this taxonomy. If not set,\ndefaults to an empty list. Possible values: ["POLICY_TYPE_UNSPECIFIED", "FINE_GRAINED_ACCESS_CONTROL"] When `null`, the `activated_policy_types` field will be omitted from the resulting object.\n - `description` (`string`): Description of this taxonomy. It must: contain only unicode characters,\ntabs, newlines, carriage returns and page breaks; and be at most 2000 bytes\nlong when encoded in UTF-8. If not set, defaults to an empty description. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): User defined name of this taxonomy.\nIt must: contain only unicode letters, numbers, underscores, dashes\nand spaces; not start or end with spaces; and be at most 200 bytes\nlong when encoded in UTF-8.\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`): Taxonomy location region. When `null`, the `region` 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.data_catalog_taxonomy.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 `data_catalog_taxonomy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + display_name, + activated_policy_types=null, + description=null, + project=null, + region=null, + timeouts=null + ):: std.prune(a={ + activated_policy_types: activated_policy_types, + description: description, + display_name: display_name, + project: project, + region: region, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.data_catalog_taxonomy.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 - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withActivatedPolicyTypes':: d.fn(help='`google.list.withActivatedPolicyTypes` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the activated_policy_types field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `activated_policy_types` field.\n', args=[]), + withActivatedPolicyTypes(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy+: { + [resourceLabel]+: { + activated_policy_types: 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_data_catalog_taxonomy+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDisplayName':: d.fn(help='`google.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the display_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 `display_name` field.\n', args=[]), + withDisplayName(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy+: { + [resourceLabel]+: { + display_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_data_catalog_taxonomy+: { + [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_data_catalog_taxonomy+: { + [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_data_catalog_taxonomy+: { + [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_data_catalog_taxonomy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/data_catalog_taxonomy_iam_binding.libsonnet b/4.x/_gen/resources/data_catalog_taxonomy_iam_binding.libsonnet new file mode 100644 index 00000000..d4412e39 --- /dev/null +++ b/4.x/_gen/resources/data_catalog_taxonomy_iam_binding.libsonnet @@ -0,0 +1,126 @@ +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='data_catalog_taxonomy_iam_binding', url='', help='`data_catalog_taxonomy_iam_binding` represents the `google_data_catalog_taxonomy_iam_binding` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + condition:: { + '#new':: d.fn(help='\n`google.data_catalog_taxonomy_iam_binding.condition.new` constructs a new object with attributes and blocks configured for the `condition`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `expression` (`string`): Set the `expression` field on the resulting object.\n - `title` (`string`): Set the `title` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + new( + expression, + title, + description=null + ):: std.prune(a={ + description: description, + expression: expression, + title: title, + }), + }, + '#new':: d.fn(help="\n`google.data_catalog_taxonomy_iam_binding.new` injects a new `google_data_catalog_taxonomy_iam_binding` 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.data_catalog_taxonomy_iam_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_catalog_taxonomy_iam_binding` using the reference:\n\n $._ref.google_data_catalog_taxonomy_iam_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_catalog_taxonomy_iam_binding.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 - `members` (`list`): Set the `members` field on the resulting resource block.\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`): Set the `region` field on the resulting resource block. When `null`, the `region` field will be omitted from the resulting object.\n - `role` (`string`): Set the `role` field on the resulting resource block.\n - `taxonomy` (`string`): Set the `taxonomy` field on the resulting resource block.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` 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_catalog_taxonomy_iam_binding.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + members, + role, + taxonomy, + condition=null, + project=null, + region=null, + _meta={} + ):: tf.withResource( + type='google_data_catalog_taxonomy_iam_binding', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + members=members, + project=project, + region=region, + role=role, + taxonomy=taxonomy + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data_catalog_taxonomy_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_taxonomy_iam_binding`\nTerraform resource.\n\nUnlike [google.data_catalog_taxonomy_iam_binding.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 - `members` (`list`): Set the `members` field on 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 - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object.\n - `role` (`string`): Set the `role` field on the resulting object.\n - `taxonomy` (`string`): Set the `taxonomy` field on the resulting object.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` 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_catalog_taxonomy_iam_binding.condition.new](#fn-conditionnew) 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 `data_catalog_taxonomy_iam_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + members, + role, + taxonomy, + condition=null, + project=null, + region=null + ):: std.prune(a={ + condition: condition, + members: members, + project: project, + region: region, + role: role, + taxonomy: taxonomy, + }), + '#withCondition':: d.fn(help='`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withConditionMixin](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 `condition` field.\n', args=[]), + withCondition(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_binding+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withCondition](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 `condition` field.\n', args=[]), + withConditionMixin(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_binding+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withMembers':: d.fn(help='`google.list.withMembers` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the members field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `members` field.\n', args=[]), + withMembers(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_binding+: { + [resourceLabel]+: { + members: 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_data_catalog_taxonomy_iam_binding+: { + [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_data_catalog_taxonomy_iam_binding+: { + [resourceLabel]+: { + region: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google.string.withRole` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role 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 `role` field.\n', args=[]), + withRole(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_binding+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withTaxonomy':: d.fn(help='`google.string.withTaxonomy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the taxonomy 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 `taxonomy` field.\n', args=[]), + withTaxonomy(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_binding+: { + [resourceLabel]+: { + taxonomy: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/data_catalog_taxonomy_iam_member.libsonnet b/4.x/_gen/resources/data_catalog_taxonomy_iam_member.libsonnet new file mode 100644 index 00000000..b6057d82 --- /dev/null +++ b/4.x/_gen/resources/data_catalog_taxonomy_iam_member.libsonnet @@ -0,0 +1,126 @@ +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='data_catalog_taxonomy_iam_member', url='', help='`data_catalog_taxonomy_iam_member` represents the `google_data_catalog_taxonomy_iam_member` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + condition:: { + '#new':: d.fn(help='\n`google.data_catalog_taxonomy_iam_member.condition.new` constructs a new object with attributes and blocks configured for the `condition`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `expression` (`string`): Set the `expression` field on the resulting object.\n - `title` (`string`): Set the `title` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + new( + expression, + title, + description=null + ):: std.prune(a={ + description: description, + expression: expression, + title: title, + }), + }, + '#new':: d.fn(help="\n`google.data_catalog_taxonomy_iam_member.new` injects a new `google_data_catalog_taxonomy_iam_member` 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.data_catalog_taxonomy_iam_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_catalog_taxonomy_iam_member` using the reference:\n\n $._ref.google_data_catalog_taxonomy_iam_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_catalog_taxonomy_iam_member.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 - `member` (`string`): Set the `member` field on the resulting resource block.\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`): Set the `region` field on the resulting resource block. When `null`, the `region` field will be omitted from the resulting object.\n - `role` (`string`): Set the `role` field on the resulting resource block.\n - `taxonomy` (`string`): Set the `taxonomy` field on the resulting resource block.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` 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_catalog_taxonomy_iam_member.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + member, + role, + taxonomy, + condition=null, + project=null, + region=null, + _meta={} + ):: tf.withResource( + type='google_data_catalog_taxonomy_iam_member', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + member=member, + project=project, + region=region, + role=role, + taxonomy=taxonomy + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data_catalog_taxonomy_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_taxonomy_iam_member`\nTerraform resource.\n\nUnlike [google.data_catalog_taxonomy_iam_member.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 - `member` (`string`): Set the `member` field on 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 - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object.\n - `role` (`string`): Set the `role` field on the resulting object.\n - `taxonomy` (`string`): Set the `taxonomy` field on the resulting object.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` 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_catalog_taxonomy_iam_member.condition.new](#fn-conditionnew) 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 `data_catalog_taxonomy_iam_member` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + member, + role, + taxonomy, + condition=null, + project=null, + region=null + ):: std.prune(a={ + condition: condition, + member: member, + project: project, + region: region, + role: role, + taxonomy: taxonomy, + }), + '#withCondition':: d.fn(help='`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withConditionMixin](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 `condition` field.\n', args=[]), + withCondition(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_member+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withCondition](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 `condition` field.\n', args=[]), + withConditionMixin(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_member+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withMember':: d.fn(help='`google.string.withMember` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the member 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 `member` field.\n', args=[]), + withMember(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_member+: { + [resourceLabel]+: { + member: 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_data_catalog_taxonomy_iam_member+: { + [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_data_catalog_taxonomy_iam_member+: { + [resourceLabel]+: { + region: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google.string.withRole` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role 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 `role` field.\n', args=[]), + withRole(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_member+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withTaxonomy':: d.fn(help='`google.string.withTaxonomy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the taxonomy 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 `taxonomy` field.\n', args=[]), + withTaxonomy(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_member+: { + [resourceLabel]+: { + taxonomy: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/data_catalog_taxonomy_iam_policy.libsonnet b/4.x/_gen/resources/data_catalog_taxonomy_iam_policy.libsonnet new file mode 100644 index 00000000..8c5ffa40 --- /dev/null +++ b/4.x/_gen/resources/data_catalog_taxonomy_iam_policy.libsonnet @@ -0,0 +1,76 @@ +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='data_catalog_taxonomy_iam_policy', url='', help='`data_catalog_taxonomy_iam_policy` represents the `google_data_catalog_taxonomy_iam_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.data_catalog_taxonomy_iam_policy.new` injects a new `google_data_catalog_taxonomy_iam_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.data_catalog_taxonomy_iam_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_catalog_taxonomy_iam_policy` using the reference:\n\n $._ref.google_data_catalog_taxonomy_iam_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_catalog_taxonomy_iam_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 - `policy_data` (`string`): Set the `policy_data` field on the resulting resource block.\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`): Set the `region` field on the resulting resource block. When `null`, the `region` field will be omitted from the resulting object.\n - `taxonomy` (`string`): Set the `taxonomy` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + policy_data, + taxonomy, + project=null, + region=null, + _meta={} + ):: tf.withResource( + type='google_data_catalog_taxonomy_iam_policy', + label=resourceLabel, + attrs=self.newAttrs( + policy_data=policy_data, + project=project, + region=region, + taxonomy=taxonomy + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data_catalog_taxonomy_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_taxonomy_iam_policy`\nTerraform resource.\n\nUnlike [google.data_catalog_taxonomy_iam_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 - `policy_data` (`string`): Set the `policy_data` field on 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 - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object.\n - `taxonomy` (`string`): Set the `taxonomy` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `data_catalog_taxonomy_iam_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + policy_data, + taxonomy, + project=null, + region=null + ):: std.prune(a={ + policy_data: policy_data, + project: project, + region: region, + taxonomy: taxonomy, + }), + '#withPolicyData':: d.fn(help='`google.string.withPolicyData` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy_data 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 `policy_data` field.\n', args=[]), + withPolicyData(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_policy+: { + [resourceLabel]+: { + policy_data: 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_data_catalog_taxonomy_iam_policy+: { + [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_data_catalog_taxonomy_iam_policy+: { + [resourceLabel]+: { + region: value, + }, + }, + }, + }, + '#withTaxonomy':: d.fn(help='`google.string.withTaxonomy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the taxonomy 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 `taxonomy` field.\n', args=[]), + withTaxonomy(resourceLabel, value): { + resource+: { + google_data_catalog_taxonomy_iam_policy+: { + [resourceLabel]+: { + taxonomy: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/scc_mute_config.libsonnet b/4.x/_gen/resources/scc_mute_config.libsonnet new file mode 100644 index 00000000..f4e10039 --- /dev/null +++ b/4.x/_gen/resources/scc_mute_config.libsonnet @@ -0,0 +1,112 @@ +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='scc_mute_config', url='', help='`scc_mute_config` represents the `google_scc_mute_config` 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.scc_mute_config.new` injects a new `google_scc_mute_config` 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.scc_mute_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.scc_mute_config` using the reference:\n\n $._ref.google_scc_mute_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_scc_mute_config.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`): A description of the mute config. When `null`, the `description` field will be omitted from the resulting object.\n - `filter` (`string`): An expression that defines the filter to apply across create/update\nevents of findings. While creating a filter string, be mindful of\nthe scope in which the mute configuration is being created. E.g.,\nIf a filter contains project = X but is created under the\nproject = Y scope, it might not match any findings.\n - `mute_config_id` (`string`): Unique identifier provided by the client within the parent scope.\n - `parent` (`string`): Resource name of the new mute configs\u0026#39;s parent. Its format is\n\u0026#34;organizations/[organization_id]\u0026#34;, \u0026#34;folders/[folder_id]\u0026#34;, or\n\u0026#34;projects/[project_id]\u0026#34;.\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.scc_mute_config.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, + filter, + mute_config_id, + parent, + description=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_scc_mute_config', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + filter=filter, + mute_config_id=mute_config_id, + parent=parent, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.scc_mute_config.newAttrs` constructs a new object with attributes and blocks configured for the `scc_mute_config`\nTerraform resource.\n\nUnlike [google.scc_mute_config.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`): A description of the mute config. When `null`, the `description` field will be omitted from the resulting object.\n - `filter` (`string`): An expression that defines the filter to apply across create/update\nevents of findings. While creating a filter string, be mindful of\nthe scope in which the mute configuration is being created. E.g.,\nIf a filter contains project = X but is created under the\nproject = Y scope, it might not match any findings.\n - `mute_config_id` (`string`): Unique identifier provided by the client within the parent scope.\n - `parent` (`string`): Resource name of the new mute configs's parent. Its format is\n"organizations/[organization_id]", "folders/[folder_id]", or\n"projects/[project_id]".\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.scc_mute_config.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 `scc_mute_config` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + filter, + mute_config_id, + parent, + description=null, + timeouts=null + ):: std.prune(a={ + description: description, + filter: filter, + mute_config_id: mute_config_id, + parent: parent, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.scc_mute_config.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 - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#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_scc_mute_config+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withFilter':: d.fn(help='`google.string.withFilter` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the filter 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 `filter` field.\n', args=[]), + withFilter(resourceLabel, value): { + resource+: { + google_scc_mute_config+: { + [resourceLabel]+: { + filter: value, + }, + }, + }, + }, + '#withMuteConfigId':: d.fn(help='`google.string.withMuteConfigId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the mute_config_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `mute_config_id` field.\n', args=[]), + withMuteConfigId(resourceLabel, value): { + resource+: { + google_scc_mute_config+: { + [resourceLabel]+: { + mute_config_id: value, + }, + }, + }, + }, + '#withParent':: d.fn(help='`google.string.withParent` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the parent 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` field.\n', args=[]), + withParent(resourceLabel, value): { + resource+: { + google_scc_mute_config+: { + [resourceLabel]+: { + parent: 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_scc_mute_config+: { + [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_scc_mute_config+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/storage_transfer_job.libsonnet b/4.x/_gen/resources/storage_transfer_job.libsonnet index b9c6ec8b..cae3e673 100644 --- a/4.x/_gen/resources/storage_transfer_job.libsonnet +++ b/4.x/_gen/resources/storage_transfer_job.libsonnet @@ -178,7 +178,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); list_url: list_url, }), }, - '#new':: d.fn(help='\n`google.storage_transfer_job.transfer_spec.new` constructs a new object with attributes and blocks configured for the `transfer_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `aws_s3_data_source` (`list[obj]`): An AWS S3 data source. When `null`, the `aws_s3_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.aws_s3_data_source.new](#fn-transfer_specaws_s3_data_sourcenew) constructor.\n - `azure_blob_storage_data_source` (`list[obj]`): An Azure Blob Storage data source. When `null`, the `azure_blob_storage_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.azure_blob_storage_data_source.new](#fn-transfer_specazure_blob_storage_data_sourcenew) constructor.\n - `gcs_data_sink` (`list[obj]`): A Google Cloud Storage data sink. When `null`, the `gcs_data_sink` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.gcs_data_sink.new](#fn-transfer_specgcs_data_sinknew) constructor.\n - `gcs_data_source` (`list[obj]`): A Google Cloud Storage data source. When `null`, the `gcs_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.gcs_data_source.new](#fn-transfer_specgcs_data_sourcenew) constructor.\n - `http_data_source` (`list[obj]`): A HTTP URL data source. When `null`, the `http_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.http_data_source.new](#fn-transfer_spechttp_data_sourcenew) constructor.\n - `object_conditions` (`list[obj]`): Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' last_modification_time do not exclude objects in a data sink. When `null`, the `object_conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.object_conditions.new](#fn-transfer_specobject_conditionsnew) constructor.\n - `posix_data_sink` (`list[obj]`): A POSIX filesystem data sink. When `null`, the `posix_data_sink` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.posix_data_sink.new](#fn-transfer_specposix_data_sinknew) constructor.\n - `posix_data_source` (`list[obj]`): A POSIX filesystem data source. When `null`, the `posix_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.posix_data_source.new](#fn-transfer_specposix_data_sourcenew) constructor.\n - `transfer_options` (`list[obj]`): Characteristics of how to treat files from datasource and sink during job. If the option delete_objects_unique_in_sink is true, object conditions based on objects' last_modification_time are ignored and do not exclude objects in a data source or a data sink. When `null`, the `transfer_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.storage_transfer_job.transfer_spec.transfer_options.new](#fn-transfer_spectransfer_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transfer_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.storage_transfer_job.transfer_spec.new` constructs a new object with attributes and blocks configured for the `transfer_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `sink_agent_pool_name` (`string`): Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used. When `null`, the `sink_agent_pool_name` field will be omitted from the resulting object.\n - `source_agent_pool_name` (`string`): Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used. When `null`, the `source_agent_pool_name` field will be omitted from the resulting object.\n - `aws_s3_data_source` (`list[obj]`): An AWS S3 data source. When `null`, the `aws_s3_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.aws_s3_data_source.new](#fn-transfer_specaws_s3_data_sourcenew) constructor.\n - `azure_blob_storage_data_source` (`list[obj]`): An Azure Blob Storage data source. When `null`, the `azure_blob_storage_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.azure_blob_storage_data_source.new](#fn-transfer_specazure_blob_storage_data_sourcenew) constructor.\n - `gcs_data_sink` (`list[obj]`): A Google Cloud Storage data sink. When `null`, the `gcs_data_sink` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.gcs_data_sink.new](#fn-transfer_specgcs_data_sinknew) constructor.\n - `gcs_data_source` (`list[obj]`): A Google Cloud Storage data source. When `null`, the `gcs_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.gcs_data_source.new](#fn-transfer_specgcs_data_sourcenew) constructor.\n - `http_data_source` (`list[obj]`): A HTTP URL data source. When `null`, the `http_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.http_data_source.new](#fn-transfer_spechttp_data_sourcenew) constructor.\n - `object_conditions` (`list[obj]`): Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' last_modification_time do not exclude objects in a data sink. When `null`, the `object_conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.object_conditions.new](#fn-transfer_specobject_conditionsnew) constructor.\n - `posix_data_sink` (`list[obj]`): A POSIX filesystem data sink. When `null`, the `posix_data_sink` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.posix_data_sink.new](#fn-transfer_specposix_data_sinknew) constructor.\n - `posix_data_source` (`list[obj]`): A POSIX filesystem data source. When `null`, the `posix_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.posix_data_source.new](#fn-transfer_specposix_data_sourcenew) constructor.\n - `transfer_options` (`list[obj]`): Characteristics of how to treat files from datasource and sink during job. If the option delete_objects_unique_in_sink is true, object conditions based on objects' last_modification_time are ignored and do not exclude objects in a data source or a data sink. When `null`, the `transfer_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.storage_transfer_job.transfer_spec.transfer_options.new](#fn-transfer_spectransfer_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transfer_spec` sub block.\n', args=[]), new( aws_s3_data_source=null, azure_blob_storage_data_source=null, @@ -188,6 +188,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); object_conditions=null, posix_data_sink=null, posix_data_source=null, + sink_agent_pool_name=null, + source_agent_pool_name=null, transfer_options=null ):: std.prune(a={ aws_s3_data_source: aws_s3_data_source, @@ -198,6 +200,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); object_conditions: object_conditions, posix_data_sink: posix_data_sink, posix_data_source: posix_data_source, + sink_agent_pool_name: sink_agent_pool_name, + source_agent_pool_name: source_agent_pool_name, transfer_options: transfer_options, }), object_conditions:: { diff --git a/docs/4.x/README.md b/docs/4.x/README.md index f09b2104..d95cc537 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -273,11 +273,19 @@ project. * [data_catalog_entry_group_iam_binding](data_catalog_entry_group_iam_binding.md) * [data_catalog_entry_group_iam_member](data_catalog_entry_group_iam_member.md) * [data_catalog_entry_group_iam_policy](data_catalog_entry_group_iam_policy.md) +* [data_catalog_policy_tag](data_catalog_policy_tag.md) +* [data_catalog_policy_tag_iam_binding](data_catalog_policy_tag_iam_binding.md) +* [data_catalog_policy_tag_iam_member](data_catalog_policy_tag_iam_member.md) +* [data_catalog_policy_tag_iam_policy](data_catalog_policy_tag_iam_policy.md) * [data_catalog_tag](data_catalog_tag.md) * [data_catalog_tag_template](data_catalog_tag_template.md) * [data_catalog_tag_template_iam_binding](data_catalog_tag_template_iam_binding.md) * [data_catalog_tag_template_iam_member](data_catalog_tag_template_iam_member.md) * [data_catalog_tag_template_iam_policy](data_catalog_tag_template_iam_policy.md) +* [data_catalog_taxonomy](data_catalog_taxonomy.md) +* [data_catalog_taxonomy_iam_binding](data_catalog_taxonomy_iam_binding.md) +* [data_catalog_taxonomy_iam_member](data_catalog_taxonomy_iam_member.md) +* [data_catalog_taxonomy_iam_policy](data_catalog_taxonomy_iam_policy.md) * [data_fusion_instance](data_fusion_instance.md) * [data_fusion_instance_iam_binding](data_fusion_instance_iam_binding.md) * [data_fusion_instance_iam_member](data_fusion_instance_iam_member.md) @@ -531,6 +539,7 @@ project. * [recaptcha_enterprise_key](recaptcha_enterprise_key.md) * [redis_instance](redis_instance.md) * [resource_manager_lien](resource_manager_lien.md) +* [scc_mute_config](scc_mute_config.md) * [scc_notification_config](scc_notification_config.md) * [scc_source](scc_source.md) * [scc_source_iam_binding](scc_source_iam_binding.md) diff --git a/docs/4.x/alloydb_cluster.md b/docs/4.x/alloydb_cluster.md index 7f426022..7381b214 100644 --- a/docs/4.x/alloydb_cluster.md +++ b/docs/4.x/alloydb_cluster.md @@ -353,7 +353,7 @@ Terraform sub block. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `backup_window` field will be omitted from the resulting object. - - `enabled` (`bool`): Whether automated automated backups are enabled. When `null`, the `enabled` field will be omitted from the resulting object. + - `enabled` (`bool`): Whether automated backups are enabled. When `null`, the `enabled` field will be omitted from the resulting object. - `labels` (`obj`): Labels to apply to backups created using this configuration. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. When `null`, the `location` field will be omitted from the resulting object. - `quantity_based_retention` (`list[obj]`): Quantity-based Backup retention policy to retain recent backups. When `null`, the `quantity_based_retention` 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.quantity_based_retention.new](#fn-automated_backup_policyquantity_based_retentionnew) constructor. diff --git a/docs/4.x/cloud_run_v2_service.md b/docs/4.x/cloud_run_v2_service.md index 81a49d1f..e88aabb2 100644 --- a/docs/4.x/cloud_run_v2_service.md +++ b/docs/4.x/cloud_run_v2_service.md @@ -47,6 +47,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-templatecontainersenvvalue_sourcesecret_key_refnew) * [`obj template.containers.liveness_probe`](#obj-templatecontainersliveness_probe) * [`fn new()`](#fn-templatecontainersliveness_probenew) + * [`obj template.containers.liveness_probe.grpc`](#obj-templatecontainersliveness_probegrpc) + * [`fn new()`](#fn-templatecontainersliveness_probegrpcnew) * [`obj template.containers.liveness_probe.http_get`](#obj-templatecontainersliveness_probehttp_get) * [`fn new()`](#fn-templatecontainersliveness_probehttp_getnew) * [`obj template.containers.liveness_probe.http_get.http_headers`](#obj-templatecontainersliveness_probehttp_gethttp_headers) @@ -59,6 +61,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-templatecontainersresourcesnew) * [`obj template.containers.startup_probe`](#obj-templatecontainersstartup_probe) * [`fn new()`](#fn-templatecontainersstartup_probenew) + * [`obj template.containers.startup_probe.grpc`](#obj-templatecontainersstartup_probegrpc) + * [`fn new()`](#fn-templatecontainersstartup_probegrpcnew) * [`obj template.containers.startup_probe.http_get`](#obj-templatecontainersstartup_probehttp_get) * [`fn new()`](#fn-templatecontainersstartup_probehttp_getnew) * [`obj template.containers.startup_probe.http_get.http_headers`](#obj-templatecontainersstartup_probehttp_gethttp_headers) @@ -664,6 +668,7 @@ Terraform sub block. - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `initial_delay_seconds` field will be omitted from the resulting object. - `period_seconds` (`number`): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When `null`, the `period_seconds` field will be omitted from the resulting object. - `timeout_seconds` (`number`): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `timeout_seconds` field will be omitted from the resulting object. + - `grpc` (`list[obj]`): GRPC specifies an action involving a GRPC port. When `null`, the `grpc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.liveness_probe.grpc.new](#fn-templatetemplatecontainersgrpcnew) constructor. - `http_get` (`list[obj]`): HTTPGet specifies the http request to perform. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.liveness_probe.http_get.new](#fn-templatetemplatecontainershttp_getnew) constructor. - `tcp_socket` (`list[obj]`): TCPSocket specifies an action involving a TCP port. This field is not supported in liveness probe currently. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.liveness_probe.tcp_socket.new](#fn-templatetemplatecontainerstcp_socketnew) constructor. @@ -671,6 +676,32 @@ Terraform sub block. - An attribute object that represents the `liveness_probe` sub block. +## obj template.containers.liveness_probe.grpc + + + +### fn template.containers.liveness_probe.grpc.new + +```ts +new() +``` + + +`google.cloud_run_v2_service.template.containers.liveness_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc` +Terraform sub block. + + + +**Args**: + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. + - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest +(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). +If this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `grpc` sub block. + + ## obj template.containers.liveness_probe.http_get @@ -811,6 +842,7 @@ Terraform sub block. - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `initial_delay_seconds` field will be omitted from the resulting object. - `period_seconds` (`number`): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When `null`, the `period_seconds` field will be omitted from the resulting object. - `timeout_seconds` (`number`): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `timeout_seconds` field will be omitted from the resulting object. + - `grpc` (`list[obj]`): GRPC specifies an action involving a GRPC port. When `null`, the `grpc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.startup_probe.grpc.new](#fn-templatetemplatecontainersgrpcnew) constructor. - `http_get` (`list[obj]`): HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.startup_probe.http_get.new](#fn-templatetemplatecontainershttp_getnew) constructor. - `tcp_socket` (`list[obj]`): TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.cloud_run_v2_service.template.containers.startup_probe.tcp_socket.new](#fn-templatetemplatecontainerstcp_socketnew) constructor. @@ -818,6 +850,32 @@ Terraform sub block. - An attribute object that represents the `startup_probe` sub block. +## obj template.containers.startup_probe.grpc + + + +### fn template.containers.startup_probe.grpc.new + +```ts +new() +``` + + +`google.cloud_run_v2_service.template.containers.startup_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc` +Terraform sub block. + + + +**Args**: + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. + - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest +(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). +If this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `grpc` sub block. + + ## obj template.containers.startup_probe.http_get diff --git a/docs/4.x/cloudbuild_worker_pool.md b/docs/4.x/cloudbuild_worker_pool.md index aea60a90..e993c601 100644 --- a/docs/4.x/cloudbuild_worker_pool.md +++ b/docs/4.x/cloudbuild_worker_pool.md @@ -314,6 +314,7 @@ Terraform sub block. **Args**: - `peered_network` (`string`): Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/cloud-build/docs/custom-workers/set-up-custom-worker-pool-environment#understanding_the_network_configuration_options) + - `peered_network_ip_range` (`string`): Optional. Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. When `null`, the `peered_network_ip_range` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `network_config` sub block. diff --git a/docs/4.x/compute_shared_vpc_service_project.md b/docs/4.x/compute_shared_vpc_service_project.md index b9903d37..e4146f22 100644 --- a/docs/4.x/compute_shared_vpc_service_project.md +++ b/docs/4.x/compute_shared_vpc_service_project.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withDeletionPolicy()`](#fn-withdeletionpolicy) * [`fn withHostProject()`](#fn-withhostproject) * [`fn withServiceProject()`](#fn-withserviceproject) * [`fn withTimeouts()`](#fn-withtimeouts) @@ -51,6 +52,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. + - `deletion_policy` (`string`): The deletion policy for the shared VPC service. Setting ABANDON allows the resource + to be abandoned rather than deleted. Possible values are: "ABANDON". When `null`, the `deletion_policy` field will be omitted from the resulting object. - `host_project` (`string`): The ID of a host project to associate. - `service_project` (`string`): The ID of the project that will serve as a Shared VPC service project. - `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_shared_vpc_service_project.timeouts.new](#fn-timeoutsnew) constructor. @@ -77,6 +80,8 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `deletion_policy` (`string`): The deletion policy for the shared VPC service. Setting ABANDON allows the resource + to be abandoned rather than deleted. Possible values are: "ABANDON". When `null`, the `deletion_policy` field will be omitted from the resulting object. - `host_project` (`string`): The ID of a host project to associate. - `service_project` (`string`): The ID of the project that will serve as a Shared VPC service project. - `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_shared_vpc_service_project.timeouts.new](#fn-timeoutsnew) constructor. @@ -85,6 +90,22 @@ injecting into a complete block. - 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_shared_vpc_service_project` resource into the root Terraform configuration. +### fn withDeletionPolicy + +```ts +withDeletionPolicy() +``` + +`google.string.withDeletionPolicy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the deletion_policy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `deletion_policy` field. + + ### fn withHostProject ```ts diff --git a/docs/4.x/container_azure_cluster.md b/docs/4.x/container_azure_cluster.md index ea763029..aca8914a 100644 --- a/docs/4.x/container_azure_cluster.md +++ b/docs/4.x/container_azure_cluster.md @@ -19,6 +19,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withAuthorization()`](#fn-withauthorization) * [`fn withAuthorizationMixin()`](#fn-withauthorizationmixin) * [`fn withAzureRegion()`](#fn-withazureregion) +* [`fn withAzureServicesAuthentication()`](#fn-withazureservicesauthentication) +* [`fn withAzureServicesAuthenticationMixin()`](#fn-withazureservicesauthenticationmixin) * [`fn withClient()`](#fn-withclient) * [`fn withControlPlane()`](#fn-withcontrolplane) * [`fn withControlPlaneMixin()`](#fn-withcontrolplanemixin) @@ -37,6 +39,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-authorizationnew) * [`obj authorization.admin_users`](#obj-authorizationadmin_users) * [`fn new()`](#fn-authorizationadmin_usersnew) +* [`obj azure_services_authentication`](#obj-azure_services_authentication) + * [`fn new()`](#fn-azure_services_authenticationnew) * [`obj control_plane`](#obj-control_plane) * [`fn new()`](#fn-control_planenew) * [`obj control_plane.database_encryption`](#obj-control_planedatabase_encryption) @@ -89,13 +93,14 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `annotations` (`obj`): Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object. - `azure_region` (`string`): The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call to list all supported Azure regions within a given Google Cloud region. - - `client` (`string`): Name of the AzureClient. The `AzureClient` resource must reside on the same GCP project and region as the `AzureCluster`. `AzureClient` names are formatted as `projects/<project-number>/locations/<region>/azureClients/<client-id>`. See Resource Names (https:cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names. + - `client` (`string`): Name of the AzureClient. The `AzureClient` resource must reside on the same GCP project and region as the `AzureCluster`. `AzureClient` names are formatted as `projects/<project-number>/locations/<region>/azureClients/<client-id>`. See Resource Names (https:cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names. When `null`, the `client` field will be omitted from the resulting object. - `description` (`string`): Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes. When `null`, the `description` field will be omitted from the resulting object. - `location` (`string`): The location for the resource - `name` (`string`): The name of this resource. - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object. - `resource_group_id` (`string`): The ARM ID of the resource group where the cluster resources are deployed. For example: `/subscriptions/*/resourceGroups/*` - `authorization` (`list[obj]`): Configuration related to the cluster RBAC settings. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.authorization.new](#fn-authorizationnew) constructor. + - `azure_services_authentication` (`list[obj]`): Azure authentication configuration for management of Azure resources When `null`, the `azure_services_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.azure_services_authentication.new](#fn-azure_services_authenticationnew) constructor. - `control_plane` (`list[obj]`): Configuration related to the cluster control plane. When `null`, the `control_plane` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.control_plane.new](#fn-control_planenew) constructor. - `fleet` (`list[obj]`): Fleet configuration. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.fleet.new](#fn-fleetnew) constructor. - `networking` (`list[obj]`): Cluster-wide networking configuration. When `null`, the `networking` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.networking.new](#fn-networkingnew) constructor. @@ -125,13 +130,14 @@ injecting into a complete block. **Args**: - `annotations` (`obj`): Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object. - `azure_region` (`string`): The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call to list all supported Azure regions within a given Google Cloud region. - - `client` (`string`): Name of the AzureClient. The `AzureClient` resource must reside on the same GCP project and region as the `AzureCluster`. `AzureClient` names are formatted as `projects/<project-number>/locations/<region>/azureClients/<client-id>`. See Resource Names (https:cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names. + - `client` (`string`): Name of the AzureClient. The `AzureClient` resource must reside on the same GCP project and region as the `AzureCluster`. `AzureClient` names are formatted as `projects/<project-number>/locations/<region>/azureClients/<client-id>`. See Resource Names (https:cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names. When `null`, the `client` field will be omitted from the resulting object. - `description` (`string`): Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes. When `null`, the `description` field will be omitted from the resulting object. - `location` (`string`): The location for the resource - `name` (`string`): The name of this resource. - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object. - `resource_group_id` (`string`): The ARM ID of the resource group where the cluster resources are deployed. For example: `/subscriptions/*/resourceGroups/*` - `authorization` (`list[obj]`): Configuration related to the cluster RBAC settings. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.authorization.new](#fn-authorizationnew) constructor. + - `azure_services_authentication` (`list[obj]`): Azure authentication configuration for management of Azure resources When `null`, the `azure_services_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.azure_services_authentication.new](#fn-azure_services_authenticationnew) constructor. - `control_plane` (`list[obj]`): Configuration related to the cluster control plane. When `null`, the `control_plane` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.control_plane.new](#fn-control_planenew) constructor. - `fleet` (`list[obj]`): Fleet configuration. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.fleet.new](#fn-fleetnew) constructor. - `networking` (`list[obj]`): Cluster-wide networking configuration. When `null`, the `networking` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_cluster.networking.new](#fn-networkingnew) constructor. @@ -210,6 +216,43 @@ Terraform resource block to set or update the azure_region field. - `value` (`string`): The value to set for the `azure_region` field. +### fn withAzureServicesAuthentication + +```ts +withAzureServicesAuthentication() +``` + +`google.list[obj].withAzureServicesAuthentication` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the azure_services_authentication 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].withAzureServicesAuthenticationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `azure_services_authentication` field. + + +### fn withAzureServicesAuthenticationMixin + +```ts +withAzureServicesAuthenticationMixin() +``` + +`google.list[obj].withAzureServicesAuthenticationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the azure_services_authentication 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].withAzureServicesAuthentication](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `azure_services_authentication` field. + + ### fn withClient ```ts @@ -499,6 +542,30 @@ Terraform sub block. - An attribute object that represents the `admin_users` sub block. +## obj azure_services_authentication + + + +### fn azure_services_authentication.new + +```ts +new() +``` + + +`google.container_azure_cluster.azure_services_authentication.new` constructs a new object with attributes and blocks configured for the `azure_services_authentication` +Terraform sub block. + + + +**Args**: + - `application_id` (`string`): The Azure Active Directory Application ID for Authentication configuration. + - `tenant_id` (`string`): The Azure Active Directory Tenant ID for Authentication configuration. + +**Returns**: + - An attribute object that represents the `azure_services_authentication` sub block. + + ## obj control_plane diff --git a/docs/4.x/data_catalog_policy_tag.md b/docs/4.x/data_catalog_policy_tag.md new file mode 100644 index 00000000..8f9bab6a --- /dev/null +++ b/docs/4.x/data_catalog_policy_tag.md @@ -0,0 +1,230 @@ +--- +permalink: /data_catalog_policy_tag/ +--- + +# data_catalog_policy_tag + +`data_catalog_policy_tag` represents the `google_data_catalog_policy_tag` 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 withDisplayName()`](#fn-withdisplayname) +* [`fn withParentPolicyTag()`](#fn-withparentpolicytag) +* [`fn withTaxonomy()`](#fn-withtaxonomy) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data_catalog_policy_tag.new` injects a new `google_data_catalog_policy_tag` 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.data_catalog_policy_tag.new('some_id') + +You can get the reference to the `id` field of the created `google.data_catalog_policy_tag` using the reference: + + $._ref.google_data_catalog_policy_tag.some_id.get('id') + +This is the same as directly entering `"${ google_data_catalog_policy_tag.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`): Description of this policy tag. It must: contain only unicode characters, tabs, +newlines, carriage returns and page breaks; and be at most 2000 bytes long when +encoded in UTF-8. If not set, defaults to an empty description. +If not set, defaults to an empty description. When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): User defined name of this policy tag. It must: be unique within the parent +taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; +not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. + - `parent_policy_tag` (`string`): Resource name of this policy tag's parent policy tag. +If empty, it means this policy tag is a top level policy tag. +If not set, defaults to an empty string. When `null`, the `parent_policy_tag` field will be omitted from the resulting object. + - `taxonomy` (`string`): Taxonomy the policy tag is associated with + - `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.data_catalog_policy_tag.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data_catalog_policy_tag.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_policy_tag` +Terraform resource. + +Unlike [google.data_catalog_policy_tag.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`): Description of this policy tag. It must: contain only unicode characters, tabs, +newlines, carriage returns and page breaks; and be at most 2000 bytes long when +encoded in UTF-8. If not set, defaults to an empty description. +If not set, defaults to an empty description. When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): User defined name of this policy tag. It must: be unique within the parent +taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; +not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. + - `parent_policy_tag` (`string`): Resource name of this policy tag's parent policy tag. +If empty, it means this policy tag is a top level policy tag. +If not set, defaults to an empty string. When `null`, the `parent_policy_tag` field will be omitted from the resulting object. + - `taxonomy` (`string`): Taxonomy the policy tag is associated with + - `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.data_catalog_policy_tag.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 `data_catalog_policy_tag` 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 withDisplayName + +```ts +withDisplayName() +``` + +`google.string.withDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `display_name` field. + + +### fn withParentPolicyTag + +```ts +withParentPolicyTag() +``` + +`google.string.withParentPolicyTag` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the parent_policy_tag field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `parent_policy_tag` field. + + +### fn withTaxonomy + +```ts +withTaxonomy() +``` + +`google.string.withTaxonomy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the taxonomy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `taxonomy` 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.data_catalog_policy_tag.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. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/data_catalog_policy_tag_iam_binding.md b/docs/4.x/data_catalog_policy_tag_iam_binding.md new file mode 100644 index 00000000..81898cd7 --- /dev/null +++ b/docs/4.x/data_catalog_policy_tag_iam_binding.md @@ -0,0 +1,198 @@ +--- +permalink: /data_catalog_policy_tag_iam_binding/ +--- + +# data_catalog_policy_tag_iam_binding + +`data_catalog_policy_tag_iam_binding` represents the `google_data_catalog_policy_tag_iam_binding` 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 withCondition()`](#fn-withcondition) +* [`fn withConditionMixin()`](#fn-withconditionmixin) +* [`fn withMembers()`](#fn-withmembers) +* [`fn withPolicyTag()`](#fn-withpolicytag) +* [`fn withRole()`](#fn-withrole) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data_catalog_policy_tag_iam_binding.new` injects a new `google_data_catalog_policy_tag_iam_binding` 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.data_catalog_policy_tag_iam_binding.new('some_id') + +You can get the reference to the `id` field of the created `google.data_catalog_policy_tag_iam_binding` using the reference: + + $._ref.google_data_catalog_policy_tag_iam_binding.some_id.get('id') + +This is the same as directly entering `"${ google_data_catalog_policy_tag_iam_binding.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. + - `members` (`list`): Set the `members` field on the resulting resource block. + - `policy_tag` (`string`): Set the `policy_tag` field on the resulting resource block. + - `role` (`string`): Set the `role` field on the resulting resource block. + - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` 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_catalog_policy_tag_iam_binding.condition.new](#fn-conditionnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data_catalog_policy_tag_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_policy_tag_iam_binding` +Terraform resource. + +Unlike [google.data_catalog_policy_tag_iam_binding.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**: + - `members` (`list`): Set the `members` field on the resulting object. + - `policy_tag` (`string`): Set the `policy_tag` field on the resulting object. + - `role` (`string`): Set the `role` field on the resulting object. + - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` 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_catalog_policy_tag_iam_binding.condition.new](#fn-conditionnew) 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 `data_catalog_policy_tag_iam_binding` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withConditionMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withConditionMixin + +```ts +withConditionMixin() +``` + +`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withCondition](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withMembers + +```ts +withMembers() +``` + +`google.list.withMembers` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the members field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `members` field. + + +### fn withPolicyTag + +```ts +withPolicyTag() +``` + +`google.string.withPolicyTag` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy_tag field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy_tag` field. + + +### fn withRole + +```ts +withRole() +``` + +`google.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google.data_catalog_policy_tag_iam_binding.condition.new` constructs a new object with attributes and blocks configured for the `condition` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `expression` (`string`): Set the `expression` field on the resulting object. + - `title` (`string`): Set the `title` field on the resulting object. + +**Returns**: + - An attribute object that represents the `condition` sub block. diff --git a/docs/4.x/data_catalog_policy_tag_iam_member.md b/docs/4.x/data_catalog_policy_tag_iam_member.md new file mode 100644 index 00000000..8aa18cfd --- /dev/null +++ b/docs/4.x/data_catalog_policy_tag_iam_member.md @@ -0,0 +1,198 @@ +--- +permalink: /data_catalog_policy_tag_iam_member/ +--- + +# data_catalog_policy_tag_iam_member + +`data_catalog_policy_tag_iam_member` represents the `google_data_catalog_policy_tag_iam_member` 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 withCondition()`](#fn-withcondition) +* [`fn withConditionMixin()`](#fn-withconditionmixin) +* [`fn withMember()`](#fn-withmember) +* [`fn withPolicyTag()`](#fn-withpolicytag) +* [`fn withRole()`](#fn-withrole) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data_catalog_policy_tag_iam_member.new` injects a new `google_data_catalog_policy_tag_iam_member` 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.data_catalog_policy_tag_iam_member.new('some_id') + +You can get the reference to the `id` field of the created `google.data_catalog_policy_tag_iam_member` using the reference: + + $._ref.google_data_catalog_policy_tag_iam_member.some_id.get('id') + +This is the same as directly entering `"${ google_data_catalog_policy_tag_iam_member.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. + - `member` (`string`): Set the `member` field on the resulting resource block. + - `policy_tag` (`string`): Set the `policy_tag` field on the resulting resource block. + - `role` (`string`): Set the `role` field on the resulting resource block. + - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` 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_catalog_policy_tag_iam_member.condition.new](#fn-conditionnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data_catalog_policy_tag_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_policy_tag_iam_member` +Terraform resource. + +Unlike [google.data_catalog_policy_tag_iam_member.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**: + - `member` (`string`): Set the `member` field on the resulting object. + - `policy_tag` (`string`): Set the `policy_tag` field on the resulting object. + - `role` (`string`): Set the `role` field on the resulting object. + - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` 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_catalog_policy_tag_iam_member.condition.new](#fn-conditionnew) 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 `data_catalog_policy_tag_iam_member` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withConditionMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withConditionMixin + +```ts +withConditionMixin() +``` + +`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withCondition](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withMember + +```ts +withMember() +``` + +`google.string.withMember` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the member field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `member` field. + + +### fn withPolicyTag + +```ts +withPolicyTag() +``` + +`google.string.withPolicyTag` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy_tag field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy_tag` field. + + +### fn withRole + +```ts +withRole() +``` + +`google.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google.data_catalog_policy_tag_iam_member.condition.new` constructs a new object with attributes and blocks configured for the `condition` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `expression` (`string`): Set the `expression` field on the resulting object. + - `title` (`string`): Set the `title` field on the resulting object. + +**Returns**: + - An attribute object that represents the `condition` sub block. diff --git a/docs/4.x/data_catalog_policy_tag_iam_policy.md b/docs/4.x/data_catalog_policy_tag_iam_policy.md new file mode 100644 index 00000000..a17b358b --- /dev/null +++ b/docs/4.x/data_catalog_policy_tag_iam_policy.md @@ -0,0 +1,111 @@ +--- +permalink: /data_catalog_policy_tag_iam_policy/ +--- + +# data_catalog_policy_tag_iam_policy + +`data_catalog_policy_tag_iam_policy` represents the `google_data_catalog_policy_tag_iam_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 withPolicyData()`](#fn-withpolicydata) +* [`fn withPolicyTag()`](#fn-withpolicytag) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data_catalog_policy_tag_iam_policy.new` injects a new `google_data_catalog_policy_tag_iam_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.data_catalog_policy_tag_iam_policy.new('some_id') + +You can get the reference to the `id` field of the created `google.data_catalog_policy_tag_iam_policy` using the reference: + + $._ref.google_data_catalog_policy_tag_iam_policy.some_id.get('id') + +This is the same as directly entering `"${ google_data_catalog_policy_tag_iam_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. + - `policy_data` (`string`): Set the `policy_data` field on the resulting resource block. + - `policy_tag` (`string`): Set the `policy_tag` field on the resulting resource block. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data_catalog_policy_tag_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_policy_tag_iam_policy` +Terraform resource. + +Unlike [google.data_catalog_policy_tag_iam_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**: + - `policy_data` (`string`): Set the `policy_data` field on the resulting object. + - `policy_tag` (`string`): Set the `policy_tag` field on the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `data_catalog_policy_tag_iam_policy` resource into the root Terraform configuration. + + +### fn withPolicyData + +```ts +withPolicyData() +``` + +`google.string.withPolicyData` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy_data field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy_data` field. + + +### fn withPolicyTag + +```ts +withPolicyTag() +``` + +`google.string.withPolicyTag` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy_tag field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy_tag` field. diff --git a/docs/4.x/data_catalog_taxonomy.md b/docs/4.x/data_catalog_taxonomy.md new file mode 100644 index 00000000..1321e564 --- /dev/null +++ b/docs/4.x/data_catalog_taxonomy.md @@ -0,0 +1,247 @@ +--- +permalink: /data_catalog_taxonomy/ +--- + +# data_catalog_taxonomy + +`data_catalog_taxonomy` represents the `google_data_catalog_taxonomy` 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 withActivatedPolicyTypes()`](#fn-withactivatedpolicytypes) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`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.data_catalog_taxonomy.new` injects a new `google_data_catalog_taxonomy` 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.data_catalog_taxonomy.new('some_id') + +You can get the reference to the `id` field of the created `google.data_catalog_taxonomy` using the reference: + + $._ref.google_data_catalog_taxonomy.some_id.get('id') + +This is the same as directly entering `"${ google_data_catalog_taxonomy.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. + - `activated_policy_types` (`list`): A list of policy types that are activated for this taxonomy. If not set, +defaults to an empty list. Possible values: ["POLICY_TYPE_UNSPECIFIED", "FINE_GRAINED_ACCESS_CONTROL"] When `null`, the `activated_policy_types` field will be omitted from the resulting object. + - `description` (`string`): Description of this taxonomy. It must: contain only unicode characters, +tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes +long when encoded in UTF-8. If not set, defaults to an empty description. When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): User defined name of this taxonomy. +It must: contain only unicode letters, numbers, underscores, dashes +and spaces; not start or end with spaces; and be at most 200 bytes +long when encoded in UTF-8. + - `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`): Taxonomy location region. When `null`, the `region` 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.data_catalog_taxonomy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data_catalog_taxonomy.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_taxonomy` +Terraform resource. + +Unlike [google.data_catalog_taxonomy.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**: + - `activated_policy_types` (`list`): A list of policy types that are activated for this taxonomy. If not set, +defaults to an empty list. Possible values: ["POLICY_TYPE_UNSPECIFIED", "FINE_GRAINED_ACCESS_CONTROL"] When `null`, the `activated_policy_types` field will be omitted from the resulting object. + - `description` (`string`): Description of this taxonomy. It must: contain only unicode characters, +tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes +long when encoded in UTF-8. If not set, defaults to an empty description. When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): User defined name of this taxonomy. +It must: contain only unicode letters, numbers, underscores, dashes +and spaces; not start or end with spaces; and be at most 200 bytes +long when encoded in UTF-8. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): Taxonomy location region. When `null`, the `region` 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.data_catalog_taxonomy.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 `data_catalog_taxonomy` resource into the root Terraform configuration. + + +### fn withActivatedPolicyTypes + +```ts +withActivatedPolicyTypes() +``` + +`google.list.withActivatedPolicyTypes` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the activated_policy_types field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `activated_policy_types` 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 withDisplayName + +```ts +withDisplayName() +``` + +`google.string.withDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `display_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 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.data_catalog_taxonomy.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. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/data_catalog_taxonomy_iam_binding.md b/docs/4.x/data_catalog_taxonomy_iam_binding.md new file mode 100644 index 00000000..7fd5f7bb --- /dev/null +++ b/docs/4.x/data_catalog_taxonomy_iam_binding.md @@ -0,0 +1,236 @@ +--- +permalink: /data_catalog_taxonomy_iam_binding/ +--- + +# data_catalog_taxonomy_iam_binding + +`data_catalog_taxonomy_iam_binding` represents the `google_data_catalog_taxonomy_iam_binding` 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 withCondition()`](#fn-withcondition) +* [`fn withConditionMixin()`](#fn-withconditionmixin) +* [`fn withMembers()`](#fn-withmembers) +* [`fn withProject()`](#fn-withproject) +* [`fn withRegion()`](#fn-withregion) +* [`fn withRole()`](#fn-withrole) +* [`fn withTaxonomy()`](#fn-withtaxonomy) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data_catalog_taxonomy_iam_binding.new` injects a new `google_data_catalog_taxonomy_iam_binding` 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.data_catalog_taxonomy_iam_binding.new('some_id') + +You can get the reference to the `id` field of the created `google.data_catalog_taxonomy_iam_binding` using the reference: + + $._ref.google_data_catalog_taxonomy_iam_binding.some_id.get('id') + +This is the same as directly entering `"${ google_data_catalog_taxonomy_iam_binding.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. + - `members` (`list`): Set the `members` field on the resulting resource block. + - `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`): Set the `region` field on the resulting resource block. When `null`, the `region` field will be omitted from the resulting object. + - `role` (`string`): Set the `role` field on the resulting resource block. + - `taxonomy` (`string`): Set the `taxonomy` field on the resulting resource block. + - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` 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_catalog_taxonomy_iam_binding.condition.new](#fn-conditionnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data_catalog_taxonomy_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_taxonomy_iam_binding` +Terraform resource. + +Unlike [google.data_catalog_taxonomy_iam_binding.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**: + - `members` (`list`): Set the `members` field on the resulting object. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object. + - `role` (`string`): Set the `role` field on the resulting object. + - `taxonomy` (`string`): Set the `taxonomy` field on the resulting object. + - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` 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_catalog_taxonomy_iam_binding.condition.new](#fn-conditionnew) 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 `data_catalog_taxonomy_iam_binding` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withConditionMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withConditionMixin + +```ts +withConditionMixin() +``` + +`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withCondition](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withMembers + +```ts +withMembers() +``` + +`google.list.withMembers` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the members field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `members` 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 withRole + +```ts +withRole() +``` + +`google.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +### fn withTaxonomy + +```ts +withTaxonomy() +``` + +`google.string.withTaxonomy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the taxonomy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `taxonomy` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google.data_catalog_taxonomy_iam_binding.condition.new` constructs a new object with attributes and blocks configured for the `condition` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `expression` (`string`): Set the `expression` field on the resulting object. + - `title` (`string`): Set the `title` field on the resulting object. + +**Returns**: + - An attribute object that represents the `condition` sub block. diff --git a/docs/4.x/data_catalog_taxonomy_iam_member.md b/docs/4.x/data_catalog_taxonomy_iam_member.md new file mode 100644 index 00000000..a6dd8fff --- /dev/null +++ b/docs/4.x/data_catalog_taxonomy_iam_member.md @@ -0,0 +1,236 @@ +--- +permalink: /data_catalog_taxonomy_iam_member/ +--- + +# data_catalog_taxonomy_iam_member + +`data_catalog_taxonomy_iam_member` represents the `google_data_catalog_taxonomy_iam_member` 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 withCondition()`](#fn-withcondition) +* [`fn withConditionMixin()`](#fn-withconditionmixin) +* [`fn withMember()`](#fn-withmember) +* [`fn withProject()`](#fn-withproject) +* [`fn withRegion()`](#fn-withregion) +* [`fn withRole()`](#fn-withrole) +* [`fn withTaxonomy()`](#fn-withtaxonomy) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data_catalog_taxonomy_iam_member.new` injects a new `google_data_catalog_taxonomy_iam_member` 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.data_catalog_taxonomy_iam_member.new('some_id') + +You can get the reference to the `id` field of the created `google.data_catalog_taxonomy_iam_member` using the reference: + + $._ref.google_data_catalog_taxonomy_iam_member.some_id.get('id') + +This is the same as directly entering `"${ google_data_catalog_taxonomy_iam_member.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. + - `member` (`string`): Set the `member` field on the resulting resource block. + - `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`): Set the `region` field on the resulting resource block. When `null`, the `region` field will be omitted from the resulting object. + - `role` (`string`): Set the `role` field on the resulting resource block. + - `taxonomy` (`string`): Set the `taxonomy` field on the resulting resource block. + - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` 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_catalog_taxonomy_iam_member.condition.new](#fn-conditionnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data_catalog_taxonomy_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_taxonomy_iam_member` +Terraform resource. + +Unlike [google.data_catalog_taxonomy_iam_member.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**: + - `member` (`string`): Set the `member` field on the resulting object. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object. + - `role` (`string`): Set the `role` field on the resulting object. + - `taxonomy` (`string`): Set the `taxonomy` field on the resulting object. + - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` 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_catalog_taxonomy_iam_member.condition.new](#fn-conditionnew) 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 `data_catalog_taxonomy_iam_member` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withConditionMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withConditionMixin + +```ts +withConditionMixin() +``` + +`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withCondition](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withMember + +```ts +withMember() +``` + +`google.string.withMember` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the member field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `member` 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 withRole + +```ts +withRole() +``` + +`google.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +### fn withTaxonomy + +```ts +withTaxonomy() +``` + +`google.string.withTaxonomy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the taxonomy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `taxonomy` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google.data_catalog_taxonomy_iam_member.condition.new` constructs a new object with attributes and blocks configured for the `condition` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `expression` (`string`): Set the `expression` field on the resulting object. + - `title` (`string`): Set the `title` field on the resulting object. + +**Returns**: + - An attribute object that represents the `condition` sub block. diff --git a/docs/4.x/data_catalog_taxonomy_iam_policy.md b/docs/4.x/data_catalog_taxonomy_iam_policy.md new file mode 100644 index 00000000..e22a2d5e --- /dev/null +++ b/docs/4.x/data_catalog_taxonomy_iam_policy.md @@ -0,0 +1,149 @@ +--- +permalink: /data_catalog_taxonomy_iam_policy/ +--- + +# data_catalog_taxonomy_iam_policy + +`data_catalog_taxonomy_iam_policy` represents the `google_data_catalog_taxonomy_iam_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 withPolicyData()`](#fn-withpolicydata) +* [`fn withProject()`](#fn-withproject) +* [`fn withRegion()`](#fn-withregion) +* [`fn withTaxonomy()`](#fn-withtaxonomy) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data_catalog_taxonomy_iam_policy.new` injects a new `google_data_catalog_taxonomy_iam_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.data_catalog_taxonomy_iam_policy.new('some_id') + +You can get the reference to the `id` field of the created `google.data_catalog_taxonomy_iam_policy` using the reference: + + $._ref.google_data_catalog_taxonomy_iam_policy.some_id.get('id') + +This is the same as directly entering `"${ google_data_catalog_taxonomy_iam_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. + - `policy_data` (`string`): Set the `policy_data` field on the resulting resource block. + - `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`): Set the `region` field on the resulting resource block. When `null`, the `region` field will be omitted from the resulting object. + - `taxonomy` (`string`): Set the `taxonomy` field on the resulting resource block. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data_catalog_taxonomy_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `data_catalog_taxonomy_iam_policy` +Terraform resource. + +Unlike [google.data_catalog_taxonomy_iam_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**: + - `policy_data` (`string`): Set the `policy_data` field on the resulting object. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object. + - `taxonomy` (`string`): Set the `taxonomy` field on the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `data_catalog_taxonomy_iam_policy` resource into the root Terraform configuration. + + +### fn withPolicyData + +```ts +withPolicyData() +``` + +`google.string.withPolicyData` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy_data field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy_data` 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 withTaxonomy + +```ts +withTaxonomy() +``` + +`google.string.withTaxonomy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the taxonomy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `taxonomy` field. diff --git a/docs/4.x/scc_mute_config.md b/docs/4.x/scc_mute_config.md new file mode 100644 index 00000000..987fca6c --- /dev/null +++ b/docs/4.x/scc_mute_config.md @@ -0,0 +1,228 @@ +--- +permalink: /scc_mute_config/ +--- + +# scc_mute_config + +`scc_mute_config` represents the `google_scc_mute_config` 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 withFilter()`](#fn-withfilter) +* [`fn withMuteConfigId()`](#fn-withmuteconfigid) +* [`fn withParent()`](#fn-withparent) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.scc_mute_config.new` injects a new `google_scc_mute_config` 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.scc_mute_config.new('some_id') + +You can get the reference to the `id` field of the created `google.scc_mute_config` using the reference: + + $._ref.google_scc_mute_config.some_id.get('id') + +This is the same as directly entering `"${ google_scc_mute_config.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`): A description of the mute config. When `null`, the `description` field will be omitted from the resulting object. + - `filter` (`string`): An expression that defines the filter to apply across create/update +events of findings. While creating a filter string, be mindful of +the scope in which the mute configuration is being created. E.g., +If a filter contains project = X but is created under the +project = Y scope, it might not match any findings. + - `mute_config_id` (`string`): Unique identifier provided by the client within the parent scope. + - `parent` (`string`): Resource name of the new mute configs's parent. Its format is +"organizations/[organization_id]", "folders/[folder_id]", or +"projects/[project_id]". + - `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.scc_mute_config.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.scc_mute_config.newAttrs` constructs a new object with attributes and blocks configured for the `scc_mute_config` +Terraform resource. + +Unlike [google.scc_mute_config.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`): A description of the mute config. When `null`, the `description` field will be omitted from the resulting object. + - `filter` (`string`): An expression that defines the filter to apply across create/update +events of findings. While creating a filter string, be mindful of +the scope in which the mute configuration is being created. E.g., +If a filter contains project = X but is created under the +project = Y scope, it might not match any findings. + - `mute_config_id` (`string`): Unique identifier provided by the client within the parent scope. + - `parent` (`string`): Resource name of the new mute configs's parent. Its format is +"organizations/[organization_id]", "folders/[folder_id]", or +"projects/[project_id]". + - `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.scc_mute_config.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 `scc_mute_config` 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 withFilter + +```ts +withFilter() +``` + +`google.string.withFilter` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the filter field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `filter` field. + + +### fn withMuteConfigId + +```ts +withMuteConfigId() +``` + +`google.string.withMuteConfigId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the mute_config_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `mute_config_id` field. + + +### fn withParent + +```ts +withParent() +``` + +`google.string.withParent` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the parent field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `parent` 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.scc_mute_config.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. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/storage_transfer_job.md b/docs/4.x/storage_transfer_job.md index ae685d19..dda8b76a 100644 --- a/docs/4.x/storage_transfer_job.md +++ b/docs/4.x/storage_transfer_job.md @@ -431,6 +431,8 @@ Terraform sub block. **Args**: + - `sink_agent_pool_name` (`string`): Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used. When `null`, the `sink_agent_pool_name` field will be omitted from the resulting object. + - `source_agent_pool_name` (`string`): Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used. When `null`, the `source_agent_pool_name` field will be omitted from the resulting object. - `aws_s3_data_source` (`list[obj]`): An AWS S3 data source. When `null`, the `aws_s3_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.aws_s3_data_source.new](#fn-transfer_specaws_s3_data_sourcenew) constructor. - `azure_blob_storage_data_source` (`list[obj]`): An Azure Blob Storage data source. When `null`, the `azure_blob_storage_data_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.azure_blob_storage_data_source.new](#fn-transfer_specazure_blob_storage_data_sourcenew) constructor. - `gcs_data_sink` (`list[obj]`): A Google Cloud Storage data sink. When `null`, the `gcs_data_sink` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.storage_transfer_job.transfer_spec.gcs_data_sink.new](#fn-transfer_specgcs_data_sinknew) constructor.