From 2d926ed5843a4ade7170c23b649767ee4fac9f82 Mon Sep 17 00:00:00 2001 From: yorinasub17 Date: Fri, 10 Nov 2023 18:21:51 +0000 Subject: [PATCH] Generate libsonnet source from libgenerator PR https://github.com/tf-libsonnet/libgenerator/pull/226 Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> --- ...tificate_manager_certificate_map.libsonnet | 45 ++ ...e_backup_restore_plan_iam_policy.libsonnet | 58 ++ 4.x/_gen/data/main.libsonnet | 2 + 4.x/_gen/main.libsonnet | 8 + 4.x/_gen/provider_google.libsonnet | 8 +- 4.x/_gen/resources/alloydb_cluster.libsonnet | 42 +- .../resources/bigtable_instance.libsonnet | 4 +- 4.x/_gen/resources/cloud_run_v2_job.libsonnet | 18 +- .../resources/cloud_run_v2_service.libsonnet | 18 +- .../resources/compute_autoscaler.libsonnet | 2 +- .../compute_region_autoscaler.libsonnet | 2 +- .../compute_target_https_proxy.libsonnet | 18 +- .../container_aws_node_pool.libsonnet | 36 +- .../container_azure_node_pool.libsonnet | 36 +- .../resources/container_cluster.libsonnet | 74 +- .../resources/container_node_pool.libsonnet | 18 +- .../dialogflow_cx_security_settings.libsonnet | 266 +++++++ .../resources/edgenetwork_network.libsonnet | 152 ++++ .../resources/edgenetwork_subnet.libsonnet | 194 +++++ .../resources/filestore_instance.libsonnet | 4 +- .../resources/firestore_database.libsonnet | 18 +- .../gke_backup_restore_plan.libsonnet | 320 ++++++++ ..._backup_restore_plan_iam_binding.libsonnet | 126 ++++ ...e_backup_restore_plan_iam_member.libsonnet | 126 ++++ ...e_backup_restore_plan_iam_policy.libsonnet | 76 ++ .../identity_platform_config.libsonnet | 70 +- .../network_connectivity_spoke.libsonnet | 38 +- .../scc_project_custom_module.libsonnet | 194 +++++ .../secret_manager_secret_version.libsonnet | 18 +- docs/4.x/README.md | 8 + docs/4.x/alloydb_cluster.md | 73 +- docs/4.x/bigtable_instance.md | 1 + docs/4.x/cloud_run_v2_job.md | 32 + docs/4.x/cloud_run_v2_service.md | 32 + docs/4.x/compute_autoscaler.md | 2 +- docs/4.x/compute_region_autoscaler.md | 2 +- docs/4.x/compute_target_https_proxy.md | 35 + docs/4.x/container_aws_node_pool.md | 66 ++ docs/4.x/container_azure_node_pool.md | 66 ++ docs/4.x/container_cluster.md | 144 ++++ docs/4.x/container_node_pool.md | 27 + .../certificate_manager_certificate_map.md | 113 +++ .../gke_backup_restore_plan_iam_policy.md | 130 ++++ docs/4.x/data/index.md | 2 + docs/4.x/dialogflow_cx_security_settings.md | 494 ++++++++++++ docs/4.x/edgenetwork_network.md | 272 +++++++ docs/4.x/edgenetwork_subnet.md | 331 ++++++++ docs/4.x/filestore_instance.md | 4 +- docs/4.x/firestore_database.md | 23 +- docs/4.x/gke_backup_restore_plan.md | 707 ++++++++++++++++++ .../gke_backup_restore_plan_iam_binding.md | 236 ++++++ .../4.x/gke_backup_restore_plan_iam_member.md | 236 ++++++ .../4.x/gke_backup_restore_plan_iam_policy.md | 149 ++++ docs/4.x/identity_platform_config.md | 148 ++++ docs/4.x/network_connectivity_spoke.md | 67 ++ docs/4.x/provider.md | 2 + docs/4.x/scc_project_custom_module.md | 421 +++++++++++ docs/4.x/secret_manager_secret_version.md | 19 + 58 files changed, 5787 insertions(+), 46 deletions(-) create mode 100644 4.x/_gen/data/certificate_manager_certificate_map.libsonnet create mode 100644 4.x/_gen/data/gke_backup_restore_plan_iam_policy.libsonnet create mode 100644 4.x/_gen/resources/dialogflow_cx_security_settings.libsonnet create mode 100644 4.x/_gen/resources/edgenetwork_network.libsonnet create mode 100644 4.x/_gen/resources/edgenetwork_subnet.libsonnet create mode 100644 4.x/_gen/resources/gke_backup_restore_plan.libsonnet create mode 100644 4.x/_gen/resources/gke_backup_restore_plan_iam_binding.libsonnet create mode 100644 4.x/_gen/resources/gke_backup_restore_plan_iam_member.libsonnet create mode 100644 4.x/_gen/resources/gke_backup_restore_plan_iam_policy.libsonnet create mode 100644 4.x/_gen/resources/scc_project_custom_module.libsonnet create mode 100644 docs/4.x/data/certificate_manager_certificate_map.md create mode 100644 docs/4.x/data/gke_backup_restore_plan_iam_policy.md create mode 100644 docs/4.x/dialogflow_cx_security_settings.md create mode 100644 docs/4.x/edgenetwork_network.md create mode 100644 docs/4.x/edgenetwork_subnet.md create mode 100644 docs/4.x/gke_backup_restore_plan.md create mode 100644 docs/4.x/gke_backup_restore_plan_iam_binding.md create mode 100644 docs/4.x/gke_backup_restore_plan_iam_member.md create mode 100644 docs/4.x/gke_backup_restore_plan_iam_policy.md create mode 100644 docs/4.x/scc_project_custom_module.md diff --git a/4.x/_gen/data/certificate_manager_certificate_map.libsonnet b/4.x/_gen/data/certificate_manager_certificate_map.libsonnet new file mode 100644 index 00000000..64f369ab --- /dev/null +++ b/4.x/_gen/data/certificate_manager_certificate_map.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='certificate_manager_certificate_map', url='', help='`certificate_manager_certificate_map` represents the `google_certificate_manager_certificate_map` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google.data.certificate_manager_certificate_map.new` injects a new `data_google_certificate_manager_certificate_map` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.data.certificate_manager_certificate_map.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data.certificate_manager_certificate_map` using the reference:\n\n $._ref.data_google_certificate_manager_certificate_map.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google_certificate_manager_certificate_map.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `name` (`string`): A user-defined name of the Certificate Map. Certificate Map names must be unique\nglobally and match the pattern \u0026#39;projects/*/locations/*/certificateMaps/*\u0026#39;.\n - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + name, + project=null, + _meta={} + ):: tf.withData( + type='google_certificate_manager_certificate_map', + label=dataSrcLabel, + attrs=self.newAttrs(name=name, project=project), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data.certificate_manager_certificate_map.newAttrs` constructs a new object with attributes and blocks configured for the `certificate_manager_certificate_map`\nTerraform data source.\n\nUnlike [google.data.certificate_manager_certificate_map.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `name` (`string`): A user-defined name of the Certificate Map. Certificate Map names must be unique\nglobally and match the pattern 'projects/*/locations/*/certificateMaps/*'.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `certificate_manager_certificate_map` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + project=null + ):: std.prune(a={ + name: name, + project: project, + }), + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(dataSrcLabel, value): { + data+: { + google_certificate_manager_certificate_map+: { + [dataSrcLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the project field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(dataSrcLabel, value): { + data+: { + google_certificate_manager_certificate_map+: { + [dataSrcLabel]+: { + project: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/data/gke_backup_restore_plan_iam_policy.libsonnet b/4.x/_gen/data/gke_backup_restore_plan_iam_policy.libsonnet new file mode 100644 index 00000000..15652c0a --- /dev/null +++ b/4.x/_gen/data/gke_backup_restore_plan_iam_policy.libsonnet @@ -0,0 +1,58 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='gke_backup_restore_plan_iam_policy', url='', help='`gke_backup_restore_plan_iam_policy` represents the `google_gke_backup_restore_plan_iam_policy` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google.data.gke_backup_restore_plan_iam_policy.new` injects a new `data_google_gke_backup_restore_plan_iam_policy` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.data.gke_backup_restore_plan_iam_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data.gke_backup_restore_plan_iam_policy` using the reference:\n\n $._ref.data_google_gke_backup_restore_plan_iam_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google_gke_backup_restore_plan_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 - `dataSrcLabel` (`string`): The name label of the block.\n - `location` (`string`): Set the `location` field on the resulting data source block. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting data source block.\n - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + name, + location=null, + project=null, + _meta={} + ):: tf.withData( + type='google_gke_backup_restore_plan_iam_policy', + label=dataSrcLabel, + attrs=self.newAttrs(location=location, name=name, project=project), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data.gke_backup_restore_plan_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan_iam_policy`\nTerraform data source.\n\nUnlike [google.data.gke_backup_restore_plan_iam_policy.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `location` (`string`): Set the `location` field on the resulting object. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` 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\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `gke_backup_restore_plan_iam_policy` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + location=null, + project=null + ):: std.prune(a={ + location: location, + name: name, + project: project, + }), + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the location field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), + withLocation(dataSrcLabel, value): { + data+: { + google_gke_backup_restore_plan_iam_policy+: { + [dataSrcLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(dataSrcLabel, value): { + data+: { + google_gke_backup_restore_plan_iam_policy+: { + [dataSrcLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the project field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(dataSrcLabel, value): { + data+: { + google_gke_backup_restore_plan_iam_policy+: { + [dataSrcLabel]+: { + project: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/data/main.libsonnet b/4.x/_gen/data/main.libsonnet index 6dd6ff1a..677f8722 100644 --- a/4.x/_gen/data/main.libsonnet +++ b/4.x/_gen/data/main.libsonnet @@ -27,6 +27,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); billing_account: (import 'billing_account.libsonnet'), billing_account_iam_policy: (import 'billing_account_iam_policy.libsonnet'), binary_authorization_attestor_iam_policy: (import 'binary_authorization_attestor_iam_policy.libsonnet'), + certificate_manager_certificate_map: (import 'certificate_manager_certificate_map.libsonnet'), client_config: (import 'client_config.libsonnet'), client_openid_userinfo: (import 'client_openid_userinfo.libsonnet'), cloud_identity_group_memberships: (import 'cloud_identity_group_memberships.libsonnet'), @@ -126,6 +127,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); folders: (import 'folders.libsonnet'), game_services_game_server_deployment_rollout: (import 'game_services_game_server_deployment_rollout.libsonnet'), gke_backup_backup_plan_iam_policy: (import 'gke_backup_backup_plan_iam_policy.libsonnet'), + gke_backup_restore_plan_iam_policy: (import 'gke_backup_restore_plan_iam_policy.libsonnet'), gke_hub_feature_iam_policy: (import 'gke_hub_feature_iam_policy.libsonnet'), gke_hub_membership_iam_policy: (import 'gke_hub_membership_iam_policy.libsonnet'), gke_hub_scope_iam_policy: (import 'gke_hub_scope_iam_policy.libsonnet'), diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index ef14b9c1..887418a9 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -377,6 +377,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); dialogflow_cx_flow: (import 'resources/dialogflow_cx_flow.libsonnet'), dialogflow_cx_intent: (import 'resources/dialogflow_cx_intent.libsonnet'), dialogflow_cx_page: (import 'resources/dialogflow_cx_page.libsonnet'), + dialogflow_cx_security_settings: (import 'resources/dialogflow_cx_security_settings.libsonnet'), dialogflow_cx_test_case: (import 'resources/dialogflow_cx_test_case.libsonnet'), dialogflow_cx_version: (import 'resources/dialogflow_cx_version.libsonnet'), dialogflow_cx_webhook: (import 'resources/dialogflow_cx_webhook.libsonnet'), @@ -395,6 +396,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); document_ai_processor_default_version: (import 'resources/document_ai_processor_default_version.libsonnet'), document_ai_warehouse_document_schema: (import 'resources/document_ai_warehouse_document_schema.libsonnet'), document_ai_warehouse_location: (import 'resources/document_ai_warehouse_location.libsonnet'), + edgenetwork_network: (import 'resources/edgenetwork_network.libsonnet'), + edgenetwork_subnet: (import 'resources/edgenetwork_subnet.libsonnet'), endpoints_service: (import 'resources/endpoints_service.libsonnet'), endpoints_service_consumers_iam_binding: (import 'resources/endpoints_service_consumers_iam_binding.libsonnet'), endpoints_service_consumers_iam_member: (import 'resources/endpoints_service_consumers_iam_member.libsonnet'), @@ -431,6 +434,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_backup_backup_plan_iam_binding: (import 'resources/gke_backup_backup_plan_iam_binding.libsonnet'), gke_backup_backup_plan_iam_member: (import 'resources/gke_backup_backup_plan_iam_member.libsonnet'), gke_backup_backup_plan_iam_policy: (import 'resources/gke_backup_backup_plan_iam_policy.libsonnet'), + gke_backup_restore_plan: (import 'resources/gke_backup_restore_plan.libsonnet'), + gke_backup_restore_plan_iam_binding: (import 'resources/gke_backup_restore_plan_iam_binding.libsonnet'), + gke_backup_restore_plan_iam_member: (import 'resources/gke_backup_restore_plan_iam_member.libsonnet'), + gke_backup_restore_plan_iam_policy: (import 'resources/gke_backup_restore_plan_iam_policy.libsonnet'), gke_hub_feature: (import 'resources/gke_hub_feature.libsonnet'), gke_hub_feature_iam_binding: (import 'resources/gke_hub_feature_iam_binding.libsonnet'), gke_hub_feature_iam_member: (import 'resources/gke_hub_feature_iam_member.libsonnet'), @@ -622,6 +629,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.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_project_custom_module: (import 'resources/scc_project_custom_module.libsonnet'), scc_source: (import 'resources/scc_source.libsonnet'), scc_source_iam_binding: (import 'resources/scc_source_iam_binding.libsonnet'), scc_source_iam_member: (import 'resources/scc_source_iam_member.libsonnet'), diff --git a/4.x/_gen/provider_google.libsonnet b/4.x/_gen/provider_google.libsonnet index 4fcfc33f..00871df2 100644 --- a/4.x/_gen/provider_google.libsonnet +++ b/4.x/_gen/provider_google.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='provider', url='', help='`provider` represents the `google` Terraform provider config.\n\n\n\nThis package contains functions and utilities for setting up the provider using Jsonnet code.\n'), - '#new':: d.fn(help='\n`google.provider.new` injects a new `google` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting provider block. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting provider block. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting provider block. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting provider block. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting provider block. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting provider block. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting provider block. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting provider block. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting provider block. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting provider block. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting provider block. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting provider block. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting provider block. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting provider block. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting provider block. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting provider block. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting provider block. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting provider block. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_iot_custom_endpoint` (`string`): Set the `cloud_iot_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_iot_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting provider block. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting provider block. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting provider block. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting provider block. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting provider block. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting provider block. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting provider block. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting provider block. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting provider block. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting provider block. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting provider block. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting provider block. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting provider block. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `data_pipeline_custom_endpoint` (`string`): Set the `data_pipeline_custom_endpoint` field on the resulting provider block. When `null`, the `data_pipeline_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting provider block. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting provider block. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting provider block. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting provider block. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting provider block. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting provider block. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting provider block. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting provider block. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting provider block. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting provider block. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting provider block. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting provider block. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `game_services_custom_endpoint` (`string`): Set the `game_services_custom_endpoint` field on the resulting provider block. When `null`, the `game_services_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting provider block. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting provider block. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `healthcare_custom_endpoint` (`string`): Set the `healthcare_custom_endpoint` field on the resulting provider block. When `null`, the `healthcare_custom_endpoint` field will be omitted from the resulting object.\n - `iam2_custom_endpoint` (`string`): Set the `iam2_custom_endpoint` field on the resulting provider block. When `null`, the `iam2_custom_endpoint` field will be omitted from the resulting object.\n - `iam_beta_custom_endpoint` (`string`): Set the `iam_beta_custom_endpoint` field on the resulting provider block. When `null`, the `iam_beta_custom_endpoint` field will be omitted from the resulting object.\n - `iam_credentials_custom_endpoint` (`string`): Set the `iam_credentials_custom_endpoint` field on the resulting provider block. When `null`, the `iam_credentials_custom_endpoint` field will be omitted from the resulting object.\n - `iam_custom_endpoint` (`string`): Set the `iam_custom_endpoint` field on the resulting provider block. When `null`, the `iam_custom_endpoint` field will be omitted from the resulting object.\n - `iam_workforce_pool_custom_endpoint` (`string`): Set the `iam_workforce_pool_custom_endpoint` field on the resulting provider block. When `null`, the `iam_workforce_pool_custom_endpoint` field will be omitted from the resulting object.\n - `iap_custom_endpoint` (`string`): Set the `iap_custom_endpoint` field on the resulting provider block. When `null`, the `iap_custom_endpoint` field will be omitted from the resulting object.\n - `identity_platform_custom_endpoint` (`string`): Set the `identity_platform_custom_endpoint` field on the resulting provider block. When `null`, the `identity_platform_custom_endpoint` field will be omitted from the resulting object.\n - `impersonate_service_account` (`string`): Set the `impersonate_service_account` field on the resulting provider block. When `null`, the `impersonate_service_account` field will be omitted from the resulting object.\n - `impersonate_service_account_delegates` (`list`): Set the `impersonate_service_account_delegates` field on the resulting provider block. When `null`, the `impersonate_service_account_delegates` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting provider block. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting provider block. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting provider block. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting provider block. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting provider block. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting provider block. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting provider block. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting provider block. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting provider block. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting provider block. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting provider block. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting provider block. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting provider block. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting provider block. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting provider block. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting provider block. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting provider block. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting provider block. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting provider block. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting provider block. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting provider block. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting provider block. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting provider block. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting provider block. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting provider block. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting provider block. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting provider block. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting provider block. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting provider block. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting provider block. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting provider block. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting provider block. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_insights_custom_endpoint` (`string`): Set the `storage_insights_custom_endpoint` field on the resulting provider block. When `null`, the `storage_insights_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting provider block. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting provider block. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting provider block. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting provider block. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting provider block. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting provider block. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting provider block. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting provider block. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting provider block. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), + '#new':: d.fn(help='\n`google.provider.new` injects a new `google` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting provider block. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting provider block. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting provider block. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting provider block. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting provider block. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting provider block. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting provider block. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting provider block. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting provider block. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting provider block. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting provider block. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting provider block. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting provider block. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting provider block. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting provider block. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting provider block. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting provider block. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting provider block. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_iot_custom_endpoint` (`string`): Set the `cloud_iot_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_iot_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting provider block. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting provider block. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting provider block. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting provider block. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting provider block. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting provider block. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting provider block. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting provider block. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting provider block. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting provider block. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting provider block. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting provider block. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting provider block. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `data_pipeline_custom_endpoint` (`string`): Set the `data_pipeline_custom_endpoint` field on the resulting provider block. When `null`, the `data_pipeline_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting provider block. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting provider block. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting provider block. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting provider block. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting provider block. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting provider block. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting provider block. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `edgenetwork_custom_endpoint` (`string`): Set the `edgenetwork_custom_endpoint` field on the resulting provider block. When `null`, the `edgenetwork_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting provider block. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting provider block. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting provider block. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting provider block. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting provider block. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `game_services_custom_endpoint` (`string`): Set the `game_services_custom_endpoint` field on the resulting provider block. When `null`, the `game_services_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting provider block. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting provider block. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `healthcare_custom_endpoint` (`string`): Set the `healthcare_custom_endpoint` field on the resulting provider block. When `null`, the `healthcare_custom_endpoint` field will be omitted from the resulting object.\n - `iam2_custom_endpoint` (`string`): Set the `iam2_custom_endpoint` field on the resulting provider block. When `null`, the `iam2_custom_endpoint` field will be omitted from the resulting object.\n - `iam_beta_custom_endpoint` (`string`): Set the `iam_beta_custom_endpoint` field on the resulting provider block. When `null`, the `iam_beta_custom_endpoint` field will be omitted from the resulting object.\n - `iam_credentials_custom_endpoint` (`string`): Set the `iam_credentials_custom_endpoint` field on the resulting provider block. When `null`, the `iam_credentials_custom_endpoint` field will be omitted from the resulting object.\n - `iam_custom_endpoint` (`string`): Set the `iam_custom_endpoint` field on the resulting provider block. When `null`, the `iam_custom_endpoint` field will be omitted from the resulting object.\n - `iam_workforce_pool_custom_endpoint` (`string`): Set the `iam_workforce_pool_custom_endpoint` field on the resulting provider block. When `null`, the `iam_workforce_pool_custom_endpoint` field will be omitted from the resulting object.\n - `iap_custom_endpoint` (`string`): Set the `iap_custom_endpoint` field on the resulting provider block. When `null`, the `iap_custom_endpoint` field will be omitted from the resulting object.\n - `identity_platform_custom_endpoint` (`string`): Set the `identity_platform_custom_endpoint` field on the resulting provider block. When `null`, the `identity_platform_custom_endpoint` field will be omitted from the resulting object.\n - `impersonate_service_account` (`string`): Set the `impersonate_service_account` field on the resulting provider block. When `null`, the `impersonate_service_account` field will be omitted from the resulting object.\n - `impersonate_service_account_delegates` (`list`): Set the `impersonate_service_account_delegates` field on the resulting provider block. When `null`, the `impersonate_service_account_delegates` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting provider block. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting provider block. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting provider block. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting provider block. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting provider block. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting provider block. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting provider block. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting provider block. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting provider block. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting provider block. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting provider block. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting provider block. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting provider block. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting provider block. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting provider block. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting provider block. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting provider block. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting provider block. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting provider block. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting provider block. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting provider block. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting provider block. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting provider block. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting provider block. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting provider block. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting provider block. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting provider block. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting provider block. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting provider block. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting provider block. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting provider block. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting provider block. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_insights_custom_endpoint` (`string`): Set the `storage_insights_custom_endpoint` field on the resulting provider block. When `null`, the `storage_insights_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting provider block. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting provider block. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting provider block. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting provider block. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting provider block. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting provider block. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting provider block. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting provider block. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting provider block. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), new( access_approval_custom_endpoint=null, access_context_manager_custom_endpoint=null, @@ -70,6 +70,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); dns_custom_endpoint=null, document_ai_custom_endpoint=null, document_ai_warehouse_custom_endpoint=null, + edgenetwork_custom_endpoint=null, essential_contacts_custom_endpoint=null, eventarc_custom_endpoint=null, filestore_custom_endpoint=null, @@ -211,6 +212,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); dns_custom_endpoint=dns_custom_endpoint, document_ai_custom_endpoint=document_ai_custom_endpoint, document_ai_warehouse_custom_endpoint=document_ai_warehouse_custom_endpoint, + edgenetwork_custom_endpoint=edgenetwork_custom_endpoint, essential_contacts_custom_endpoint=essential_contacts_custom_endpoint, eventarc_custom_endpoint=eventarc_custom_endpoint, filestore_custom_endpoint=filestore_custom_endpoint, @@ -279,7 +281,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); zone=zone ) ), - '#newAttrs':: d.fn(help='\n`google.provider.` constructs a new object with attributes and blocks configured for the `google`\nTerraform `provider`.\n\nUnlike [google.provider.new](#fn-googlenew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) 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 - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting object. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting object. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting object. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting object. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting object. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting object. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting object. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting object. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting object. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting object. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting object. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting object. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting object. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting object. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting object. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting object. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting object. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting object. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting object. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting object. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting object. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting object. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting object. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting object. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting object. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting object. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting object. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting object. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_iot_custom_endpoint` (`string`): Set the `cloud_iot_custom_endpoint` field on the resulting object. When `null`, the `cloud_iot_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting object. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting object. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting object. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting object. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting object. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting object. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting object. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting object. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting object. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting object. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting object. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting object. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting object. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting object. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting object. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting object. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting object. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting object. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `data_pipeline_custom_endpoint` (`string`): Set the `data_pipeline_custom_endpoint` field on the resulting object. When `null`, the `data_pipeline_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting object. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting object. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting object. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting object. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting object. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting object. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting object. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting object. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting object. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting object. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting object. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting object. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting object. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting object. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting object. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting object. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `game_services_custom_endpoint` (`string`): Set the `game_services_custom_endpoint` field on the resulting object. When `null`, the `game_services_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting object. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting object. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting object. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting object. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `healthcare_custom_endpoint` (`string`): Set the `healthcare_custom_endpoint` field on the resulting object. When `null`, the `healthcare_custom_endpoint` field will be omitted from the resulting object.\n - `iam2_custom_endpoint` (`string`): Set the `iam2_custom_endpoint` field on the resulting object. When `null`, the `iam2_custom_endpoint` field will be omitted from the resulting object.\n - `iam_beta_custom_endpoint` (`string`): Set the `iam_beta_custom_endpoint` field on the resulting object. When `null`, the `iam_beta_custom_endpoint` field will be omitted from the resulting object.\n - `iam_credentials_custom_endpoint` (`string`): Set the `iam_credentials_custom_endpoint` field on the resulting object. When `null`, the `iam_credentials_custom_endpoint` field will be omitted from the resulting object.\n - `iam_custom_endpoint` (`string`): Set the `iam_custom_endpoint` field on the resulting object. When `null`, the `iam_custom_endpoint` field will be omitted from the resulting object.\n - `iam_workforce_pool_custom_endpoint` (`string`): Set the `iam_workforce_pool_custom_endpoint` field on the resulting object. When `null`, the `iam_workforce_pool_custom_endpoint` field will be omitted from the resulting object.\n - `iap_custom_endpoint` (`string`): Set the `iap_custom_endpoint` field on the resulting object. When `null`, the `iap_custom_endpoint` field will be omitted from the resulting object.\n - `identity_platform_custom_endpoint` (`string`): Set the `identity_platform_custom_endpoint` field on the resulting object. When `null`, the `identity_platform_custom_endpoint` field will be omitted from the resulting object.\n - `impersonate_service_account` (`string`): Set the `impersonate_service_account` field on the resulting object. When `null`, the `impersonate_service_account` field will be omitted from the resulting object.\n - `impersonate_service_account_delegates` (`list`): Set the `impersonate_service_account_delegates` field on the resulting object. When `null`, the `impersonate_service_account_delegates` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting object. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting object. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting object. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting object. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting object. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting object. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting object. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting object. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting object. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting object. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting object. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting object. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting object. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting object. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting object. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting object. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting object. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting object. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting object. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting object. When `null`, the `redis_custom_endpoint` 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 - `request_reason` (`string`): Set the `request_reason` field on the resulting object. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting object. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting object. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting object. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting object. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting object. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting object. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting object. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting object. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting object. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting object. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting object. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_insights_custom_endpoint` (`string`): Set the `storage_insights_custom_endpoint` field on the resulting object. When `null`, the `storage_insights_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting object. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting object. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting object. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting object. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting object. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting object. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting object. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting object. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting object. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting object. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `google` provider\n configuration into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.provider.` constructs a new object with attributes and blocks configured for the `google`\nTerraform `provider`.\n\nUnlike [google.provider.new](#fn-googlenew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) 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 - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting object. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting object. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting object. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting object. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting object. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting object. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting object. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting object. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting object. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting object. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting object. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting object. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting object. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting object. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting object. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting object. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting object. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting object. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting object. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting object. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting object. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting object. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting object. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting object. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting object. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting object. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting object. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting object. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_iot_custom_endpoint` (`string`): Set the `cloud_iot_custom_endpoint` field on the resulting object. When `null`, the `cloud_iot_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting object. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting object. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting object. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting object. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting object. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting object. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting object. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting object. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting object. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting object. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting object. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting object. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting object. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting object. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting object. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting object. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting object. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting object. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `data_pipeline_custom_endpoint` (`string`): Set the `data_pipeline_custom_endpoint` field on the resulting object. When `null`, the `data_pipeline_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting object. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting object. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting object. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting object. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting object. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting object. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting object. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting object. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting object. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting object. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting object. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `edgenetwork_custom_endpoint` (`string`): Set the `edgenetwork_custom_endpoint` field on the resulting object. When `null`, the `edgenetwork_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting object. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting object. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting object. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting object. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting object. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `game_services_custom_endpoint` (`string`): Set the `game_services_custom_endpoint` field on the resulting object. When `null`, the `game_services_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting object. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting object. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting object. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting object. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `healthcare_custom_endpoint` (`string`): Set the `healthcare_custom_endpoint` field on the resulting object. When `null`, the `healthcare_custom_endpoint` field will be omitted from the resulting object.\n - `iam2_custom_endpoint` (`string`): Set the `iam2_custom_endpoint` field on the resulting object. When `null`, the `iam2_custom_endpoint` field will be omitted from the resulting object.\n - `iam_beta_custom_endpoint` (`string`): Set the `iam_beta_custom_endpoint` field on the resulting object. When `null`, the `iam_beta_custom_endpoint` field will be omitted from the resulting object.\n - `iam_credentials_custom_endpoint` (`string`): Set the `iam_credentials_custom_endpoint` field on the resulting object. When `null`, the `iam_credentials_custom_endpoint` field will be omitted from the resulting object.\n - `iam_custom_endpoint` (`string`): Set the `iam_custom_endpoint` field on the resulting object. When `null`, the `iam_custom_endpoint` field will be omitted from the resulting object.\n - `iam_workforce_pool_custom_endpoint` (`string`): Set the `iam_workforce_pool_custom_endpoint` field on the resulting object. When `null`, the `iam_workforce_pool_custom_endpoint` field will be omitted from the resulting object.\n - `iap_custom_endpoint` (`string`): Set the `iap_custom_endpoint` field on the resulting object. When `null`, the `iap_custom_endpoint` field will be omitted from the resulting object.\n - `identity_platform_custom_endpoint` (`string`): Set the `identity_platform_custom_endpoint` field on the resulting object. When `null`, the `identity_platform_custom_endpoint` field will be omitted from the resulting object.\n - `impersonate_service_account` (`string`): Set the `impersonate_service_account` field on the resulting object. When `null`, the `impersonate_service_account` field will be omitted from the resulting object.\n - `impersonate_service_account_delegates` (`list`): Set the `impersonate_service_account_delegates` field on the resulting object. When `null`, the `impersonate_service_account_delegates` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting object. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting object. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting object. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting object. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting object. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting object. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting object. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting object. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting object. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting object. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting object. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting object. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting object. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting object. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting object. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting object. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting object. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting object. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting object. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting object. When `null`, the `redis_custom_endpoint` 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 - `request_reason` (`string`): Set the `request_reason` field on the resulting object. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting object. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting object. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting object. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting object. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting object. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting object. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting object. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting object. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting object. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting object. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting object. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_insights_custom_endpoint` (`string`): Set the `storage_insights_custom_endpoint` field on the resulting object. When `null`, the `storage_insights_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting object. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting object. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting object. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting object. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting object. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting object. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting object. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting object. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting object. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting object. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `google` provider\n configuration into the root Terraform configuration.\n', args=[]), newAttrs( access_approval_custom_endpoint=null, access_context_manager_custom_endpoint=null, @@ -347,6 +349,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); dns_custom_endpoint=null, document_ai_custom_endpoint=null, document_ai_warehouse_custom_endpoint=null, + edgenetwork_custom_endpoint=null, essential_contacts_custom_endpoint=null, eventarc_custom_endpoint=null, filestore_custom_endpoint=null, @@ -480,6 +483,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); dns_custom_endpoint: dns_custom_endpoint, document_ai_custom_endpoint: document_ai_custom_endpoint, document_ai_warehouse_custom_endpoint: document_ai_warehouse_custom_endpoint, + edgenetwork_custom_endpoint: edgenetwork_custom_endpoint, essential_contacts_custom_endpoint: essential_contacts_custom_endpoint, eventarc_custom_endpoint: eventarc_custom_endpoint, filestore_custom_endpoint: filestore_custom_endpoint, diff --git a/4.x/_gen/resources/alloydb_cluster.libsonnet b/4.x/_gen/resources/alloydb_cluster.libsonnet index c0621a3c..5f1bd7ff 100644 --- a/4.x/_gen/resources/alloydb_cluster.libsonnet +++ b/4.x/_gen/resources/alloydb_cluster.libsonnet @@ -110,18 +110,29 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user: user, }), }, - '#new':: d.fn(help="\n`google.alloydb_cluster.new` injects a new `google_alloydb_cluster` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.alloydb_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.alloydb_cluster` using the reference:\n\n $._ref.google_alloydb_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_alloydb_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n\u0026#34;projects/{projectNumber}/global/networks/{network_id}\u0026#34;.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor.\n - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with \u0026#39;restore_continuous_backup_source\u0026#39;, both can\u0026#39;t be set together. When `null`, the `restore_backup_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.alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor.\n - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with \u0026#39;restore_backup_source\u0026#39;, both can\u0026#39;t be set together. When `null`, the `restore_continuous_backup_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.alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + network_config:: { + '#new':: d.fn(help='\n`google.alloydb_cluster.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 - `allocated_ip_range` (`string`): The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default".\nIf set, the instance IPs for this cluster will be created in the allocated range. When `null`, the `allocated_ip_range` field will be omitted from the resulting object.\n - `network` (`string`): The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster.\nIt is specified in the form: "projects/{projectNumber}/global/networks/{network_id}". When `null`, the `network` 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( + allocated_ip_range=null, + network=null + ):: std.prune(a={ + allocated_ip_range: allocated_ip_range, + network: network, + }), + }, + '#new':: d.fn(help="\n`google.alloydb_cluster.new` injects a new `google_alloydb_cluster` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.alloydb_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.alloydb_cluster` using the reference:\n\n $._ref.google_alloydb_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_alloydb_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n\u0026#34;projects/{projectNumber}/global/networks/{network_id}\u0026#34;. When `null`, the `network` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor.\n - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `network_config` (`list[obj]`): Metadata related to network configuration. 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.alloydb_cluster.network_config.new](#fn-network_confignew) constructor.\n - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with \u0026#39;restore_continuous_backup_source\u0026#39;, both can\u0026#39;t be set together. When `null`, the `restore_backup_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.alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor.\n - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with \u0026#39;restore_backup_source\u0026#39;, both can\u0026#39;t be set together. When `null`, the `restore_continuous_backup_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.alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, cluster_id, location, - network, automated_backup_policy=null, continuous_backup_config=null, display_name=null, encryption_config=null, initial_user=null, labels=null, + network=null, + network_config=null, project=null, restore_backup_source=null, restore_continuous_backup_source=null, @@ -140,6 +151,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels=labels, location=location, network=network, + network_config=network_config, project=project, restore_backup_source=restore_backup_source, restore_continuous_backup_source=restore_continuous_backup_source, @@ -147,17 +159,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.alloydb_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `alloydb_cluster`\nTerraform resource.\n\nUnlike [google.alloydb_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n"projects/{projectNumber}/global/networks/{network_id}".\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor.\n - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. When `null`, the `restore_backup_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.alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor.\n - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. When `null`, the `restore_continuous_backup_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.alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `alloydb_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.alloydb_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `alloydb_cluster`\nTerraform resource.\n\nUnlike [google.alloydb_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n"projects/{projectNumber}/global/networks/{network_id}". When `null`, the `network` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor.\n - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `network_config` (`list[obj]`): Metadata related to network configuration. 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.alloydb_cluster.network_config.new](#fn-network_confignew) constructor.\n - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. When `null`, the `restore_backup_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.alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor.\n - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. When `null`, the `restore_continuous_backup_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.alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `alloydb_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster_id, location, - network, automated_backup_policy=null, continuous_backup_config=null, display_name=null, encryption_config=null, initial_user=null, labels=null, + network=null, + network_config=null, project=null, restore_backup_source=null, restore_continuous_backup_source=null, @@ -172,6 +185,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels: labels, location: location, network: network, + network_config: network_config, project: project, restore_backup_source: restore_backup_source, restore_continuous_backup_source: restore_continuous_backup_source, @@ -337,6 +351,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withNetworkConfig':: d.fn(help='`google.list[obj].withNetworkConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the network_config 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].withNetworkConfigMixin](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 `network_config` field.\n', args=[]), + withNetworkConfig(resourceLabel, value): { + resource+: { + google_alloydb_cluster+: { + [resourceLabel]+: { + network_config: value, + }, + }, + }, + }, + '#withNetworkConfigMixin':: d.fn(help='`google.list[obj].withNetworkConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the network_config 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].withNetworkConfig](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 `network_config` field.\n', args=[]), + withNetworkConfigMixin(resourceLabel, value): { + resource+: { + google_alloydb_cluster+: { + [resourceLabel]+: { + network_config+: if std.isArray(v=value) then value else [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+: { diff --git a/4.x/_gen/resources/bigtable_instance.libsonnet b/4.x/_gen/resources/bigtable_instance.libsonnet index 03cb7a0a..368c9566 100644 --- a/4.x/_gen/resources/bigtable_instance.libsonnet +++ b/4.x/_gen/resources/bigtable_instance.libsonnet @@ -82,12 +82,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`google.bigtable_instance.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 - `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':: d.fn(help='\n`google.bigtable_instance.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 - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` 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, + read=null, update=null ):: std.prune(a={ create: create, + read: read, update: update, }), }, diff --git a/4.x/_gen/resources/cloud_run_v2_job.libsonnet b/4.x/_gen/resources/cloud_run_v2_job.libsonnet index 9c549528..e5334e89 100644 --- a/4.x/_gen/resources/cloud_run_v2_job.libsonnet +++ b/4.x/_gen/resources/cloud_run_v2_job.libsonnet @@ -330,13 +330,27 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, vpc_access:: { - '#new':: d.fn(help='\n`google.cloud_run_v2_job.template.template.vpc_access.new` constructs a new object with attributes and blocks configured for the `vpc_access`\nTerraform sub block.\n\n\n\n**Args**:\n - `connector` (`string`): VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. When `null`, the `connector` field will be omitted from the resulting object.\n - `egress` (`string`): Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"] When `null`, the `egress` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `vpc_access` sub block.\n', args=[]), + network_interfaces:: { + '#new':: d.fn(help='\n`google.cloud_run_v2_job.template.template.vpc_access.network_interfaces.new` constructs a new object with attributes and blocks configured for the `network_interfaces`\nTerraform sub block.\n\n\n\n**Args**:\n - `network` (`string`): The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both\nnetwork and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be\nlooked up from the subnetwork. When `null`, the `network` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both\nnetwork and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the\nsubnetwork with the same name with the network will be used. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `tags` (`list`): Network tags applied to this Cloud Run job. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `network_interfaces` sub block.\n', args=[]), + new( + network=null, + subnetwork=null, + tags=null + ):: std.prune(a={ + network: network, + subnetwork: subnetwork, + tags: tags, + }), + }, + '#new':: d.fn(help='\n`google.cloud_run_v2_job.template.template.vpc_access.new` constructs a new object with attributes and blocks configured for the `vpc_access`\nTerraform sub block.\n\n\n\n**Args**:\n - `connector` (`string`): VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. When `null`, the `connector` field will be omitted from the resulting object.\n - `egress` (`string`): Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"] When `null`, the `egress` field will be omitted from the resulting object.\n - `network_interfaces` (`list[obj]`): Direct VPC egress settings. Currently only single network interface is supported. When `null`, the `network_interfaces` 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_job.template.template.vpc_access.network_interfaces.new](#fn-templatetemplatetemplatenetwork_interfacesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `vpc_access` sub block.\n', args=[]), new( connector=null, - egress=null + egress=null, + network_interfaces=null ):: std.prune(a={ connector: connector, egress: egress, + network_interfaces: network_interfaces, }), }, }, diff --git a/4.x/_gen/resources/cloud_run_v2_service.libsonnet b/4.x/_gen/resources/cloud_run_v2_service.libsonnet index 9fa7524d..38f6cea8 100644 --- a/4.x/_gen/resources/cloud_run_v2_service.libsonnet +++ b/4.x/_gen/resources/cloud_run_v2_service.libsonnet @@ -379,13 +379,27 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, vpc_access:: { - '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.vpc_access.new` constructs a new object with attributes and blocks configured for the `vpc_access`\nTerraform sub block.\n\n\n\n**Args**:\n - `connector` (`string`): VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. When `null`, the `connector` field will be omitted from the resulting object.\n - `egress` (`string`): Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"] When `null`, the `egress` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `vpc_access` sub block.\n', args=[]), + network_interfaces:: { + '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.vpc_access.network_interfaces.new` constructs a new object with attributes and blocks configured for the `network_interfaces`\nTerraform sub block.\n\n\n\n**Args**:\n - `network` (`string`): The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both\nnetwork and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be\nlooked up from the subnetwork. When `null`, the `network` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both\nnetwork and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the\nsubnetwork with the same name with the network will be used. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `tags` (`list`): Network tags applied to this Cloud Run service. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `network_interfaces` sub block.\n', args=[]), + new( + network=null, + subnetwork=null, + tags=null + ):: std.prune(a={ + network: network, + subnetwork: subnetwork, + tags: tags, + }), + }, + '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.vpc_access.new` constructs a new object with attributes and blocks configured for the `vpc_access`\nTerraform sub block.\n\n\n\n**Args**:\n - `connector` (`string`): VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. When `null`, the `connector` field will be omitted from the resulting object.\n - `egress` (`string`): Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"] When `null`, the `egress` field will be omitted from the resulting object.\n - `network_interfaces` (`list[obj]`): Direct VPC egress settings. Currently only single network interface is supported. When `null`, the `network_interfaces` 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.vpc_access.network_interfaces.new](#fn-templatetemplatenetwork_interfacesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `vpc_access` sub block.\n', args=[]), new( connector=null, - egress=null + egress=null, + network_interfaces=null ):: std.prune(a={ connector: connector, egress: egress, + network_interfaces: network_interfaces, }), }, }, diff --git a/4.x/_gen/resources/compute_autoscaler.libsonnet b/4.x/_gen/resources/compute_autoscaler.libsonnet index 28c436d9..34d681f8 100644 --- a/4.x/_gen/resources/compute_autoscaler.libsonnet +++ b/4.x/_gen/resources/compute_autoscaler.libsonnet @@ -33,7 +33,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type: type, }), }, - '#new':: d.fn(help='\n`google.compute_autoscaler.autoscaling_policy.new` constructs a new object with attributes and blocks configured for the `autoscaling_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `cooldown_period` (`number`): The number of seconds that the autoscaler should wait before it\nstarts collecting information from a new instance. This prevents\nthe autoscaler from collecting information when the instance is\ninitializing, during which the collected usage would not be\nreliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of\nnumerous factors. We recommend that you test how long an\ninstance may take to initialize. To do this, create an instance\nand time the startup process. When `null`, the `cooldown_period` field will be omitted from the resulting object.\n - `max_replicas` (`number`): The maximum number of instances that the autoscaler can scale up\nto. This is required when creating or updating an autoscaler. The\nmaximum number of replicas should not be lower than minimal number\nof replicas.\n - `min_replicas` (`number`): The minimum number of replicas that the autoscaler can scale down\nto. This cannot be less than 0. If not provided, autoscaler will\nchoose a default value depending on maximum number of instances\nallowed.\n - `mode` (`string`): Defines operating mode for this policy. Default value: "ON" Possible values: ["OFF", "ONLY_UP", "ON"] When `null`, the `mode` field will be omitted from the resulting object.\n - `cpu_utilization` (`list[obj]`): Defines the CPU utilization policy that allows the autoscaler to\nscale based on the average CPU utilization of a managed instance\ngroup. When `null`, the `cpu_utilization` 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_autoscaler.autoscaling_policy.cpu_utilization.new](#fn-autoscaling_policycpu_utilizationnew) constructor.\n - `load_balancing_utilization` (`list[obj]`): Configuration parameters of autoscaling based on a load balancer. When `null`, the `load_balancing_utilization` 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_autoscaler.autoscaling_policy.load_balancing_utilization.new](#fn-autoscaling_policyload_balancing_utilizationnew) constructor.\n - `metric` (`list[obj]`): Configuration parameters of autoscaling based on a custom metric. When `null`, the `metric` 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_autoscaler.autoscaling_policy.metric.new](#fn-autoscaling_policymetricnew) constructor.\n - `scale_in_control` (`list[obj]`): Defines scale in controls to reduce the risk of response latency\nand outages due to abrupt scale-in events When `null`, the `scale_in_control` 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_autoscaler.autoscaling_policy.scale_in_control.new](#fn-autoscaling_policyscale_in_controlnew) constructor.\n - `scaling_schedules` (`list[obj]`): Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. When `null`, the `scaling_schedules` 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_autoscaler.autoscaling_policy.scaling_schedules.new](#fn-autoscaling_policyscaling_schedulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `autoscaling_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.compute_autoscaler.autoscaling_policy.new` constructs a new object with attributes and blocks configured for the `autoscaling_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `cooldown_period` (`number`): The number of seconds that the autoscaler should wait before it\nstarts collecting information from a new instance. This prevents\nthe autoscaler from collecting information when the instance is\ninitializing, during which the collected usage would not be\nreliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of\nnumerous factors. We recommend that you test how long an\ninstance may take to initialize. To do this, create an instance\nand time the startup process. When `null`, the `cooldown_period` field will be omitted from the resulting object.\n - `max_replicas` (`number`): The maximum number of instances that the autoscaler can scale up\nto. This is required when creating or updating an autoscaler. The\nmaximum number of replicas should not be lower than minimal number\nof replicas.\n - `min_replicas` (`number`): The minimum number of replicas that the autoscaler can scale down\nto. This cannot be less than 0. If not provided, autoscaler will\nchoose a default value depending on maximum number of instances\nallowed.\n - `mode` (`string`): Defines operating mode for this policy. When `null`, the `mode` field will be omitted from the resulting object.\n - `cpu_utilization` (`list[obj]`): Defines the CPU utilization policy that allows the autoscaler to\nscale based on the average CPU utilization of a managed instance\ngroup. When `null`, the `cpu_utilization` 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_autoscaler.autoscaling_policy.cpu_utilization.new](#fn-autoscaling_policycpu_utilizationnew) constructor.\n - `load_balancing_utilization` (`list[obj]`): Configuration parameters of autoscaling based on a load balancer. When `null`, the `load_balancing_utilization` 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_autoscaler.autoscaling_policy.load_balancing_utilization.new](#fn-autoscaling_policyload_balancing_utilizationnew) constructor.\n - `metric` (`list[obj]`): Configuration parameters of autoscaling based on a custom metric. When `null`, the `metric` 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_autoscaler.autoscaling_policy.metric.new](#fn-autoscaling_policymetricnew) constructor.\n - `scale_in_control` (`list[obj]`): Defines scale in controls to reduce the risk of response latency\nand outages due to abrupt scale-in events When `null`, the `scale_in_control` 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_autoscaler.autoscaling_policy.scale_in_control.new](#fn-autoscaling_policyscale_in_controlnew) constructor.\n - `scaling_schedules` (`list[obj]`): Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. When `null`, the `scaling_schedules` 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_autoscaler.autoscaling_policy.scaling_schedules.new](#fn-autoscaling_policyscaling_schedulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `autoscaling_policy` sub block.\n', args=[]), new( max_replicas, min_replicas, diff --git a/4.x/_gen/resources/compute_region_autoscaler.libsonnet b/4.x/_gen/resources/compute_region_autoscaler.libsonnet index dae2fb41..7db110b4 100644 --- a/4.x/_gen/resources/compute_region_autoscaler.libsonnet +++ b/4.x/_gen/resources/compute_region_autoscaler.libsonnet @@ -33,7 +33,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type: type, }), }, - '#new':: d.fn(help='\n`google.compute_region_autoscaler.autoscaling_policy.new` constructs a new object with attributes and blocks configured for the `autoscaling_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `cooldown_period` (`number`): The number of seconds that the autoscaler should wait before it\nstarts collecting information from a new instance. This prevents\nthe autoscaler from collecting information when the instance is\ninitializing, during which the collected usage would not be\nreliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of\nnumerous factors. We recommend that you test how long an\ninstance may take to initialize. To do this, create an instance\nand time the startup process. When `null`, the `cooldown_period` field will be omitted from the resulting object.\n - `max_replicas` (`number`): The maximum number of instances that the autoscaler can scale up\nto. This is required when creating or updating an autoscaler. The\nmaximum number of replicas should not be lower than minimal number\nof replicas.\n - `min_replicas` (`number`): The minimum number of replicas that the autoscaler can scale down\nto. This cannot be less than 0. If not provided, autoscaler will\nchoose a default value depending on maximum number of instances\nallowed.\n - `mode` (`string`): Defines operating mode for this policy. Default value: "ON" Possible values: ["OFF", "ONLY_UP", "ON"] When `null`, the `mode` field will be omitted from the resulting object.\n - `cpu_utilization` (`list[obj]`): Defines the CPU utilization policy that allows the autoscaler to\nscale based on the average CPU utilization of a managed instance\ngroup. When `null`, the `cpu_utilization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.cpu_utilization.new](#fn-autoscaling_policycpu_utilizationnew) constructor.\n - `load_balancing_utilization` (`list[obj]`): Configuration parameters of autoscaling based on a load balancer. When `null`, the `load_balancing_utilization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.load_balancing_utilization.new](#fn-autoscaling_policyload_balancing_utilizationnew) constructor.\n - `metric` (`list[obj]`): Configuration parameters of autoscaling based on a custom metric. When `null`, the `metric` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.metric.new](#fn-autoscaling_policymetricnew) constructor.\n - `scale_in_control` (`list[obj]`): Defines scale in controls to reduce the risk of response latency\nand outages due to abrupt scale-in events When `null`, the `scale_in_control` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.scale_in_control.new](#fn-autoscaling_policyscale_in_controlnew) constructor.\n - `scaling_schedules` (`list[obj]`): Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. When `null`, the `scaling_schedules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.scaling_schedules.new](#fn-autoscaling_policyscaling_schedulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `autoscaling_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.compute_region_autoscaler.autoscaling_policy.new` constructs a new object with attributes and blocks configured for the `autoscaling_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `cooldown_period` (`number`): The number of seconds that the autoscaler should wait before it\nstarts collecting information from a new instance. This prevents\nthe autoscaler from collecting information when the instance is\ninitializing, during which the collected usage would not be\nreliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of\nnumerous factors. We recommend that you test how long an\ninstance may take to initialize. To do this, create an instance\nand time the startup process. When `null`, the `cooldown_period` field will be omitted from the resulting object.\n - `max_replicas` (`number`): The maximum number of instances that the autoscaler can scale up\nto. This is required when creating or updating an autoscaler. The\nmaximum number of replicas should not be lower than minimal number\nof replicas.\n - `min_replicas` (`number`): The minimum number of replicas that the autoscaler can scale down\nto. This cannot be less than 0. If not provided, autoscaler will\nchoose a default value depending on maximum number of instances\nallowed.\n - `mode` (`string`): Defines operating mode for this policy. When `null`, the `mode` field will be omitted from the resulting object.\n - `cpu_utilization` (`list[obj]`): Defines the CPU utilization policy that allows the autoscaler to\nscale based on the average CPU utilization of a managed instance\ngroup. When `null`, the `cpu_utilization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.cpu_utilization.new](#fn-autoscaling_policycpu_utilizationnew) constructor.\n - `load_balancing_utilization` (`list[obj]`): Configuration parameters of autoscaling based on a load balancer. When `null`, the `load_balancing_utilization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.load_balancing_utilization.new](#fn-autoscaling_policyload_balancing_utilizationnew) constructor.\n - `metric` (`list[obj]`): Configuration parameters of autoscaling based on a custom metric. When `null`, the `metric` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.metric.new](#fn-autoscaling_policymetricnew) constructor.\n - `scale_in_control` (`list[obj]`): Defines scale in controls to reduce the risk of response latency\nand outages due to abrupt scale-in events When `null`, the `scale_in_control` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.scale_in_control.new](#fn-autoscaling_policyscale_in_controlnew) constructor.\n - `scaling_schedules` (`list[obj]`): Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. When `null`, the `scaling_schedules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.scaling_schedules.new](#fn-autoscaling_policyscaling_schedulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `autoscaling_policy` sub block.\n', args=[]), new( max_replicas, min_replicas, diff --git a/4.x/_gen/resources/compute_target_https_proxy.libsonnet b/4.x/_gen/resources/compute_target_https_proxy.libsonnet index cc0be4cc..f296f12f 100644 --- a/4.x/_gen/resources/compute_target_https_proxy.libsonnet +++ b/4.x/_gen/resources/compute_target_https_proxy.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='compute_target_https_proxy', url='', help='`compute_target_https_proxy` represents the `google_compute_target_https_proxy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google.compute_target_https_proxy.new` injects a new `google_compute_target_https_proxy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.compute_target_https_proxy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_target_https_proxy` using the reference:\n\n $._ref.google_compute_target_https_proxy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_target_https_proxy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map\nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is \u0026#39;//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}\u0026#39;. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `http_keep_alive_timeout_sec` (`number`): Specifies how long to keep a connection open, after completing a response,\nwhile there is no matching traffic (in seconds). If an HTTP keepalive is\nnot specified, a default value (610 seconds) will be used. For Global\nexternal HTTP(S) load balancer, the minimum allowed value is 5 seconds and\nthe maximum allowed value is 1200 seconds. For Global external HTTP(S)\nload balancer (classic), this option is not available publicly. When `null`, the `http_keep_alive_timeout_sec` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: \u0026#34;NONE\u0026#34; Possible values: [\u0026#34;NONE\u0026#34;, \u0026#34;ENABLE\u0026#34;, \u0026#34;DISABLE\u0026#34;] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resource URLs or Certificate Manager certificate URLs that are used to authenticate\nconnections between users and the load balancer. At least one resource must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_target_https_proxy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.compute_target_https_proxy.new` injects a new `google_compute_target_https_proxy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.compute_target_https_proxy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_target_https_proxy` using the reference:\n\n $._ref.google_compute_target_https_proxy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_target_https_proxy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map\nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is \u0026#39;//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}\u0026#39;. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `http_keep_alive_timeout_sec` (`number`): Specifies how long to keep a connection open, after completing a response,\nwhile there is no matching traffic (in seconds). If an HTTP keepalive is\nnot specified, a default value (610 seconds) will be used. For Global\nexternal HTTP(S) load balancer, the minimum allowed value is 5 seconds and\nthe maximum allowed value is 1200 seconds. For Global external HTTP(S)\nload balancer (classic), this option is not available publicly. When `null`, the `http_keep_alive_timeout_sec` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: \u0026#34;NONE\u0026#34; Possible values: [\u0026#34;NONE\u0026#34;, \u0026#34;ENABLE\u0026#34;, \u0026#34;DISABLE\u0026#34;] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `server_tls_policy` (`string`): A URL referring to a networksecurity.ServerTlsPolicy\nresource that describes how the proxy should authenticate inbound\ntraffic. serverTlsPolicy only applies to a global TargetHttpsProxy\nattached to globalForwardingRules with the loadBalancingScheme\nset to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED.\nFor details which ServerTlsPolicy resources are accepted with\nINTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED\nloadBalancingScheme consult ServerTlsPolicy documentation.\nIf left blank, communications are not encrypted. When `null`, the `server_tls_policy` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resource URLs or Certificate Manager certificate URLs that are used to authenticate\nconnections between users and the load balancer. At least one resource must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_target_https_proxy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -13,6 +13,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project=null, proxy_bind=null, quic_override=null, + server_tls_policy=null, ssl_certificates=null, ssl_policy=null, timeouts=null, @@ -28,6 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project=project, proxy_bind=proxy_bind, quic_override=quic_override, + server_tls_policy=server_tls_policy, ssl_certificates=ssl_certificates, ssl_policy=ssl_policy, timeouts=timeouts, @@ -35,7 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.compute_target_https_proxy.newAttrs` constructs a new object with attributes and blocks configured for the `compute_target_https_proxy`\nTerraform resource.\n\nUnlike [google.compute_target_https_proxy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map\nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is '//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}'. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `http_keep_alive_timeout_sec` (`number`): Specifies how long to keep a connection open, after completing a response,\nwhile there is no matching traffic (in seconds). If an HTTP keepalive is\nnot specified, a default value (610 seconds) will be used. For Global\nexternal HTTP(S) load balancer, the minimum allowed value is 5 seconds and\nthe maximum allowed value is 1200 seconds. For Global external HTTP(S)\nload balancer (classic), this option is not available publicly. When `null`, the `http_keep_alive_timeout_sec` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resource URLs or Certificate Manager certificate URLs that are used to authenticate\nconnections between users and the load balancer. At least one resource must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_target_https_proxy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `compute_target_https_proxy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.compute_target_https_proxy.newAttrs` constructs a new object with attributes and blocks configured for the `compute_target_https_proxy`\nTerraform resource.\n\nUnlike [google.compute_target_https_proxy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map\nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is '//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}'. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `http_keep_alive_timeout_sec` (`number`): Specifies how long to keep a connection open, after completing a response,\nwhile there is no matching traffic (in seconds). If an HTTP keepalive is\nnot specified, a default value (610 seconds) will be used. For Global\nexternal HTTP(S) load balancer, the minimum allowed value is 5 seconds and\nthe maximum allowed value is 1200 seconds. For Global external HTTP(S)\nload balancer (classic), this option is not available publicly. When `null`, the `http_keep_alive_timeout_sec` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `server_tls_policy` (`string`): A URL referring to a networksecurity.ServerTlsPolicy\nresource that describes how the proxy should authenticate inbound\ntraffic. serverTlsPolicy only applies to a global TargetHttpsProxy\nattached to globalForwardingRules with the loadBalancingScheme\nset to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED.\nFor details which ServerTlsPolicy resources are accepted with\nINTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED\nloadBalancingScheme consult ServerTlsPolicy documentation.\nIf left blank, communications are not encrypted. When `null`, the `server_tls_policy` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resource URLs or Certificate Manager certificate URLs that are used to authenticate\nconnections between users and the load balancer. At least one resource must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_target_https_proxy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `compute_target_https_proxy` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, url_map, @@ -45,6 +47,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project=null, proxy_bind=null, quic_override=null, + server_tls_policy=null, ssl_certificates=null, ssl_policy=null, timeouts=null @@ -56,6 +59,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project: project, proxy_bind: proxy_bind, quic_override: quic_override, + server_tls_policy: server_tls_policy, ssl_certificates: ssl_certificates, ssl_policy: ssl_policy, timeouts: timeouts, @@ -143,6 +147,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withServerTlsPolicy':: d.fn(help='`google.string.withServerTlsPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the server_tls_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 `server_tls_policy` field.\n', args=[]), + withServerTlsPolicy(resourceLabel, value): { + resource+: { + google_compute_target_https_proxy+: { + [resourceLabel]+: { + server_tls_policy: value, + }, + }, + }, + }, '#withSslCertificates':: d.fn(help='`google.list.withSslCertificates` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the ssl_certificates 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 `ssl_certificates` field.\n', args=[]), withSslCertificates(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/container_aws_node_pool.libsonnet b/4.x/_gen/resources/container_aws_node_pool.libsonnet index 85b9b85c..bf7815fe 100644 --- a/4.x/_gen/resources/container_aws_node_pool.libsonnet +++ b/4.x/_gen/resources/container_aws_node_pool.libsonnet @@ -104,6 +104,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, + management:: { + '#new':: d.fn(help='\n`google.container_aws_node_pool.management.new` constructs a new object with attributes and blocks configured for the `management`\nTerraform sub block.\n\n\n\n**Args**:\n - `auto_repair` (`bool`): Optional. Whether or not the nodes will be automatically repaired. When `null`, the `auto_repair` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `management` sub block.\n', args=[]), + new( + auto_repair=null + ):: std.prune(a={ + auto_repair: auto_repair, + }), + }, max_pods_constraint:: { '#new':: d.fn(help='\n`google.container_aws_node_pool.max_pods_constraint.new` constructs a new object with attributes and blocks configured for the `max_pods_constraint`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_pods_per_node` (`number`): The maximum number of pods to schedule on a single node.\n\n**Returns**:\n - An attribute object that represents the `max_pods_constraint` sub block.\n', args=[]), new( @@ -112,7 +120,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); max_pods_per_node: max_pods_per_node, }), }, - '#new':: d.fn(help="\n`google.container_aws_node_pool.new` injects a new `google_container_aws_node_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.container_aws_node_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_aws_node_pool` using the reference:\n\n $._ref.google_container_aws_node_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_aws_node_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`): Optional. Annotations on the node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key 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 - `cluster` (`string`): The awsCluster for the resource\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 - `subnet_id` (`string`): The subnet where the node pool node run.\n - `version` (`string`): The Kubernetes version to run on this node pool (e.g. `1.19.10-gke.1000`). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.\n - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_aws_node_pool.autoscaling.new](#fn-autoscalingnew) constructor.\n - `config` (`list[obj]`): The configuration of the node pool. When `null`, the `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.container_aws_node_pool.config.new](#fn-confignew) constructor.\n - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_aws_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) 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_aws_node_pool.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_aws_node_pool.new` injects a new `google_container_aws_node_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.container_aws_node_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_aws_node_pool` using the reference:\n\n $._ref.google_container_aws_node_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_aws_node_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`): Optional. Annotations on the node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key 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 - `cluster` (`string`): The awsCluster for the resource\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 - `subnet_id` (`string`): The subnet where the node pool node run.\n - `version` (`string`): The Kubernetes version to run on this node pool (e.g. `1.19.10-gke.1000`). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.\n - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_aws_node_pool.autoscaling.new](#fn-autoscalingnew) constructor.\n - `config` (`list[obj]`): The configuration of the node pool. When `null`, the `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.container_aws_node_pool.config.new](#fn-confignew) constructor.\n - `management` (`list[obj]`): The Management configuration for this node pool. When `null`, the `management` 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_aws_node_pool.management.new](#fn-managementnew) constructor.\n - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_aws_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) 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_aws_node_pool.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, cluster, @@ -123,6 +131,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); annotations=null, autoscaling=null, config=null, + management=null, max_pods_constraint=null, project=null, timeouts=null, @@ -136,6 +145,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cluster=cluster, config=config, location=location, + management=management, max_pods_constraint=max_pods_constraint, name=name, project=project, @@ -145,7 +155,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.container_aws_node_pool.newAttrs` constructs a new object with attributes and blocks configured for the `container_aws_node_pool`\nTerraform resource.\n\nUnlike [google.container_aws_node_pool.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 node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key 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 - `cluster` (`string`): The awsCluster for the resource\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 - `subnet_id` (`string`): The subnet where the node pool node run.\n - `version` (`string`): The Kubernetes version to run on this node pool (e.g. `1.19.10-gke.1000`). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.\n - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_aws_node_pool.autoscaling.new](#fn-autoscalingnew) constructor.\n - `config` (`list[obj]`): The configuration of the node pool. When `null`, the `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.container_aws_node_pool.config.new](#fn-confignew) constructor.\n - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_aws_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) 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_aws_node_pool.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_aws_node_pool` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.container_aws_node_pool.newAttrs` constructs a new object with attributes and blocks configured for the `container_aws_node_pool`\nTerraform resource.\n\nUnlike [google.container_aws_node_pool.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 node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key 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 - `cluster` (`string`): The awsCluster for the resource\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 - `subnet_id` (`string`): The subnet where the node pool node run.\n - `version` (`string`): The Kubernetes version to run on this node pool (e.g. `1.19.10-gke.1000`). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.\n - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_aws_node_pool.autoscaling.new](#fn-autoscalingnew) constructor.\n - `config` (`list[obj]`): The configuration of the node pool. When `null`, the `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.container_aws_node_pool.config.new](#fn-confignew) constructor.\n - `management` (`list[obj]`): The Management configuration for this node pool. When `null`, the `management` 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_aws_node_pool.management.new](#fn-managementnew) constructor.\n - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_aws_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) 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_aws_node_pool.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_aws_node_pool` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster, location, @@ -155,6 +165,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); annotations=null, autoscaling=null, config=null, + management=null, max_pods_constraint=null, project=null, timeouts=null @@ -164,6 +175,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cluster: cluster, config: config, location: location, + management: management, max_pods_constraint: max_pods_constraint, name: name, project: project, @@ -253,6 +265,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withManagement':: d.fn(help='`google.list[obj].withManagement` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the management 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].withManagementMixin](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 `management` field.\n', args=[]), + withManagement(resourceLabel, value): { + resource+: { + google_container_aws_node_pool+: { + [resourceLabel]+: { + management: value, + }, + }, + }, + }, + '#withManagementMixin':: d.fn(help='`google.list[obj].withManagementMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the management 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].withManagement](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 `management` field.\n', args=[]), + withManagementMixin(resourceLabel, value): { + resource+: { + google_container_aws_node_pool+: { + [resourceLabel]+: { + management+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withMaxPodsConstraint':: d.fn(help='`google.list[obj].withMaxPodsConstraint` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the max_pods_constraint 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].withMaxPodsConstraintMixin](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 `max_pods_constraint` field.\n', args=[]), withMaxPodsConstraint(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/container_azure_node_pool.libsonnet b/4.x/_gen/resources/container_azure_node_pool.libsonnet index 522888dc..c4fd5985 100644 --- a/4.x/_gen/resources/container_azure_node_pool.libsonnet +++ b/4.x/_gen/resources/container_azure_node_pool.libsonnet @@ -54,6 +54,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, + management:: { + '#new':: d.fn(help='\n`google.container_azure_node_pool.management.new` constructs a new object with attributes and blocks configured for the `management`\nTerraform sub block.\n\n\n\n**Args**:\n - `auto_repair` (`bool`): Optional. Whether or not the nodes will be automatically repaired. When `null`, the `auto_repair` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `management` sub block.\n', args=[]), + new( + auto_repair=null + ):: std.prune(a={ + auto_repair: auto_repair, + }), + }, max_pods_constraint:: { '#new':: d.fn(help='\n`google.container_azure_node_pool.max_pods_constraint.new` constructs a new object with attributes and blocks configured for the `max_pods_constraint`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_pods_per_node` (`number`): The maximum number of pods to schedule on a single node.\n\n**Returns**:\n - An attribute object that represents the `max_pods_constraint` sub block.\n', args=[]), new( @@ -62,7 +70,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); max_pods_per_node: max_pods_per_node, }), }, - '#new':: d.fn(help="\n`google.container_azure_node_pool.new` injects a new `google_container_azure_node_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.container_azure_node_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_azure_node_pool` using the reference:\n\n $._ref.google_container_azure_node_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_azure_node_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`): Optional. Annotations on the node pool. 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_availability_zone` (`string`): Optional. The Azure availability zone of the nodes in this nodepool. When unspecified, it defaults to `1`. When `null`, the `azure_availability_zone` field will be omitted from the resulting object.\n - `cluster` (`string`): The azureCluster for the resource\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 - `subnet_id` (`string`): The ARM ID of the subnet where the node pool VMs run. Make sure it\u0026#39;s a subnet under the virtual network in the cluster configuration.\n - `version` (`string`): The Kubernetes version (e.g. `1.19.10-gke.1000`) running on this node pool.\n - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_node_pool.autoscaling.new](#fn-autoscalingnew) constructor.\n - `config` (`list[obj]`): The node configuration of the node pool. When `null`, the `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.container_azure_node_pool.config.new](#fn-confignew) constructor.\n - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) 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_node_pool.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_node_pool.new` injects a new `google_container_azure_node_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.container_azure_node_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_azure_node_pool` using the reference:\n\n $._ref.google_container_azure_node_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_azure_node_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`): Optional. Annotations on the node pool. 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_availability_zone` (`string`): Optional. The Azure availability zone of the nodes in this nodepool. When unspecified, it defaults to `1`. When `null`, the `azure_availability_zone` field will be omitted from the resulting object.\n - `cluster` (`string`): The azureCluster for the resource\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 - `subnet_id` (`string`): The ARM ID of the subnet where the node pool VMs run. Make sure it\u0026#39;s a subnet under the virtual network in the cluster configuration.\n - `version` (`string`): The Kubernetes version (e.g. `1.19.10-gke.1000`) running on this node pool.\n - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_node_pool.autoscaling.new](#fn-autoscalingnew) constructor.\n - `config` (`list[obj]`): The node configuration of the node pool. When `null`, the `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.container_azure_node_pool.config.new](#fn-confignew) constructor.\n - `management` (`list[obj]`): The Management configuration for this node pool. When `null`, the `management` 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_node_pool.management.new](#fn-managementnew) constructor.\n - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) 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_node_pool.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, cluster, @@ -74,6 +82,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); autoscaling=null, azure_availability_zone=null, config=null, + management=null, max_pods_constraint=null, project=null, timeouts=null, @@ -88,6 +97,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cluster=cluster, config=config, location=location, + management=management, max_pods_constraint=max_pods_constraint, name=name, project=project, @@ -97,7 +107,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.container_azure_node_pool.newAttrs` constructs a new object with attributes and blocks configured for the `container_azure_node_pool`\nTerraform resource.\n\nUnlike [google.container_azure_node_pool.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 node pool. 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_availability_zone` (`string`): Optional. The Azure availability zone of the nodes in this nodepool. When unspecified, it defaults to `1`. When `null`, the `azure_availability_zone` field will be omitted from the resulting object.\n - `cluster` (`string`): The azureCluster for the resource\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 - `subnet_id` (`string`): The ARM ID of the subnet where the node pool VMs run. Make sure it's a subnet under the virtual network in the cluster configuration.\n - `version` (`string`): The Kubernetes version (e.g. `1.19.10-gke.1000`) running on this node pool.\n - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_node_pool.autoscaling.new](#fn-autoscalingnew) constructor.\n - `config` (`list[obj]`): The node configuration of the node pool. When `null`, the `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.container_azure_node_pool.config.new](#fn-confignew) constructor.\n - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) 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_node_pool.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_node_pool` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.container_azure_node_pool.newAttrs` constructs a new object with attributes and blocks configured for the `container_azure_node_pool`\nTerraform resource.\n\nUnlike [google.container_azure_node_pool.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 node pool. 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_availability_zone` (`string`): Optional. The Azure availability zone of the nodes in this nodepool. When unspecified, it defaults to `1`. When `null`, the `azure_availability_zone` field will be omitted from the resulting object.\n - `cluster` (`string`): The azureCluster for the resource\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 - `subnet_id` (`string`): The ARM ID of the subnet where the node pool VMs run. Make sure it's a subnet under the virtual network in the cluster configuration.\n - `version` (`string`): The Kubernetes version (e.g. `1.19.10-gke.1000`) running on this node pool.\n - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_node_pool.autoscaling.new](#fn-autoscalingnew) constructor.\n - `config` (`list[obj]`): The node configuration of the node pool. When `null`, the `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.container_azure_node_pool.config.new](#fn-confignew) constructor.\n - `management` (`list[obj]`): The Management configuration for this node pool. When `null`, the `management` 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_node_pool.management.new](#fn-managementnew) constructor.\n - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) 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_node_pool.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_node_pool` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster, location, @@ -108,6 +118,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); autoscaling=null, azure_availability_zone=null, config=null, + management=null, max_pods_constraint=null, project=null, timeouts=null @@ -118,6 +129,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cluster: cluster, config: config, location: location, + management: management, max_pods_constraint: max_pods_constraint, name: name, project: project, @@ -217,6 +229,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withManagement':: d.fn(help='`google.list[obj].withManagement` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the management 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].withManagementMixin](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 `management` field.\n', args=[]), + withManagement(resourceLabel, value): { + resource+: { + google_container_azure_node_pool+: { + [resourceLabel]+: { + management: value, + }, + }, + }, + }, + '#withManagementMixin':: d.fn(help='`google.list[obj].withManagementMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the management 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].withManagement](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 `management` field.\n', args=[]), + withManagementMixin(resourceLabel, value): { + resource+: { + google_container_azure_node_pool+: { + [resourceLabel]+: { + management+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withMaxPodsConstraint':: d.fn(help='`google.list[obj].withMaxPodsConstraint` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the max_pods_constraint 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].withMaxPodsConstraintMixin](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 `max_pods_constraint` field.\n', args=[]), withMaxPodsConstraint(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/container_cluster.libsonnet b/4.x/_gen/resources/container_cluster.libsonnet index 7c88ed29..06807bdc 100644 --- a/4.x/_gen/resources/container_cluster.libsonnet +++ b/4.x/_gen/resources/container_cluster.libsonnet @@ -478,7 +478,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); provider: provider, }), }, - '#new':: d.fn(help="\n`google.container_cluster.new` injects a new `google_container_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_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_cluster` using the reference:\n\n $._ref.google_container_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_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 - `allow_net_admin` (`bool`): Enable NET_ADMIN for this cluster. When `null`, the `allow_net_admin` field will be omitted from the resulting object.\n - `cluster_ipv4_cidr` (`string`): The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8. This field will only work for routes-based clusters, where ip_allocation_policy is not defined. When `null`, the `cluster_ipv4_cidr` field will be omitted from the resulting object.\n - `datapath_provider` (`string`): The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. When `null`, the `datapath_provider` field will be omitted from the resulting object.\n - `default_max_pods_per_node` (`number`): The default maximum number of pods per node in this cluster. This doesn\u0026#39;t work on \u0026#34;routes-based\u0026#34; clusters, clusters that don\u0026#39;t have IP Aliasing enabled. When `null`, the `default_max_pods_per_node` field will be omitted from the resulting object.\n - `description` (`string`): Description of the cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_autopilot` (`bool`): Enable Autopilot for this cluster. When `null`, the `enable_autopilot` field will be omitted from the resulting object.\n - `enable_binary_authorization` (`bool`): Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binary Authorization. When `null`, the `enable_binary_authorization` field will be omitted from the resulting object.\n - `enable_intranode_visibility` (`bool`): Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. When `null`, the `enable_intranode_visibility` field will be omitted from the resulting object.\n - `enable_kubernetes_alpha` (`bool`): Whether to enable Kubernetes Alpha features for this cluster. Note that when this option is enabled, the cluster cannot be upgraded and will be automatically deleted after 30 days. When `null`, the `enable_kubernetes_alpha` field will be omitted from the resulting object.\n - `enable_l4_ilb_subsetting` (`bool`): Whether L4ILB Subsetting is enabled for this cluster. When `null`, the `enable_l4_ilb_subsetting` field will be omitted from the resulting object.\n - `enable_legacy_abac` (`bool`): Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. Defaults to false. When `null`, the `enable_legacy_abac` field will be omitted from the resulting object.\n - `enable_shielded_nodes` (`bool`): Enable Shielded Nodes features on all nodes in this cluster. Defaults to true. When `null`, the `enable_shielded_nodes` field will be omitted from the resulting object.\n - `enable_tpu` (`bool`): Whether to enable Cloud TPU resources in this cluster. When `null`, the `enable_tpu` field will be omitted from the resulting object.\n - `initial_node_count` (`number`): The number of nodes to create in this cluster\u0026#39;s default node pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Must be set if node_pool is not set. If you\u0026#39;re using google_container_node_pool objects with no default node pool, you\u0026#39;ll need to set this to a value of at least 1, alongside setting remove_default_node_pool to true. When `null`, the `initial_node_count` field will be omitted from the resulting object.\n - `location` (`string`): The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well. When `null`, the `location` field will be omitted from the resulting object.\n - `logging_service` (`string`): The logging service that the cluster should write logs to. Available options include logging.googleapis.com(Legacy Stackdriver), logging.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Logging), and none. Defaults to logging.googleapis.com/kubernetes. When `null`, the `logging_service` field will be omitted from the resulting object.\n - `min_master_version` (`string`): The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the current master version--use the read-only master_version field to obtain that. If unset, the cluster\u0026#39;s version will be set by GKE to the version of the most recent official release (which is not necessarily the latest version). When `null`, the `min_master_version` field will be omitted from the resulting object.\n - `monitoring_service` (`string`): The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com(Legacy Stackdriver), monitoring.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Monitoring), and none. Defaults to monitoring.googleapis.com/kubernetes. When `null`, the `monitoring_service` field will be omitted from the resulting object.\n - `name` (`string`): The name of the cluster, unique within the project and location.\n - `network` (`string`): The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. When `null`, the `network` field will be omitted from the resulting object.\n - `networking_mode` (`string`): Determines whether alias IPs or routes will be used for pod IPs in the cluster. When `null`, the `networking_mode` field will be omitted from the resulting object.\n - `node_locations` (`list`): The list of zones in which the cluster\u0026#39;s nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster\u0026#39;s zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster\u0026#39;s zone. When `null`, the `node_locations` field will be omitted from the resulting object.\n - `node_version` (`string`): The Kubernetes version on the nodes. Must either be unset or set to the same value as min_master_version on create. Defaults to the default version set by GKE which is not necessarily the latest version. This only affects nodes in the default node pool. While a fuzzy version can be specified, it\u0026#39;s recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source\u0026#39;s version_prefix field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the version attribute on the node pool. When `null`, the `node_version` field will be omitted from the resulting object.\n - `private_ipv6_google_access` (`string`): The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4). When `null`, the `private_ipv6_google_access` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `remove_default_node_pool` (`bool`): If true, deletes the default node pool upon cluster creation. If you\u0026#39;re using google_container_node_pool resources with no default node pool, this should be set to true, alongside setting initial_node_count to at least 1. When `null`, the `remove_default_node_pool` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the cluster. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The name or self_link of the Google Compute Engine subnetwork in which the cluster\u0026#39;s instances are launched. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `addons_config` (`list[obj]`): The configuration for addons supported by GKE. When `null`, the `addons_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.container_cluster.addons_config.new](#fn-addons_confignew) constructor.\n - `authenticator_groups_config` (`list[obj]`): Configuration for the Google Groups for GKE feature. When `null`, the `authenticator_groups_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.container_cluster.authenticator_groups_config.new](#fn-authenticator_groups_confignew) constructor.\n - `binary_authorization` (`list[obj]`): Configuration options for the Binary Authorization feature. When `null`, the `binary_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_cluster.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `cluster_autoscaling` (`list[obj]`): Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster\u0026#39;s workload. See the guide to using Node Auto-Provisioning for more details. When `null`, the `cluster_autoscaling` 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_cluster.cluster_autoscaling.new](#fn-cluster_autoscalingnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can\u0026#39;t be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. When `null`, the `confidential_nodes` 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_cluster.confidential_nodes.new](#fn-confidential_nodesnew) constructor.\n - `cost_management_config` (`list[obj]`): Cost management configuration for the cluster. When `null`, the `cost_management_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.container_cluster.cost_management_config.new](#fn-cost_management_confignew) constructor.\n - `database_encryption` (`list[obj]`): Application-layer Secrets Encryption settings. The object format is {state = string, key_name = string}. Valid values of state are: \u0026#34;ENCRYPTED\u0026#34;; \u0026#34;DECRYPTED\u0026#34;. key_name is the name of a CloudKMS key. When `null`, the `database_encryption` 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_cluster.database_encryption.new](#fn-database_encryptionnew) constructor.\n - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` 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_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor.\n - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_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.container_cluster.dns_config.new](#fn-dns_confignew) constructor.\n - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` 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_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor.\n - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_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.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor.\n - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor.\n - `logging_config` (`list[obj]`): Logging configuration for the cluster. When `null`, the `logging_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.container_cluster.logging_config.new](#fn-logging_confignew) constructor.\n - `maintenance_policy` (`list[obj]`): The maintenance policy to use for the cluster. When `null`, the `maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.maintenance_policy.new](#fn-maintenance_policynew) constructor.\n - `master_auth` (`list[obj]`): The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. When `null`, the `master_auth` 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_cluster.master_auth.new](#fn-master_authnew) constructor.\n - `master_authorized_networks_config` (`list[obj]`): The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). When `null`, the `master_authorized_networks_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.container_cluster.master_authorized_networks_config.new](#fn-master_authorized_networks_confignew) constructor.\n - `mesh_certificates` (`list[obj]`): If set, and enable_certificates=true, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster. When `null`, the `mesh_certificates` 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_cluster.mesh_certificates.new](#fn-mesh_certificatesnew) constructor.\n - `monitoring_config` (`list[obj]`): Monitoring configuration for the cluster. When `null`, the `monitoring_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.container_cluster.monitoring_config.new](#fn-monitoring_confignew) constructor.\n - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor.\n - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_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.container_cluster.node_config.new](#fn-node_confignew) constructor.\n - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can\u0026#39;t be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say \u0026#34;these are the only node pools associated with this cluster\u0026#34;, use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` 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_cluster.node_pool.new](#fn-node_poolnew) constructor.\n - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` 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_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor.\n - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_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.container_cluster.notification_config.new](#fn-notification_confignew) constructor.\n - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_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.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor.\n - `release_channel` (`list[obj]`): Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. Note that removing this field from your config will not unenroll it. Instead, use the \u0026#34;UNSPECIFIED\u0026#34; channel. When `null`, the `release_channel` 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_cluster.release_channel.new](#fn-release_channelnew) constructor.\n - `resource_usage_export_config` (`list[obj]`): Configuration for the ResourceUsageExportConfig feature. When `null`, the `resource_usage_export_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.container_cluster.resource_usage_export_config.new](#fn-resource_usage_export_confignew) constructor.\n - `security_posture_config` (`list[obj]`): Defines the config needed to enable/disable features for the Security Posture API When `null`, the `security_posture_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.container_cluster.security_posture_config.new](#fn-security_posture_confignew) constructor.\n - `service_external_ips_config` (`list[obj]`): If set, and enabled=true, services with external ips field will not be blocked When `null`, the `service_external_ips_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.container_cluster.service_external_ips_config.new](#fn-service_external_ips_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.container_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n - `vertical_pod_autoscaling` (`list[obj]`): Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. When `null`, the `vertical_pod_autoscaling` 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_cluster.vertical_pod_autoscaling.new](#fn-vertical_pod_autoscalingnew) constructor.\n - `workload_identity_config` (`list[obj]`): Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. When `null`, the `workload_identity_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.container_cluster.workload_identity_config.new](#fn-workload_identity_confignew) 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_cluster.new` injects a new `google_container_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_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_cluster` using the reference:\n\n $._ref.google_container_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_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 - `allow_net_admin` (`bool`): Enable NET_ADMIN for this cluster. When `null`, the `allow_net_admin` field will be omitted from the resulting object.\n - `cluster_ipv4_cidr` (`string`): The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8. This field will only work for routes-based clusters, where ip_allocation_policy is not defined. When `null`, the `cluster_ipv4_cidr` field will be omitted from the resulting object.\n - `datapath_provider` (`string`): The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. When `null`, the `datapath_provider` field will be omitted from the resulting object.\n - `default_max_pods_per_node` (`number`): The default maximum number of pods per node in this cluster. This doesn\u0026#39;t work on \u0026#34;routes-based\u0026#34; clusters, clusters that don\u0026#39;t have IP Aliasing enabled. When `null`, the `default_max_pods_per_node` field will be omitted from the resulting object.\n - `description` (`string`): Description of the cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_autopilot` (`bool`): Enable Autopilot for this cluster. When `null`, the `enable_autopilot` field will be omitted from the resulting object.\n - `enable_binary_authorization` (`bool`): Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binary Authorization. When `null`, the `enable_binary_authorization` field will be omitted from the resulting object.\n - `enable_intranode_visibility` (`bool`): Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. When `null`, the `enable_intranode_visibility` field will be omitted from the resulting object.\n - `enable_kubernetes_alpha` (`bool`): Whether to enable Kubernetes Alpha features for this cluster. Note that when this option is enabled, the cluster cannot be upgraded and will be automatically deleted after 30 days. When `null`, the `enable_kubernetes_alpha` field will be omitted from the resulting object.\n - `enable_l4_ilb_subsetting` (`bool`): Whether L4ILB Subsetting is enabled for this cluster. When `null`, the `enable_l4_ilb_subsetting` field will be omitted from the resulting object.\n - `enable_legacy_abac` (`bool`): Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. Defaults to false. When `null`, the `enable_legacy_abac` field will be omitted from the resulting object.\n - `enable_shielded_nodes` (`bool`): Enable Shielded Nodes features on all nodes in this cluster. Defaults to true. When `null`, the `enable_shielded_nodes` field will be omitted from the resulting object.\n - `enable_tpu` (`bool`): Whether to enable Cloud TPU resources in this cluster. When `null`, the `enable_tpu` field will be omitted from the resulting object.\n - `initial_node_count` (`number`): The number of nodes to create in this cluster\u0026#39;s default node pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Must be set if node_pool is not set. If you\u0026#39;re using google_container_node_pool objects with no default node pool, you\u0026#39;ll need to set this to a value of at least 1, alongside setting remove_default_node_pool to true. When `null`, the `initial_node_count` field will be omitted from the resulting object.\n - `location` (`string`): The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well. When `null`, the `location` field will be omitted from the resulting object.\n - `logging_service` (`string`): The logging service that the cluster should write logs to. Available options include logging.googleapis.com(Legacy Stackdriver), logging.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Logging), and none. Defaults to logging.googleapis.com/kubernetes. When `null`, the `logging_service` field will be omitted from the resulting object.\n - `min_master_version` (`string`): The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the current master version--use the read-only master_version field to obtain that. If unset, the cluster\u0026#39;s version will be set by GKE to the version of the most recent official release (which is not necessarily the latest version). When `null`, the `min_master_version` field will be omitted from the resulting object.\n - `monitoring_service` (`string`): The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com(Legacy Stackdriver), monitoring.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Monitoring), and none. Defaults to monitoring.googleapis.com/kubernetes. When `null`, the `monitoring_service` field will be omitted from the resulting object.\n - `name` (`string`): The name of the cluster, unique within the project and location.\n - `network` (`string`): The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. When `null`, the `network` field will be omitted from the resulting object.\n - `networking_mode` (`string`): Determines whether alias IPs or routes will be used for pod IPs in the cluster. When `null`, the `networking_mode` field will be omitted from the resulting object.\n - `node_locations` (`list`): The list of zones in which the cluster\u0026#39;s nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster\u0026#39;s zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster\u0026#39;s zone. When `null`, the `node_locations` field will be omitted from the resulting object.\n - `node_version` (`string`): The Kubernetes version on the nodes. Must either be unset or set to the same value as min_master_version on create. Defaults to the default version set by GKE which is not necessarily the latest version. This only affects nodes in the default node pool. While a fuzzy version can be specified, it\u0026#39;s recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source\u0026#39;s version_prefix field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the version attribute on the node pool. When `null`, the `node_version` field will be omitted from the resulting object.\n - `private_ipv6_google_access` (`string`): The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4). When `null`, the `private_ipv6_google_access` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `remove_default_node_pool` (`bool`): If true, deletes the default node pool upon cluster creation. If you\u0026#39;re using google_container_node_pool resources with no default node pool, this should be set to true, alongside setting initial_node_count to at least 1. When `null`, the `remove_default_node_pool` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the cluster. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The name or self_link of the Google Compute Engine subnetwork in which the cluster\u0026#39;s instances are launched. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `addons_config` (`list[obj]`): The configuration for addons supported by GKE. When `null`, the `addons_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.container_cluster.addons_config.new](#fn-addons_confignew) constructor.\n - `authenticator_groups_config` (`list[obj]`): Configuration for the Google Groups for GKE feature. When `null`, the `authenticator_groups_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.container_cluster.authenticator_groups_config.new](#fn-authenticator_groups_confignew) constructor.\n - `binary_authorization` (`list[obj]`): Configuration options for the Binary Authorization feature. When `null`, the `binary_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_cluster.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `cluster_autoscaling` (`list[obj]`): Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster\u0026#39;s workload. See the guide to using Node Auto-Provisioning for more details. When `null`, the `cluster_autoscaling` 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_cluster.cluster_autoscaling.new](#fn-cluster_autoscalingnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can\u0026#39;t be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. When `null`, the `confidential_nodes` 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_cluster.confidential_nodes.new](#fn-confidential_nodesnew) constructor.\n - `cost_management_config` (`list[obj]`): Cost management configuration for the cluster. When `null`, the `cost_management_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.container_cluster.cost_management_config.new](#fn-cost_management_confignew) constructor.\n - `database_encryption` (`list[obj]`): Application-layer Secrets Encryption settings. The object format is {state = string, key_name = string}. Valid values of state are: \u0026#34;ENCRYPTED\u0026#34;; \u0026#34;DECRYPTED\u0026#34;. key_name is the name of a CloudKMS key. When `null`, the `database_encryption` 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_cluster.database_encryption.new](#fn-database_encryptionnew) constructor.\n - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` 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_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor.\n - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_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.container_cluster.dns_config.new](#fn-dns_confignew) constructor.\n - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` 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_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor.\n - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_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.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor.\n - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor.\n - `logging_config` (`list[obj]`): Logging configuration for the cluster. When `null`, the `logging_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.container_cluster.logging_config.new](#fn-logging_confignew) constructor.\n - `maintenance_policy` (`list[obj]`): The maintenance policy to use for the cluster. When `null`, the `maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.maintenance_policy.new](#fn-maintenance_policynew) constructor.\n - `master_auth` (`list[obj]`): The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. When `null`, the `master_auth` 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_cluster.master_auth.new](#fn-master_authnew) constructor.\n - `master_authorized_networks_config` (`list[obj]`): The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). When `null`, the `master_authorized_networks_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.container_cluster.master_authorized_networks_config.new](#fn-master_authorized_networks_confignew) constructor.\n - `mesh_certificates` (`list[obj]`): If set, and enable_certificates=true, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster. When `null`, the `mesh_certificates` 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_cluster.mesh_certificates.new](#fn-mesh_certificatesnew) constructor.\n - `monitoring_config` (`list[obj]`): Monitoring configuration for the cluster. When `null`, the `monitoring_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.container_cluster.monitoring_config.new](#fn-monitoring_confignew) constructor.\n - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor.\n - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_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.container_cluster.node_config.new](#fn-node_confignew) constructor.\n - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can\u0026#39;t be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say \u0026#34;these are the only node pools associated with this cluster\u0026#34;, use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` 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_cluster.node_pool.new](#fn-node_poolnew) constructor.\n - `node_pool_auto_config` (`list[obj]`): Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. When `null`, the `node_pool_auto_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.container_cluster.node_pool_auto_config.new](#fn-node_pool_auto_confignew) constructor.\n - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` 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_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor.\n - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_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.container_cluster.notification_config.new](#fn-notification_confignew) constructor.\n - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_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.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor.\n - `release_channel` (`list[obj]`): Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. Note that removing this field from your config will not unenroll it. Instead, use the \u0026#34;UNSPECIFIED\u0026#34; channel. When `null`, the `release_channel` 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_cluster.release_channel.new](#fn-release_channelnew) constructor.\n - `resource_usage_export_config` (`list[obj]`): Configuration for the ResourceUsageExportConfig feature. When `null`, the `resource_usage_export_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.container_cluster.resource_usage_export_config.new](#fn-resource_usage_export_confignew) constructor.\n - `security_posture_config` (`list[obj]`): Defines the config needed to enable/disable features for the Security Posture API When `null`, the `security_posture_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.container_cluster.security_posture_config.new](#fn-security_posture_confignew) constructor.\n - `service_external_ips_config` (`list[obj]`): If set, and enabled=true, services with external ips field will not be blocked When `null`, the `service_external_ips_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.container_cluster.service_external_ips_config.new](#fn-service_external_ips_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.container_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n - `vertical_pod_autoscaling` (`list[obj]`): Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. When `null`, the `vertical_pod_autoscaling` 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_cluster.vertical_pod_autoscaling.new](#fn-vertical_pod_autoscalingnew) constructor.\n - `workload_identity_config` (`list[obj]`): Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. When `null`, the `workload_identity_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.container_cluster.workload_identity_config.new](#fn-workload_identity_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -524,6 +524,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); node_config=null, node_locations=null, node_pool=null, + node_pool_auto_config=null, node_pool_defaults=null, node_version=null, notification_config=null, @@ -588,6 +589,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); node_config=node_config, node_locations=node_locations, node_pool=node_pool, + node_pool_auto_config=node_pool_auto_config, node_pool_defaults=node_pool_defaults, node_version=node_version, notification_config=notification_config, @@ -607,7 +609,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.container_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `container_cluster`\nTerraform resource.\n\nUnlike [google.container_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 - `allow_net_admin` (`bool`): Enable NET_ADMIN for this cluster. When `null`, the `allow_net_admin` field will be omitted from the resulting object.\n - `cluster_ipv4_cidr` (`string`): The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8. This field will only work for routes-based clusters, where ip_allocation_policy is not defined. When `null`, the `cluster_ipv4_cidr` field will be omitted from the resulting object.\n - `datapath_provider` (`string`): The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. When `null`, the `datapath_provider` field will be omitted from the resulting object.\n - `default_max_pods_per_node` (`number`): The default maximum number of pods per node in this cluster. This doesn't work on "routes-based" clusters, clusters that don't have IP Aliasing enabled. When `null`, the `default_max_pods_per_node` field will be omitted from the resulting object.\n - `description` (`string`): Description of the cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_autopilot` (`bool`): Enable Autopilot for this cluster. When `null`, the `enable_autopilot` field will be omitted from the resulting object.\n - `enable_binary_authorization` (`bool`): Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binary Authorization. When `null`, the `enable_binary_authorization` field will be omitted from the resulting object.\n - `enable_intranode_visibility` (`bool`): Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. When `null`, the `enable_intranode_visibility` field will be omitted from the resulting object.\n - `enable_kubernetes_alpha` (`bool`): Whether to enable Kubernetes Alpha features for this cluster. Note that when this option is enabled, the cluster cannot be upgraded and will be automatically deleted after 30 days. When `null`, the `enable_kubernetes_alpha` field will be omitted from the resulting object.\n - `enable_l4_ilb_subsetting` (`bool`): Whether L4ILB Subsetting is enabled for this cluster. When `null`, the `enable_l4_ilb_subsetting` field will be omitted from the resulting object.\n - `enable_legacy_abac` (`bool`): Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. Defaults to false. When `null`, the `enable_legacy_abac` field will be omitted from the resulting object.\n - `enable_shielded_nodes` (`bool`): Enable Shielded Nodes features on all nodes in this cluster. Defaults to true. When `null`, the `enable_shielded_nodes` field will be omitted from the resulting object.\n - `enable_tpu` (`bool`): Whether to enable Cloud TPU resources in this cluster. When `null`, the `enable_tpu` field will be omitted from the resulting object.\n - `initial_node_count` (`number`): The number of nodes to create in this cluster's default node pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Must be set if node_pool is not set. If you're using google_container_node_pool objects with no default node pool, you'll need to set this to a value of at least 1, alongside setting remove_default_node_pool to true. When `null`, the `initial_node_count` field will be omitted from the resulting object.\n - `location` (`string`): The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well. When `null`, the `location` field will be omitted from the resulting object.\n - `logging_service` (`string`): The logging service that the cluster should write logs to. Available options include logging.googleapis.com(Legacy Stackdriver), logging.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Logging), and none. Defaults to logging.googleapis.com/kubernetes. When `null`, the `logging_service` field will be omitted from the resulting object.\n - `min_master_version` (`string`): The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the current master version--use the read-only master_version field to obtain that. If unset, the cluster's version will be set by GKE to the version of the most recent official release (which is not necessarily the latest version). When `null`, the `min_master_version` field will be omitted from the resulting object.\n - `monitoring_service` (`string`): The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com(Legacy Stackdriver), monitoring.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Monitoring), and none. Defaults to monitoring.googleapis.com/kubernetes. When `null`, the `monitoring_service` field will be omitted from the resulting object.\n - `name` (`string`): The name of the cluster, unique within the project and location.\n - `network` (`string`): The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. When `null`, the `network` field will be omitted from the resulting object.\n - `networking_mode` (`string`): Determines whether alias IPs or routes will be used for pod IPs in the cluster. When `null`, the `networking_mode` field will be omitted from the resulting object.\n - `node_locations` (`list`): The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster's zone. When `null`, the `node_locations` field will be omitted from the resulting object.\n - `node_version` (`string`): The Kubernetes version on the nodes. Must either be unset or set to the same value as min_master_version on create. Defaults to the default version set by GKE which is not necessarily the latest version. This only affects nodes in the default node pool. While a fuzzy version can be specified, it's recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source's version_prefix field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the version attribute on the node pool. When `null`, the `node_version` field will be omitted from the resulting object.\n - `private_ipv6_google_access` (`string`): The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4). When `null`, the `private_ipv6_google_access` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `remove_default_node_pool` (`bool`): If true, deletes the default node pool upon cluster creation. If you're using google_container_node_pool resources with no default node pool, this should be set to true, alongside setting initial_node_count to at least 1. When `null`, the `remove_default_node_pool` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the cluster. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The name or self_link of the Google Compute Engine subnetwork in which the cluster's instances are launched. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `addons_config` (`list[obj]`): The configuration for addons supported by GKE. When `null`, the `addons_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.container_cluster.addons_config.new](#fn-addons_confignew) constructor.\n - `authenticator_groups_config` (`list[obj]`): Configuration for the Google Groups for GKE feature. When `null`, the `authenticator_groups_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.container_cluster.authenticator_groups_config.new](#fn-authenticator_groups_confignew) constructor.\n - `binary_authorization` (`list[obj]`): Configuration options for the Binary Authorization feature. When `null`, the `binary_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_cluster.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `cluster_autoscaling` (`list[obj]`): Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster's workload. See the guide to using Node Auto-Provisioning for more details. When `null`, the `cluster_autoscaling` 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_cluster.cluster_autoscaling.new](#fn-cluster_autoscalingnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. When `null`, the `confidential_nodes` 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_cluster.confidential_nodes.new](#fn-confidential_nodesnew) constructor.\n - `cost_management_config` (`list[obj]`): Cost management configuration for the cluster. When `null`, the `cost_management_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.container_cluster.cost_management_config.new](#fn-cost_management_confignew) constructor.\n - `database_encryption` (`list[obj]`): Application-layer Secrets Encryption settings. The object format is {state = string, key_name = string}. Valid values of state are: "ENCRYPTED"; "DECRYPTED". key_name is the name of a CloudKMS key. When `null`, the `database_encryption` 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_cluster.database_encryption.new](#fn-database_encryptionnew) constructor.\n - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` 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_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor.\n - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_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.container_cluster.dns_config.new](#fn-dns_confignew) constructor.\n - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` 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_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor.\n - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_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.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor.\n - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor.\n - `logging_config` (`list[obj]`): Logging configuration for the cluster. When `null`, the `logging_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.container_cluster.logging_config.new](#fn-logging_confignew) constructor.\n - `maintenance_policy` (`list[obj]`): The maintenance policy to use for the cluster. When `null`, the `maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.maintenance_policy.new](#fn-maintenance_policynew) constructor.\n - `master_auth` (`list[obj]`): The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. When `null`, the `master_auth` 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_cluster.master_auth.new](#fn-master_authnew) constructor.\n - `master_authorized_networks_config` (`list[obj]`): The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). When `null`, the `master_authorized_networks_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.container_cluster.master_authorized_networks_config.new](#fn-master_authorized_networks_confignew) constructor.\n - `mesh_certificates` (`list[obj]`): If set, and enable_certificates=true, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster. When `null`, the `mesh_certificates` 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_cluster.mesh_certificates.new](#fn-mesh_certificatesnew) constructor.\n - `monitoring_config` (`list[obj]`): Monitoring configuration for the cluster. When `null`, the `monitoring_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.container_cluster.monitoring_config.new](#fn-monitoring_confignew) constructor.\n - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor.\n - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_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.container_cluster.node_config.new](#fn-node_confignew) constructor.\n - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say "these are the only node pools associated with this cluster", use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` 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_cluster.node_pool.new](#fn-node_poolnew) constructor.\n - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` 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_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor.\n - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_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.container_cluster.notification_config.new](#fn-notification_confignew) constructor.\n - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_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.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor.\n - `release_channel` (`list[obj]`): Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. Note that removing this field from your config will not unenroll it. Instead, use the "UNSPECIFIED" channel. When `null`, the `release_channel` 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_cluster.release_channel.new](#fn-release_channelnew) constructor.\n - `resource_usage_export_config` (`list[obj]`): Configuration for the ResourceUsageExportConfig feature. When `null`, the `resource_usage_export_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.container_cluster.resource_usage_export_config.new](#fn-resource_usage_export_confignew) constructor.\n - `security_posture_config` (`list[obj]`): Defines the config needed to enable/disable features for the Security Posture API When `null`, the `security_posture_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.container_cluster.security_posture_config.new](#fn-security_posture_confignew) constructor.\n - `service_external_ips_config` (`list[obj]`): If set, and enabled=true, services with external ips field will not be blocked When `null`, the `service_external_ips_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.container_cluster.service_external_ips_config.new](#fn-service_external_ips_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n - `vertical_pod_autoscaling` (`list[obj]`): Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. When `null`, the `vertical_pod_autoscaling` 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_cluster.vertical_pod_autoscaling.new](#fn-vertical_pod_autoscalingnew) constructor.\n - `workload_identity_config` (`list[obj]`): Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. When `null`, the `workload_identity_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.container_cluster.workload_identity_config.new](#fn-workload_identity_confignew) 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_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.container_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `container_cluster`\nTerraform resource.\n\nUnlike [google.container_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 - `allow_net_admin` (`bool`): Enable NET_ADMIN for this cluster. When `null`, the `allow_net_admin` field will be omitted from the resulting object.\n - `cluster_ipv4_cidr` (`string`): The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8. This field will only work for routes-based clusters, where ip_allocation_policy is not defined. When `null`, the `cluster_ipv4_cidr` field will be omitted from the resulting object.\n - `datapath_provider` (`string`): The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. When `null`, the `datapath_provider` field will be omitted from the resulting object.\n - `default_max_pods_per_node` (`number`): The default maximum number of pods per node in this cluster. This doesn't work on "routes-based" clusters, clusters that don't have IP Aliasing enabled. When `null`, the `default_max_pods_per_node` field will be omitted from the resulting object.\n - `description` (`string`): Description of the cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_autopilot` (`bool`): Enable Autopilot for this cluster. When `null`, the `enable_autopilot` field will be omitted from the resulting object.\n - `enable_binary_authorization` (`bool`): Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binary Authorization. When `null`, the `enable_binary_authorization` field will be omitted from the resulting object.\n - `enable_intranode_visibility` (`bool`): Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. When `null`, the `enable_intranode_visibility` field will be omitted from the resulting object.\n - `enable_kubernetes_alpha` (`bool`): Whether to enable Kubernetes Alpha features for this cluster. Note that when this option is enabled, the cluster cannot be upgraded and will be automatically deleted after 30 days. When `null`, the `enable_kubernetes_alpha` field will be omitted from the resulting object.\n - `enable_l4_ilb_subsetting` (`bool`): Whether L4ILB Subsetting is enabled for this cluster. When `null`, the `enable_l4_ilb_subsetting` field will be omitted from the resulting object.\n - `enable_legacy_abac` (`bool`): Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. Defaults to false. When `null`, the `enable_legacy_abac` field will be omitted from the resulting object.\n - `enable_shielded_nodes` (`bool`): Enable Shielded Nodes features on all nodes in this cluster. Defaults to true. When `null`, the `enable_shielded_nodes` field will be omitted from the resulting object.\n - `enable_tpu` (`bool`): Whether to enable Cloud TPU resources in this cluster. When `null`, the `enable_tpu` field will be omitted from the resulting object.\n - `initial_node_count` (`number`): The number of nodes to create in this cluster's default node pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Must be set if node_pool is not set. If you're using google_container_node_pool objects with no default node pool, you'll need to set this to a value of at least 1, alongside setting remove_default_node_pool to true. When `null`, the `initial_node_count` field will be omitted from the resulting object.\n - `location` (`string`): The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well. When `null`, the `location` field will be omitted from the resulting object.\n - `logging_service` (`string`): The logging service that the cluster should write logs to. Available options include logging.googleapis.com(Legacy Stackdriver), logging.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Logging), and none. Defaults to logging.googleapis.com/kubernetes. When `null`, the `logging_service` field will be omitted from the resulting object.\n - `min_master_version` (`string`): The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the current master version--use the read-only master_version field to obtain that. If unset, the cluster's version will be set by GKE to the version of the most recent official release (which is not necessarily the latest version). When `null`, the `min_master_version` field will be omitted from the resulting object.\n - `monitoring_service` (`string`): The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com(Legacy Stackdriver), monitoring.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Monitoring), and none. Defaults to monitoring.googleapis.com/kubernetes. When `null`, the `monitoring_service` field will be omitted from the resulting object.\n - `name` (`string`): The name of the cluster, unique within the project and location.\n - `network` (`string`): The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. When `null`, the `network` field will be omitted from the resulting object.\n - `networking_mode` (`string`): Determines whether alias IPs or routes will be used for pod IPs in the cluster. When `null`, the `networking_mode` field will be omitted from the resulting object.\n - `node_locations` (`list`): The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster's zone. When `null`, the `node_locations` field will be omitted from the resulting object.\n - `node_version` (`string`): The Kubernetes version on the nodes. Must either be unset or set to the same value as min_master_version on create. Defaults to the default version set by GKE which is not necessarily the latest version. This only affects nodes in the default node pool. While a fuzzy version can be specified, it's recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source's version_prefix field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the version attribute on the node pool. When `null`, the `node_version` field will be omitted from the resulting object.\n - `private_ipv6_google_access` (`string`): The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4). When `null`, the `private_ipv6_google_access` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `remove_default_node_pool` (`bool`): If true, deletes the default node pool upon cluster creation. If you're using google_container_node_pool resources with no default node pool, this should be set to true, alongside setting initial_node_count to at least 1. When `null`, the `remove_default_node_pool` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the cluster. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The name or self_link of the Google Compute Engine subnetwork in which the cluster's instances are launched. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `addons_config` (`list[obj]`): The configuration for addons supported by GKE. When `null`, the `addons_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.container_cluster.addons_config.new](#fn-addons_confignew) constructor.\n - `authenticator_groups_config` (`list[obj]`): Configuration for the Google Groups for GKE feature. When `null`, the `authenticator_groups_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.container_cluster.authenticator_groups_config.new](#fn-authenticator_groups_confignew) constructor.\n - `binary_authorization` (`list[obj]`): Configuration options for the Binary Authorization feature. When `null`, the `binary_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_cluster.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `cluster_autoscaling` (`list[obj]`): Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster's workload. See the guide to using Node Auto-Provisioning for more details. When `null`, the `cluster_autoscaling` 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_cluster.cluster_autoscaling.new](#fn-cluster_autoscalingnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. When `null`, the `confidential_nodes` 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_cluster.confidential_nodes.new](#fn-confidential_nodesnew) constructor.\n - `cost_management_config` (`list[obj]`): Cost management configuration for the cluster. When `null`, the `cost_management_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.container_cluster.cost_management_config.new](#fn-cost_management_confignew) constructor.\n - `database_encryption` (`list[obj]`): Application-layer Secrets Encryption settings. The object format is {state = string, key_name = string}. Valid values of state are: "ENCRYPTED"; "DECRYPTED". key_name is the name of a CloudKMS key. When `null`, the `database_encryption` 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_cluster.database_encryption.new](#fn-database_encryptionnew) constructor.\n - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` 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_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor.\n - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_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.container_cluster.dns_config.new](#fn-dns_confignew) constructor.\n - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` 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_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor.\n - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_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.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor.\n - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor.\n - `logging_config` (`list[obj]`): Logging configuration for the cluster. When `null`, the `logging_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.container_cluster.logging_config.new](#fn-logging_confignew) constructor.\n - `maintenance_policy` (`list[obj]`): The maintenance policy to use for the cluster. When `null`, the `maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.maintenance_policy.new](#fn-maintenance_policynew) constructor.\n - `master_auth` (`list[obj]`): The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. When `null`, the `master_auth` 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_cluster.master_auth.new](#fn-master_authnew) constructor.\n - `master_authorized_networks_config` (`list[obj]`): The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). When `null`, the `master_authorized_networks_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.container_cluster.master_authorized_networks_config.new](#fn-master_authorized_networks_confignew) constructor.\n - `mesh_certificates` (`list[obj]`): If set, and enable_certificates=true, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster. When `null`, the `mesh_certificates` 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_cluster.mesh_certificates.new](#fn-mesh_certificatesnew) constructor.\n - `monitoring_config` (`list[obj]`): Monitoring configuration for the cluster. When `null`, the `monitoring_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.container_cluster.monitoring_config.new](#fn-monitoring_confignew) constructor.\n - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor.\n - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_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.container_cluster.node_config.new](#fn-node_confignew) constructor.\n - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say "these are the only node pools associated with this cluster", use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` 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_cluster.node_pool.new](#fn-node_poolnew) constructor.\n - `node_pool_auto_config` (`list[obj]`): Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. When `null`, the `node_pool_auto_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.container_cluster.node_pool_auto_config.new](#fn-node_pool_auto_confignew) constructor.\n - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` 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_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor.\n - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_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.container_cluster.notification_config.new](#fn-notification_confignew) constructor.\n - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_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.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor.\n - `release_channel` (`list[obj]`): Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. Note that removing this field from your config will not unenroll it. Instead, use the "UNSPECIFIED" channel. When `null`, the `release_channel` 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_cluster.release_channel.new](#fn-release_channelnew) constructor.\n - `resource_usage_export_config` (`list[obj]`): Configuration for the ResourceUsageExportConfig feature. When `null`, the `resource_usage_export_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.container_cluster.resource_usage_export_config.new](#fn-resource_usage_export_confignew) constructor.\n - `security_posture_config` (`list[obj]`): Defines the config needed to enable/disable features for the Security Posture API When `null`, the `security_posture_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.container_cluster.security_posture_config.new](#fn-security_posture_confignew) constructor.\n - `service_external_ips_config` (`list[obj]`): If set, and enabled=true, services with external ips field will not be blocked When `null`, the `service_external_ips_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.container_cluster.service_external_ips_config.new](#fn-service_external_ips_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n - `vertical_pod_autoscaling` (`list[obj]`): Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. When `null`, the `vertical_pod_autoscaling` 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_cluster.vertical_pod_autoscaling.new](#fn-vertical_pod_autoscalingnew) constructor.\n - `workload_identity_config` (`list[obj]`): Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. When `null`, the `workload_identity_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.container_cluster.workload_identity_config.new](#fn-workload_identity_confignew) 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_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, addons_config=null, @@ -652,6 +654,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); node_config=null, node_locations=null, node_pool=null, + node_pool_auto_config=null, node_pool_defaults=null, node_version=null, notification_config=null, @@ -712,6 +715,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); node_config: node_config, node_locations: node_locations, node_pool: node_pool, + node_pool_auto_config: node_pool_auto_config, node_pool_defaults: node_pool_defaults, node_version: node_version, notification_config: notification_config, @@ -754,6 +758,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, + fast_socket:: { + '#new':: d.fn(help='\n`google.container_cluster.node_config.fast_socket.new` constructs a new object with attributes and blocks configured for the `fast_socket`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether or not NCCL Fast Socket is enabled\n\n**Returns**:\n - An attribute object that represents the `fast_socket` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, gcfs_config:: { '#new':: d.fn(help='\n`google.container_cluster.node_config.gcfs_config.new` constructs a new object with attributes and blocks configured for the `gcfs_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether or not GCFS is enabled\n\n**Returns**:\n - An attribute object that represents the `gcfs_config` sub block.\n', args=[]), new( @@ -808,7 +820,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, - '#new':: d.fn(help='\n`google.container_cluster.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_cluster.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_cluster.node_config.confidential_nodes.new](#fn-node_configconfidential_nodesnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_cluster.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_cluster.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_cluster.node_config.gvnic.new](#fn-node_configgvnicnew) constructor.\n - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_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.container_cluster.node_config.kubelet_config.new](#fn-node_configkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_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.container_cluster.node_config.linux_node_config.new](#fn-node_configlinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_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.container_cluster.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` 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_cluster.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_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.container_cluster.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_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.container_cluster.node_config.sole_tenant_config.new](#fn-node_configsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_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.container_cluster.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_cluster.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_cluster.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_cluster.node_config.confidential_nodes.new](#fn-node_configconfidential_nodesnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_cluster.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor.\n - `fast_socket` (`list[obj]`): Enable or disable NCCL Fast Socket in the node pool. When `null`, the `fast_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.container_cluster.node_config.fast_socket.new](#fn-node_configfast_socketnew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_cluster.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_cluster.node_config.gvnic.new](#fn-node_configgvnicnew) constructor.\n - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_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.container_cluster.node_config.kubelet_config.new](#fn-node_configkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_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.container_cluster.node_config.linux_node_config.new](#fn-node_configlinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_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.container_cluster.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` 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_cluster.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_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.container_cluster.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_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.container_cluster.node_config.sole_tenant_config.new](#fn-node_configsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_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.container_cluster.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), new( advanced_machine_features=null, boot_disk_kms_key=null, @@ -816,6 +828,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); disk_size_gb=null, disk_type=null, ephemeral_storage_local_ssd_config=null, + fast_socket=null, gcfs_config=null, guest_accelerator=null, gvnic=null, @@ -849,6 +862,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); disk_size_gb: disk_size_gb, disk_type: disk_type, ephemeral_storage_local_ssd_config: ephemeral_storage_local_ssd_config, + fast_socket: fast_socket, gcfs_config: gcfs_config, guest_accelerator: guest_accelerator, gvnic: gvnic, @@ -1033,6 +1047,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, + fast_socket:: { + '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.fast_socket.new` constructs a new object with attributes and blocks configured for the `fast_socket`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether or not NCCL Fast Socket is enabled\n\n**Returns**:\n - An attribute object that represents the `fast_socket` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, gcfs_config:: { '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.gcfs_config.new` constructs a new object with attributes and blocks configured for the `gcfs_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether or not GCFS is enabled\n\n**Returns**:\n - An attribute object that represents the `gcfs_config` sub block.\n', args=[]), new( @@ -1087,7 +1109,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, - '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_cluster.node_pool.node_config.advanced_machine_features.new](#fn-node_poolnode_pooladvanced_machine_featuresnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_cluster.node_pool.node_config.confidential_nodes.new](#fn-node_poolnode_poolconfidential_nodesnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_cluster.node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_poolnode_poolephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_cluster.node_pool.node_config.gcfs_config.new](#fn-node_poolnode_poolgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_cluster.node_pool.node_config.gvnic.new](#fn-node_poolnode_poolgvnicnew) constructor.\n - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.host_maintenance_policy.new](#fn-node_poolnode_poolhost_maintenance_policynew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_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.container_cluster.node_pool.node_config.kubelet_config.new](#fn-node_poolnode_poolkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_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.container_cluster.node_pool.node_config.linux_node_config.new](#fn-node_poolnode_poollinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_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.container_cluster.node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_poolnode_poollocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` 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_cluster.node_pool.node_config.reservation_affinity.new](#fn-node_poolnode_poolreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_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.container_cluster.node_pool.node_config.shielded_instance_config.new](#fn-node_poolnode_poolshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_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.container_cluster.node_pool.node_config.sole_tenant_config.new](#fn-node_poolnode_poolsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_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.container_cluster.node_pool.node_config.workload_metadata_config.new](#fn-node_poolnode_poolworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_cluster.node_pool.node_config.advanced_machine_features.new](#fn-node_poolnode_pooladvanced_machine_featuresnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_cluster.node_pool.node_config.confidential_nodes.new](#fn-node_poolnode_poolconfidential_nodesnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_cluster.node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_poolnode_poolephemeral_storage_local_ssd_confignew) constructor.\n - `fast_socket` (`list[obj]`): Enable or disable NCCL Fast Socket in the node pool. When `null`, the `fast_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.container_cluster.node_pool.node_config.fast_socket.new](#fn-node_poolnode_poolfast_socketnew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_cluster.node_pool.node_config.gcfs_config.new](#fn-node_poolnode_poolgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_cluster.node_pool.node_config.gvnic.new](#fn-node_poolnode_poolgvnicnew) constructor.\n - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.host_maintenance_policy.new](#fn-node_poolnode_poolhost_maintenance_policynew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_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.container_cluster.node_pool.node_config.kubelet_config.new](#fn-node_poolnode_poolkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_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.container_cluster.node_pool.node_config.linux_node_config.new](#fn-node_poolnode_poollinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_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.container_cluster.node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_poolnode_poollocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` 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_cluster.node_pool.node_config.reservation_affinity.new](#fn-node_poolnode_poolreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_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.container_cluster.node_pool.node_config.shielded_instance_config.new](#fn-node_poolnode_poolshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_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.container_cluster.node_pool.node_config.sole_tenant_config.new](#fn-node_poolnode_poolsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_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.container_cluster.node_pool.node_config.workload_metadata_config.new](#fn-node_poolnode_poolworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), new( advanced_machine_features=null, boot_disk_kms_key=null, @@ -1095,6 +1117,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); disk_size_gb=null, disk_type=null, ephemeral_storage_local_ssd_config=null, + fast_socket=null, gcfs_config=null, guest_accelerator=null, gvnic=null, @@ -1128,6 +1151,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); disk_size_gb: disk_size_gb, disk_type: disk_type, ephemeral_storage_local_ssd_config: ephemeral_storage_local_ssd_config, + fast_socket: fast_socket, gcfs_config: gcfs_config, guest_accelerator: guest_accelerator, gvnic: gvnic, @@ -1207,12 +1231,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, placement_policy:: { - '#new':: d.fn(help='\n`google.container_cluster.node_pool.placement_policy.new` constructs a new object with attributes and blocks configured for the `placement_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `policy_name` (`string`): If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. When `null`, the `policy_name` field will be omitted from the resulting object.\n - `type` (`string`): Type defines the type of placement policy\n\n**Returns**:\n - An attribute object that represents the `placement_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_cluster.node_pool.placement_policy.new` constructs a new object with attributes and blocks configured for the `placement_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `policy_name` (`string`): If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. When `null`, the `policy_name` field will be omitted from the resulting object.\n - `tpu_topology` (`string`): TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies When `null`, the `tpu_topology` field will be omitted from the resulting object.\n - `type` (`string`): Type defines the type of placement policy\n\n**Returns**:\n - An attribute object that represents the `placement_policy` sub block.\n', args=[]), new( type, - policy_name=null + policy_name=null, + tpu_topology=null ):: std.prune(a={ policy_name: policy_name, + tpu_topology: tpu_topology, type: type, }), }, @@ -1253,6 +1279,22 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, + node_pool_auto_config:: { + network_tags:: { + '#new':: d.fn(help='\n`google.container_cluster.node_pool_auto_config.network_tags.new` constructs a new object with attributes and blocks configured for the `network_tags`\nTerraform sub block.\n\n\n\n**Args**:\n - `tags` (`list`): List of network tags applied to auto-provisioned node pools. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `network_tags` sub block.\n', args=[]), + new( + tags=null + ):: std.prune(a={ + tags: tags, + }), + }, + '#new':: d.fn(help='\n`google.container_cluster.node_pool_auto_config.new` constructs a new object with attributes and blocks configured for the `node_pool_auto_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `network_tags` (`list[obj]`): Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. When `null`, the `network_tags` 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_cluster.node_pool_auto_config.network_tags.new](#fn-node_pool_auto_confignetwork_tagsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_pool_auto_config` sub block.\n', args=[]), + new( + network_tags=null + ):: std.prune(a={ + network_tags: network_tags, + }), + }, node_pool_defaults:: { '#new':: d.fn(help='\n`google.container_cluster.node_pool_defaults.new` constructs a new object with attributes and blocks configured for the `node_pool_defaults`\nTerraform sub block.\n\n\n\n**Args**:\n - `node_config_defaults` (`list[obj]`): Subset of NodeConfig message that has defaults. When `null`, the `node_config_defaults` 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_cluster.node_pool_defaults.node_config_defaults.new](#fn-node_pool_defaultsnode_config_defaultsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_pool_defaults` sub block.\n', args=[]), new( @@ -2019,6 +2061,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withNodePoolAutoConfig':: d.fn(help='`google.list[obj].withNodePoolAutoConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the node_pool_auto_config 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].withNodePoolAutoConfigMixin](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 `node_pool_auto_config` field.\n', args=[]), + withNodePoolAutoConfig(resourceLabel, value): { + resource+: { + google_container_cluster+: { + [resourceLabel]+: { + node_pool_auto_config: value, + }, + }, + }, + }, + '#withNodePoolAutoConfigMixin':: d.fn(help='`google.list[obj].withNodePoolAutoConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the node_pool_auto_config 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].withNodePoolAutoConfig](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 `node_pool_auto_config` field.\n', args=[]), + withNodePoolAutoConfigMixin(resourceLabel, value): { + resource+: { + google_container_cluster+: { + [resourceLabel]+: { + node_pool_auto_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withNodePoolDefaults':: d.fn(help='`google.list[obj].withNodePoolDefaults` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the node_pool_defaults 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].withNodePoolDefaultsMixin](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 `node_pool_defaults` field.\n', args=[]), withNodePoolDefaults(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/container_node_pool.libsonnet b/4.x/_gen/resources/container_node_pool.libsonnet index 1a2afe1a..606793c4 100644 --- a/4.x/_gen/resources/container_node_pool.libsonnet +++ b/4.x/_gen/resources/container_node_pool.libsonnet @@ -160,6 +160,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, + fast_socket:: { + '#new':: d.fn(help='\n`google.container_node_pool.node_config.fast_socket.new` constructs a new object with attributes and blocks configured for the `fast_socket`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether or not NCCL Fast Socket is enabled\n\n**Returns**:\n - An attribute object that represents the `fast_socket` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, gcfs_config:: { '#new':: d.fn(help='\n`google.container_node_pool.node_config.gcfs_config.new` constructs a new object with attributes and blocks configured for the `gcfs_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether or not GCFS is enabled\n\n**Returns**:\n - An attribute object that represents the `gcfs_config` sub block.\n', args=[]), new( @@ -214,7 +222,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, - '#new':: d.fn(help='\n`google.container_node_pool.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_node_pool.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_node_pool.node_config.confidential_nodes.new](#fn-node_configconfidential_nodesnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_node_pool.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_node_pool.node_config.gvnic.new](#fn-node_configgvnicnew) constructor.\n - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_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.container_node_pool.node_config.kubelet_config.new](#fn-node_configkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_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.container_node_pool.node_config.linux_node_config.new](#fn-node_configlinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_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.container_node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` 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_node_pool.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_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.container_node_pool.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_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.container_node_pool.node_config.sole_tenant_config.new](#fn-node_configsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_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.container_node_pool.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_node_pool.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_node_pool.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_node_pool.node_config.confidential_nodes.new](#fn-node_configconfidential_nodesnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor.\n - `fast_socket` (`list[obj]`): Enable or disable NCCL Fast Socket in the node pool. When `null`, the `fast_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.container_node_pool.node_config.fast_socket.new](#fn-node_configfast_socketnew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_node_pool.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_node_pool.node_config.gvnic.new](#fn-node_configgvnicnew) constructor.\n - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_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.container_node_pool.node_config.kubelet_config.new](#fn-node_configkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_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.container_node_pool.node_config.linux_node_config.new](#fn-node_configlinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_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.container_node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` 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_node_pool.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_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.container_node_pool.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_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.container_node_pool.node_config.sole_tenant_config.new](#fn-node_configsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_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.container_node_pool.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), new( advanced_machine_features=null, boot_disk_kms_key=null, @@ -222,6 +230,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); disk_size_gb=null, disk_type=null, ephemeral_storage_local_ssd_config=null, + fast_socket=null, gcfs_config=null, guest_accelerator=null, gvnic=null, @@ -255,6 +264,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); disk_size_gb: disk_size_gb, disk_type: disk_type, ephemeral_storage_local_ssd_config: ephemeral_storage_local_ssd_config, + fast_socket: fast_socket, gcfs_config: gcfs_config, guest_accelerator: guest_accelerator, gvnic: gvnic, @@ -334,12 +344,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, placement_policy:: { - '#new':: d.fn(help='\n`google.container_node_pool.placement_policy.new` constructs a new object with attributes and blocks configured for the `placement_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `policy_name` (`string`): If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. When `null`, the `policy_name` field will be omitted from the resulting object.\n - `type` (`string`): Type defines the type of placement policy\n\n**Returns**:\n - An attribute object that represents the `placement_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_node_pool.placement_policy.new` constructs a new object with attributes and blocks configured for the `placement_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `policy_name` (`string`): If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. When `null`, the `policy_name` field will be omitted from the resulting object.\n - `tpu_topology` (`string`): TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies When `null`, the `tpu_topology` field will be omitted from the resulting object.\n - `type` (`string`): Type defines the type of placement policy\n\n**Returns**:\n - An attribute object that represents the `placement_policy` sub block.\n', args=[]), new( type, - policy_name=null + policy_name=null, + tpu_topology=null ):: std.prune(a={ policy_name: policy_name, + tpu_topology: tpu_topology, type: type, }), }, diff --git a/4.x/_gen/resources/dialogflow_cx_security_settings.libsonnet b/4.x/_gen/resources/dialogflow_cx_security_settings.libsonnet new file mode 100644 index 00000000..f201de5c --- /dev/null +++ b/4.x/_gen/resources/dialogflow_cx_security_settings.libsonnet @@ -0,0 +1,266 @@ +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='dialogflow_cx_security_settings', url='', help='`dialogflow_cx_security_settings` represents the `google_dialogflow_cx_security_settings` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + audio_export_settings:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_security_settings.audio_export_settings.new` constructs a new object with attributes and blocks configured for the `audio_export_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_export_pattern` (`string`): Filename pattern for exported audio. When `null`, the `audio_export_pattern` field will be omitted from the resulting object.\n - `audio_format` (`string`): File format for exported audio file. Currently only in telephony recordings.\n* MULAW: G.711 mu-law PCM with 8kHz sample rate.\n* MP3: MP3 file format.\n* OGG: OGG Vorbis. Possible values: ["MULAW", "MP3", "OGG"] When `null`, the `audio_format` field will be omitted from the resulting object.\n - `enable_audio_redaction` (`bool`): Enable audio redaction if it is true. When `null`, the `enable_audio_redaction` field will be omitted from the resulting object.\n - `gcs_bucket` (`string`): Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy. When `null`, the `gcs_bucket` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `audio_export_settings` sub block.\n', args=[]), + new( + audio_export_pattern=null, + audio_format=null, + enable_audio_redaction=null, + gcs_bucket=null + ):: std.prune(a={ + audio_export_pattern: audio_export_pattern, + audio_format: audio_format, + enable_audio_redaction: enable_audio_redaction, + gcs_bucket: gcs_bucket, + }), + }, + insights_export_settings:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_security_settings.insights_export_settings.new` constructs a new object with attributes and blocks configured for the `insights_export_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `enable_insights_export` (`bool`): If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.\n\n**Returns**:\n - An attribute object that represents the `insights_export_settings` sub block.\n', args=[]), + new( + enable_insights_export + ):: std.prune(a={ + enable_insights_export: enable_insights_export, + }), + }, + '#new':: d.fn(help="\n`google.dialogflow_cx_security_settings.new` injects a new `google_dialogflow_cx_security_settings` 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.dialogflow_cx_security_settings.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.dialogflow_cx_security_settings` using the reference:\n\n $._ref.google_dialogflow_cx_security_settings.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_dialogflow_cx_security_settings.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 - `deidentify_template` (`string`): [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. If empty, Dialogflow replaces sensitive info with [redacted] text.\nNote: deidentifyTemplate must be located in the same region as the SecuritySettings.\nFormat: projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/deidentifyTemplates/\u0026lt;Template ID\u0026gt; OR organizations/\u0026lt;Organization ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/deidentifyTemplates/\u0026lt;Template ID\u0026gt; When `null`, the `deidentify_template` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable name of the security settings, unique within the location.\n - `inspect_template` (`string`): [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config.\nNote: inspectTemplate must be located in the same region as the SecuritySettings.\nFormat: projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/inspectTemplates/\u0026lt;Template ID\u0026gt; OR organizations/\u0026lt;Organization ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/inspectTemplates/\u0026lt;Template ID\u0026gt; When `null`, the `inspect_template` field will be omitted from the resulting object.\n - `location` (`string`): The location these settings are located in. Settings can only be applied to an agent in the same location.\nSee [Available Regions](https://cloud.google.com/dialogflow/cx/docs/concept/region#avail) for a list of supported locations.\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 - `purge_data_types` (`list`): List of types of data to remove when retention settings triggers purge. Possible values: [\u0026#34;DIALOGFLOW_HISTORY\u0026#34;] When `null`, the `purge_data_types` field will be omitted from the resulting object.\n - `redaction_scope` (`string`): Defines what types of data to redact. If not set, defaults to not redacting any kind of data.\n* REDACT_DISK_STORAGE: On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk. Possible values: [\u0026#34;REDACT_DISK_STORAGE\u0026#34;] When `null`, the `redaction_scope` field will be omitted from the resulting object.\n - `redaction_strategy` (`string`): Defines how we redact data. If not set, defaults to not redacting.\n* REDACT_WITH_SERVICE: Call redaction service to clean up the data to be persisted. Possible values: [\u0026#34;REDACT_WITH_SERVICE\u0026#34;] When `null`, the `redaction_strategy` field will be omitted from the resulting object.\n - `retention_strategy` (`string`): Defines how long we retain persisted data that contains sensitive info. Only one of \u0026#39;retention_window_days\u0026#39; and \u0026#39;retention_strategy\u0026#39; may be set.\n* REMOVE_AFTER_CONVERSATION: Removes data when the conversation ends. If there is no conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends. Possible values: [\u0026#34;REMOVE_AFTER_CONVERSATION\u0026#34;] When `null`, the `retention_strategy` field will be omitted from the resulting object.\n - `retention_window_days` (`number`): Retains the data for the specified number of days. User must set a value lower than Dialogflow\u0026#39;s default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL.\nOnly one of \u0026#39;retention_window_days\u0026#39; and \u0026#39;retention_strategy\u0026#39; may be set. When `null`, the `retention_window_days` field will be omitted from the resulting object.\n - `audio_export_settings` (`list[obj]`): Controls audio export settings for post-conversation analytics when ingesting audio to conversations.\nIf retention_strategy is set to REMOVE_AFTER_CONVERSATION or gcs_bucket is empty, audio export is disabled.\nIf audio export is enabled, audio is recorded and saved to gcs_bucket, subject to retention policy of gcs_bucket.\nThis setting won\u0026#39;t effect audio input for implicit sessions via [Sessions.DetectIntent](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.sessions/detectIntent#google.cloud.dialogflow.cx.v3.Sessions.DetectIntent). When `null`, the `audio_export_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.audio_export_settings.new](#fn-audio_export_settingsnew) constructor.\n - `insights_export_settings` (`list[obj]`): Controls conversation exporting settings to Insights after conversation is completed.\nIf retentionStrategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here. When `null`, the `insights_export_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.insights_export_settings.new](#fn-insights_export_settingsnew) 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.dialogflow_cx_security_settings.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, + location, + audio_export_settings=null, + deidentify_template=null, + insights_export_settings=null, + inspect_template=null, + project=null, + purge_data_types=null, + redaction_scope=null, + redaction_strategy=null, + retention_strategy=null, + retention_window_days=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_dialogflow_cx_security_settings', + label=resourceLabel, + attrs=self.newAttrs( + audio_export_settings=audio_export_settings, + deidentify_template=deidentify_template, + display_name=display_name, + insights_export_settings=insights_export_settings, + inspect_template=inspect_template, + location=location, + project=project, + purge_data_types=purge_data_types, + redaction_scope=redaction_scope, + redaction_strategy=redaction_strategy, + retention_strategy=retention_strategy, + retention_window_days=retention_window_days, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.dialogflow_cx_security_settings.newAttrs` constructs a new object with attributes and blocks configured for the `dialogflow_cx_security_settings`\nTerraform resource.\n\nUnlike [google.dialogflow_cx_security_settings.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 - `deidentify_template` (`string`): [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. If empty, Dialogflow replaces sensitive info with [redacted] text.\nNote: deidentifyTemplate must be located in the same region as the SecuritySettings.\nFormat: projects/<Project ID>/locations/<Location ID>/deidentifyTemplates/<Template ID> OR organizations/<Organization ID>/locations/<Location ID>/deidentifyTemplates/<Template ID> When `null`, the `deidentify_template` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable name of the security settings, unique within the location.\n - `inspect_template` (`string`): [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config.\nNote: inspectTemplate must be located in the same region as the SecuritySettings.\nFormat: projects/<Project ID>/locations/<Location ID>/inspectTemplates/<Template ID> OR organizations/<Organization ID>/locations/<Location ID>/inspectTemplates/<Template ID> When `null`, the `inspect_template` field will be omitted from the resulting object.\n - `location` (`string`): The location these settings are located in. Settings can only be applied to an agent in the same location.\nSee [Available Regions](https://cloud.google.com/dialogflow/cx/docs/concept/region#avail) for a list of supported locations.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `purge_data_types` (`list`): List of types of data to remove when retention settings triggers purge. Possible values: ["DIALOGFLOW_HISTORY"] When `null`, the `purge_data_types` field will be omitted from the resulting object.\n - `redaction_scope` (`string`): Defines what types of data to redact. If not set, defaults to not redacting any kind of data.\n* REDACT_DISK_STORAGE: On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk. Possible values: ["REDACT_DISK_STORAGE"] When `null`, the `redaction_scope` field will be omitted from the resulting object.\n - `redaction_strategy` (`string`): Defines how we redact data. If not set, defaults to not redacting.\n* REDACT_WITH_SERVICE: Call redaction service to clean up the data to be persisted. Possible values: ["REDACT_WITH_SERVICE"] When `null`, the `redaction_strategy` field will be omitted from the resulting object.\n - `retention_strategy` (`string`): Defines how long we retain persisted data that contains sensitive info. Only one of 'retention_window_days' and 'retention_strategy' may be set.\n* REMOVE_AFTER_CONVERSATION: Removes data when the conversation ends. If there is no conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends. Possible values: ["REMOVE_AFTER_CONVERSATION"] When `null`, the `retention_strategy` field will be omitted from the resulting object.\n - `retention_window_days` (`number`): Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL.\nOnly one of 'retention_window_days' and 'retention_strategy' may be set. When `null`, the `retention_window_days` field will be omitted from the resulting object.\n - `audio_export_settings` (`list[obj]`): Controls audio export settings for post-conversation analytics when ingesting audio to conversations.\nIf retention_strategy is set to REMOVE_AFTER_CONVERSATION or gcs_bucket is empty, audio export is disabled.\nIf audio export is enabled, audio is recorded and saved to gcs_bucket, subject to retention policy of gcs_bucket.\nThis setting won't effect audio input for implicit sessions via [Sessions.DetectIntent](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.sessions/detectIntent#google.cloud.dialogflow.cx.v3.Sessions.DetectIntent). When `null`, the `audio_export_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.audio_export_settings.new](#fn-audio_export_settingsnew) constructor.\n - `insights_export_settings` (`list[obj]`): Controls conversation exporting settings to Insights after conversation is completed.\nIf retentionStrategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here. When `null`, the `insights_export_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.insights_export_settings.new](#fn-insights_export_settingsnew) 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.dialogflow_cx_security_settings.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 `dialogflow_cx_security_settings` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + display_name, + location, + audio_export_settings=null, + deidentify_template=null, + insights_export_settings=null, + inspect_template=null, + project=null, + purge_data_types=null, + redaction_scope=null, + redaction_strategy=null, + retention_strategy=null, + retention_window_days=null, + timeouts=null + ):: std.prune(a={ + audio_export_settings: audio_export_settings, + deidentify_template: deidentify_template, + display_name: display_name, + insights_export_settings: insights_export_settings, + inspect_template: inspect_template, + location: location, + project: project, + purge_data_types: purge_data_types, + redaction_scope: redaction_scope, + redaction_strategy: redaction_strategy, + retention_strategy: retention_strategy, + retention_window_days: retention_window_days, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_security_settings.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, + }), + }, + '#withAudioExportSettings':: d.fn(help='`google.list[obj].withAudioExportSettings` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the audio_export_settings 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].withAudioExportSettingsMixin](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 `audio_export_settings` field.\n', args=[]), + withAudioExportSettings(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + audio_export_settings: value, + }, + }, + }, + }, + '#withAudioExportSettingsMixin':: d.fn(help='`google.list[obj].withAudioExportSettingsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the audio_export_settings 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].withAudioExportSettings](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 `audio_export_settings` field.\n', args=[]), + withAudioExportSettingsMixin(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + audio_export_settings+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withDeidentifyTemplate':: d.fn(help='`google.string.withDeidentifyTemplate` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the deidentify_template 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 `deidentify_template` field.\n', args=[]), + withDeidentifyTemplate(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + deidentify_template: 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_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withInsightsExportSettings':: d.fn(help='`google.list[obj].withInsightsExportSettings` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the insights_export_settings 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].withInsightsExportSettingsMixin](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 `insights_export_settings` field.\n', args=[]), + withInsightsExportSettings(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + insights_export_settings: value, + }, + }, + }, + }, + '#withInsightsExportSettingsMixin':: d.fn(help='`google.list[obj].withInsightsExportSettingsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the insights_export_settings 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].withInsightsExportSettings](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 `insights_export_settings` field.\n', args=[]), + withInsightsExportSettingsMixin(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + insights_export_settings+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withInspectTemplate':: d.fn(help='`google.string.withInspectTemplate` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the inspect_template 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 `inspect_template` field.\n', args=[]), + withInspectTemplate(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + inspect_template: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + location: 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_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withPurgeDataTypes':: d.fn(help='`google.list.withPurgeDataTypes` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the purge_data_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 `purge_data_types` field.\n', args=[]), + withPurgeDataTypes(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + purge_data_types: value, + }, + }, + }, + }, + '#withRedactionScope':: d.fn(help='`google.string.withRedactionScope` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the redaction_scope 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 `redaction_scope` field.\n', args=[]), + withRedactionScope(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + redaction_scope: value, + }, + }, + }, + }, + '#withRedactionStrategy':: d.fn(help='`google.string.withRedactionStrategy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the redaction_strategy 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 `redaction_strategy` field.\n', args=[]), + withRedactionStrategy(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + redaction_strategy: value, + }, + }, + }, + }, + '#withRetentionStrategy':: d.fn(help='`google.string.withRetentionStrategy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the retention_strategy 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 `retention_strategy` field.\n', args=[]), + withRetentionStrategy(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + retention_strategy: value, + }, + }, + }, + }, + '#withRetentionWindowDays':: d.fn(help='`google.number.withRetentionWindowDays` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the retention_window_days field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`number`): The value to set for the `retention_window_days` field.\n', args=[]), + withRetentionWindowDays(resourceLabel, value): { + resource+: { + google_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + retention_window_days: 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_dialogflow_cx_security_settings+: { + [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_dialogflow_cx_security_settings+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/edgenetwork_network.libsonnet b/4.x/_gen/resources/edgenetwork_network.libsonnet new file mode 100644 index 00000000..9189ab7a --- /dev/null +++ b/4.x/_gen/resources/edgenetwork_network.libsonnet @@ -0,0 +1,152 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='edgenetwork_network', url='', help='`edgenetwork_network` represents the `google_edgenetwork_network` 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.edgenetwork_network.new` injects a new `google_edgenetwork_network` 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.edgenetwork_network.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.edgenetwork_network` using the reference:\n\n $._ref.google_edgenetwork_network.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_edgenetwork_network.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 free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels associated with this resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The Google Cloud region to which the target Distributed Cloud Edge zone belongs.\n - `mtu` (`number`): IP (L3) MTU value of the network. Default value is \u0026#39;1500\u0026#39;. Possible values are: \u0026#39;1500\u0026#39;, \u0026#39;9000\u0026#39;. When `null`, the `mtu` field will be omitted from the resulting object.\n - `network_id` (`string`): A unique ID that identifies this network.\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 - `zone` (`string`): The name of the target Distributed Cloud Edge zone.\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.edgenetwork_network.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, + location, + network_id, + zone, + description=null, + labels=null, + mtu=null, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_edgenetwork_network', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + labels=labels, + location=location, + mtu=mtu, + network_id=network_id, + project=project, + timeouts=timeouts, + zone=zone + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.edgenetwork_network.newAttrs` constructs a new object with attributes and blocks configured for the `edgenetwork_network`\nTerraform resource.\n\nUnlike [google.edgenetwork_network.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 free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels associated with this resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The Google Cloud region to which the target Distributed Cloud Edge zone belongs.\n - `mtu` (`number`): IP (L3) MTU value of the network. Default value is '1500'. Possible values are: '1500', '9000'. When `null`, the `mtu` field will be omitted from the resulting object.\n - `network_id` (`string`): A unique ID that identifies this network.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `zone` (`string`): The name of the target Distributed Cloud Edge zone.\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.edgenetwork_network.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 `edgenetwork_network` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + network_id, + zone, + description=null, + labels=null, + mtu=null, + project=null, + timeouts=null + ):: std.prune(a={ + description: description, + labels: labels, + location: location, + mtu: mtu, + network_id: network_id, + project: project, + timeouts: timeouts, + zone: zone, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.edgenetwork_network.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withDescription':: d.fn(help='`google.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + google_edgenetwork_network+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google.obj.withLabels` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the labels field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `labels` field.\n', args=[]), + withLabels(resourceLabel, value): { + resource+: { + google_edgenetwork_network+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_edgenetwork_network+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withMtu':: d.fn(help='`google.number.withMtu` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the mtu field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`number`): The value to set for the `mtu` field.\n', args=[]), + withMtu(resourceLabel, value): { + resource+: { + google_edgenetwork_network+: { + [resourceLabel]+: { + mtu: value, + }, + }, + }, + }, + '#withNetworkId':: d.fn(help='`google.string.withNetworkId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the network_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 `network_id` field.\n', args=[]), + withNetworkId(resourceLabel, value): { + resource+: { + google_edgenetwork_network+: { + [resourceLabel]+: { + network_id: 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_edgenetwork_network+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_edgenetwork_network+: { + [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_edgenetwork_network+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withZone':: d.fn(help='`google.string.withZone` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the zone 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 `zone` field.\n', args=[]), + withZone(resourceLabel, value): { + resource+: { + google_edgenetwork_network+: { + [resourceLabel]+: { + zone: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/edgenetwork_subnet.libsonnet b/4.x/_gen/resources/edgenetwork_subnet.libsonnet new file mode 100644 index 00000000..51c112e4 --- /dev/null +++ b/4.x/_gen/resources/edgenetwork_subnet.libsonnet @@ -0,0 +1,194 @@ +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='edgenetwork_subnet', url='', help='`edgenetwork_subnet` represents the `google_edgenetwork_subnet` 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.edgenetwork_subnet.new` injects a new `google_edgenetwork_subnet` 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.edgenetwork_subnet.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.edgenetwork_subnet` using the reference:\n\n $._ref.google_edgenetwork_subnet.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_edgenetwork_subnet.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 free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `ipv4_cidr` (`list`): The ranges of ipv4 addresses that are owned by this subnetwork, in CIDR format. When `null`, the `ipv4_cidr` field will be omitted from the resulting object.\n - `ipv6_cidr` (`list`): The ranges of ipv6 addresses that are owned by this subnetwork, in CIDR format. When `null`, the `ipv6_cidr` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels associated with this resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The Google Cloud region to which the target Distributed Cloud Edge zone belongs.\n - `network` (`string`): The ID of the network to which this router belongs.\nMust be of the form: \u0026#39;projects/{{project}}/locations/{{location}}/zones/{{zone}}/networks/{{network_id}}\u0026#39;\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 - `subnet_id` (`string`): A unique ID that identifies this subnet.\n - `vlan_id` (`number`): VLAN ID for this subnetwork. If not specified, one is assigned automatically. When `null`, the `vlan_id` field will be omitted from the resulting object.\n - `zone` (`string`): The name of the target Distributed Cloud Edge zone.\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.edgenetwork_subnet.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, + location, + network, + subnet_id, + zone, + description=null, + ipv4_cidr=null, + ipv6_cidr=null, + labels=null, + project=null, + timeouts=null, + vlan_id=null, + _meta={} + ):: tf.withResource( + type='google_edgenetwork_subnet', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + ipv4_cidr=ipv4_cidr, + ipv6_cidr=ipv6_cidr, + labels=labels, + location=location, + network=network, + project=project, + subnet_id=subnet_id, + timeouts=timeouts, + vlan_id=vlan_id, + zone=zone + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.edgenetwork_subnet.newAttrs` constructs a new object with attributes and blocks configured for the `edgenetwork_subnet`\nTerraform resource.\n\nUnlike [google.edgenetwork_subnet.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 free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `ipv4_cidr` (`list`): The ranges of ipv4 addresses that are owned by this subnetwork, in CIDR format. When `null`, the `ipv4_cidr` field will be omitted from the resulting object.\n - `ipv6_cidr` (`list`): The ranges of ipv6 addresses that are owned by this subnetwork, in CIDR format. When `null`, the `ipv6_cidr` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels associated with this resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The Google Cloud region to which the target Distributed Cloud Edge zone belongs.\n - `network` (`string`): The ID of the network to which this router belongs.\nMust be of the form: 'projects/{{project}}/locations/{{location}}/zones/{{zone}}/networks/{{network_id}}'\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `subnet_id` (`string`): A unique ID that identifies this subnet.\n - `vlan_id` (`number`): VLAN ID for this subnetwork. If not specified, one is assigned automatically. When `null`, the `vlan_id` field will be omitted from the resulting object.\n - `zone` (`string`): The name of the target Distributed Cloud Edge zone.\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.edgenetwork_subnet.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 `edgenetwork_subnet` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + network, + subnet_id, + zone, + description=null, + ipv4_cidr=null, + ipv6_cidr=null, + labels=null, + project=null, + timeouts=null, + vlan_id=null + ):: std.prune(a={ + description: description, + ipv4_cidr: ipv4_cidr, + ipv6_cidr: ipv6_cidr, + labels: labels, + location: location, + network: network, + project: project, + subnet_id: subnet_id, + timeouts: timeouts, + vlan_id: vlan_id, + zone: zone, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.edgenetwork_subnet.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withDescription':: d.fn(help='`google.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withIpv4Cidr':: d.fn(help='`google.list.withIpv4Cidr` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the ipv4_cidr 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 `ipv4_cidr` field.\n', args=[]), + withIpv4Cidr(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + ipv4_cidr: value, + }, + }, + }, + }, + '#withIpv6Cidr':: d.fn(help='`google.list.withIpv6Cidr` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the ipv6_cidr 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 `ipv6_cidr` field.\n', args=[]), + withIpv6Cidr(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + ipv6_cidr: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google.obj.withLabels` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the labels field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `labels` field.\n', args=[]), + withLabels(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withNetwork':: d.fn(help='`google.string.withNetwork` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the network 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 `network` field.\n', args=[]), + withNetwork(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + network: 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_edgenetwork_subnet+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withSubnetId':: d.fn(help='`google.string.withSubnetId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the subnet_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 `subnet_id` field.\n', args=[]), + withSubnetId(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + subnet_id: 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_edgenetwork_subnet+: { + [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_edgenetwork_subnet+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withVlanId':: d.fn(help='`google.number.withVlanId` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the vlan_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`number`): The value to set for the `vlan_id` field.\n', args=[]), + withVlanId(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + vlan_id: value, + }, + }, + }, + }, + '#withZone':: d.fn(help='`google.string.withZone` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the zone 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 `zone` field.\n', args=[]), + withZone(resourceLabel, value): { + resource+: { + google_edgenetwork_subnet+: { + [resourceLabel]+: { + zone: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/filestore_instance.libsonnet b/4.x/_gen/resources/filestore_instance.libsonnet index 88a52764..aa91134d 100644 --- a/4.x/_gen/resources/filestore_instance.libsonnet +++ b/4.x/_gen/resources/filestore_instance.libsonnet @@ -44,7 +44,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); reserved_ip_range: reserved_ip_range, }), }, - '#new':: d.fn(help="\n`google.filestore_instance.new` injects a new `google_filestore_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.filestore_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.filestore_instance` using the reference:\n\n $._ref.google_filestore_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_filestore_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): A description of the instance. When `null`, the `description` field will be omitted from the resulting object.\n - `kms_key_name` (`string`): KMS key name used for data encryption. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Resource labels to represent user-provided metadata. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The name of the location of the instance. This can be a region for ENTERPRISE tier instances. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): The resource name of the instance.\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 - `tier` (`string`): The service tier of the instance.\nPossible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD and ENTERPRISE\n - `zone` (`string`): The name of the Filestore zone of the instance. When `null`, the `zone` field will be omitted from the resulting object.\n - `file_shares` (`list[obj]`): File system shares on the instance. For this version, only a\nsingle file share is supported. When `null`, the `file_shares` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.file_shares.new](#fn-file_sharesnew) constructor.\n - `networks` (`list[obj]`): VPC networks to which the instance is connected. For this version,\nonly a single network is supported. When `null`, the `networks` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.networks.new](#fn-networksnew) 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.filestore_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.filestore_instance.new` injects a new `google_filestore_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.filestore_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.filestore_instance` using the reference:\n\n $._ref.google_filestore_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_filestore_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): A description of the instance. When `null`, the `description` field will be omitted from the resulting object.\n - `kms_key_name` (`string`): KMS key name used for data encryption. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Resource labels to represent user-provided metadata. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The name of the location of the instance. This can be a region for ENTERPRISE tier instances. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): The resource name of the instance.\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 - `tier` (`string`): The service tier of the instance.\nPossible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD, ZONAL and ENTERPRISE\n - `zone` (`string`): The name of the Filestore zone of the instance. When `null`, the `zone` field will be omitted from the resulting object.\n - `file_shares` (`list[obj]`): File system shares on the instance. For this version, only a\nsingle file share is supported. When `null`, the `file_shares` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.file_shares.new](#fn-file_sharesnew) constructor.\n - `networks` (`list[obj]`): VPC networks to which the instance is connected. For this version,\nonly a single network is supported. When `null`, the `networks` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.networks.new](#fn-networksnew) 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.filestore_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -77,7 +77,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.filestore_instance.newAttrs` constructs a new object with attributes and blocks configured for the `filestore_instance`\nTerraform resource.\n\nUnlike [google.filestore_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): A description of the instance. When `null`, the `description` field will be omitted from the resulting object.\n - `kms_key_name` (`string`): KMS key name used for data encryption. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Resource labels to represent user-provided metadata. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The name of the location of the instance. This can be a region for ENTERPRISE tier instances. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): The resource name of the instance.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `tier` (`string`): The service tier of the instance.\nPossible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD and ENTERPRISE\n - `zone` (`string`): The name of the Filestore zone of the instance. When `null`, the `zone` field will be omitted from the resulting object.\n - `file_shares` (`list[obj]`): File system shares on the instance. For this version, only a\nsingle file share is supported. When `null`, the `file_shares` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.file_shares.new](#fn-file_sharesnew) constructor.\n - `networks` (`list[obj]`): VPC networks to which the instance is connected. For this version,\nonly a single network is supported. When `null`, the `networks` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.networks.new](#fn-networksnew) 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.filestore_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `filestore_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.filestore_instance.newAttrs` constructs a new object with attributes and blocks configured for the `filestore_instance`\nTerraform resource.\n\nUnlike [google.filestore_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): A description of the instance. When `null`, the `description` field will be omitted from the resulting object.\n - `kms_key_name` (`string`): KMS key name used for data encryption. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Resource labels to represent user-provided metadata. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The name of the location of the instance. This can be a region for ENTERPRISE tier instances. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): The resource name of the instance.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `tier` (`string`): The service tier of the instance.\nPossible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD, ZONAL and ENTERPRISE\n - `zone` (`string`): The name of the Filestore zone of the instance. When `null`, the `zone` field will be omitted from the resulting object.\n - `file_shares` (`list[obj]`): File system shares on the instance. For this version, only a\nsingle file share is supported. When `null`, the `file_shares` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.file_shares.new](#fn-file_sharesnew) constructor.\n - `networks` (`list[obj]`): VPC networks to which the instance is connected. For this version,\nonly a single network is supported. When `null`, the `networks` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.networks.new](#fn-networksnew) 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.filestore_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `filestore_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, tier, diff --git a/4.x/_gen/resources/firestore_database.libsonnet b/4.x/_gen/resources/firestore_database.libsonnet index eac22fdc..b80b7ca9 100644 --- a/4.x/_gen/resources/firestore_database.libsonnet +++ b/4.x/_gen/resources/firestore_database.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='firestore_database', url='', help='`firestore_database` represents the `google_firestore_database` 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.firestore_database.new` injects a new `google_firestore_database` 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.firestore_database.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.firestore_database` using the reference:\n\n $._ref.google_firestore_database.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_firestore_database.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 - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: [\u0026#34;ENABLED\u0026#34;, \u0026#34;DISABLED\u0026#34;] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object.\n - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: [\u0026#34;OPTIMISTIC\u0026#34;, \u0026#34;PESSIMISTIC\u0026#34;, \u0026#34;OPTIMISTIC_WITH_ENTITY_GROUPS\u0026#34;] When `null`, the `concurrency_mode` field will be omitted from the resulting object.\n - `location_id` (`string`): The location of the database. Available databases are listed at\nhttps://cloud.google.com/firestore/docs/locations.\n - `name` (`string`): The ID to use for the database, which will become the final\ncomponent of the database\u0026#39;s resource name. This value should be 4-63\ncharacters. Valid characters are /[a-z][0-9]-/ with first character\na letter and the last a letter or a number. Must not be\nUUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.\n\u0026#34;(default)\u0026#34; database id is also valid.\n - `point_in_time_recovery_enablement` (`string`): Whether to enable the PITR feature on this database.\nIf \u0026#39;POINT_IN_TIME_RECOVERY_ENABLED\u0026#39; is selected, reads are supported on selected versions of the data from within the past 7 days.\nversionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour\nand reads against 1-minute snapshots beyond 1 hour and within 7 days.\nIf \u0026#39;POINT_IN_TIME_RECOVERY_DISABLED\u0026#39; is selected, reads are supported on any version of the data from within the past 1 hour. Default value: \u0026#34;POINT_IN_TIME_RECOVERY_DISABLED\u0026#34; Possible values: [\u0026#34;POINT_IN_TIME_RECOVERY_ENABLED\u0026#34;, \u0026#34;POINT_IN_TIME_RECOVERY_DISABLED\u0026#34;] When `null`, the `point_in_time_recovery_enablement` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `type` (`string`): The type of the database.\nSee https://cloud.google.com/datastore/docs/firestore-or-datastore\nfor information about how to choose. Possible values: [\u0026#34;FIRESTORE_NATIVE\u0026#34;, \u0026#34;DATASTORE_MODE\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.firestore_database.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.firestore_database.new` injects a new `google_firestore_database` 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.firestore_database.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.firestore_database` using the reference:\n\n $._ref.google_firestore_database.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_firestore_database.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 - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: [\u0026#34;ENABLED\u0026#34;, \u0026#34;DISABLED\u0026#34;] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object.\n - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: [\u0026#34;OPTIMISTIC\u0026#34;, \u0026#34;PESSIMISTIC\u0026#34;, \u0026#34;OPTIMISTIC_WITH_ENTITY_GROUPS\u0026#34;] When `null`, the `concurrency_mode` field will be omitted from the resulting object.\n - `delete_protection_state` (`string`): State of delete protection for the database. Possible values: [\u0026#34;DELETE_PROTECTION_STATE_UNSPECIFIED\u0026#34;, \u0026#34;DELETE_PROTECTION_ENABLED\u0026#34;, \u0026#34;DELETE_PROTECTION_DISABLED\u0026#34;] When `null`, the `delete_protection_state` field will be omitted from the resulting object.\n - `location_id` (`string`): The location of the database. Available locations are listed at\nhttps://cloud.google.com/firestore/docs/locations.\n - `name` (`string`): The ID to use for the database, which will become the final\ncomponent of the database\u0026#39;s resource name. This value should be 4-63\ncharacters. Valid characters are /[a-z][0-9]-/ with first character\na letter and the last a letter or a number. Must not be\nUUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.\n\u0026#34;(default)\u0026#34; database id is also valid.\n - `point_in_time_recovery_enablement` (`string`): Whether to enable the PITR feature on this database.\nIf \u0026#39;POINT_IN_TIME_RECOVERY_ENABLED\u0026#39; is selected, reads are supported on selected versions of the data from within the past 7 days.\nversionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour\nand reads against 1-minute snapshots beyond 1 hour and within 7 days.\nIf \u0026#39;POINT_IN_TIME_RECOVERY_DISABLED\u0026#39; is selected, reads are supported on any version of the data from within the past 1 hour. Default value: \u0026#34;POINT_IN_TIME_RECOVERY_DISABLED\u0026#34; Possible values: [\u0026#34;POINT_IN_TIME_RECOVERY_ENABLED\u0026#34;, \u0026#34;POINT_IN_TIME_RECOVERY_DISABLED\u0026#34;] When `null`, the `point_in_time_recovery_enablement` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `type` (`string`): The type of the database.\nSee https://cloud.google.com/datastore/docs/firestore-or-datastore\nfor information about how to choose. Possible values: [\u0026#34;FIRESTORE_NATIVE\u0026#34;, \u0026#34;DATASTORE_MODE\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.firestore_database.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, location_id, @@ -10,6 +10,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type, app_engine_integration_mode=null, concurrency_mode=null, + delete_protection_state=null, point_in_time_recovery_enablement=null, project=null, timeouts=null, @@ -20,6 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs( app_engine_integration_mode=app_engine_integration_mode, concurrency_mode=concurrency_mode, + delete_protection_state=delete_protection_state, location_id=location_id, name=name, point_in_time_recovery_enablement=point_in_time_recovery_enablement, @@ -29,19 +31,21 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.firestore_database.newAttrs` constructs a new object with attributes and blocks configured for the `firestore_database`\nTerraform resource.\n\nUnlike [google.firestore_database.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 - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object.\n - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"] When `null`, the `concurrency_mode` field will be omitted from the resulting object.\n - `location_id` (`string`): The location of the database. Available databases are listed at\nhttps://cloud.google.com/firestore/docs/locations.\n - `name` (`string`): The ID to use for the database, which will become the final\ncomponent of the database's resource name. This value should be 4-63\ncharacters. Valid characters are /[a-z][0-9]-/ with first character\na letter and the last a letter or a number. Must not be\nUUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.\n"(default)" database id is also valid.\n - `point_in_time_recovery_enablement` (`string`): Whether to enable the PITR feature on this database.\nIf 'POINT_IN_TIME_RECOVERY_ENABLED' is selected, reads are supported on selected versions of the data from within the past 7 days.\nversionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour\nand reads against 1-minute snapshots beyond 1 hour and within 7 days.\nIf 'POINT_IN_TIME_RECOVERY_DISABLED' is selected, reads are supported on any version of the data from within the past 1 hour. Default value: "POINT_IN_TIME_RECOVERY_DISABLED" Possible values: ["POINT_IN_TIME_RECOVERY_ENABLED", "POINT_IN_TIME_RECOVERY_DISABLED"] When `null`, the `point_in_time_recovery_enablement` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `type` (`string`): The type of the database.\nSee https://cloud.google.com/datastore/docs/firestore-or-datastore\nfor information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"]\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.firestore_database.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 `firestore_database` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.firestore_database.newAttrs` constructs a new object with attributes and blocks configured for the `firestore_database`\nTerraform resource.\n\nUnlike [google.firestore_database.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 - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object.\n - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"] When `null`, the `concurrency_mode` field will be omitted from the resulting object.\n - `delete_protection_state` (`string`): State of delete protection for the database. Possible values: ["DELETE_PROTECTION_STATE_UNSPECIFIED", "DELETE_PROTECTION_ENABLED", "DELETE_PROTECTION_DISABLED"] When `null`, the `delete_protection_state` field will be omitted from the resulting object.\n - `location_id` (`string`): The location of the database. Available locations are listed at\nhttps://cloud.google.com/firestore/docs/locations.\n - `name` (`string`): The ID to use for the database, which will become the final\ncomponent of the database's resource name. This value should be 4-63\ncharacters. Valid characters are /[a-z][0-9]-/ with first character\na letter and the last a letter or a number. Must not be\nUUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.\n"(default)" database id is also valid.\n - `point_in_time_recovery_enablement` (`string`): Whether to enable the PITR feature on this database.\nIf 'POINT_IN_TIME_RECOVERY_ENABLED' is selected, reads are supported on selected versions of the data from within the past 7 days.\nversionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour\nand reads against 1-minute snapshots beyond 1 hour and within 7 days.\nIf 'POINT_IN_TIME_RECOVERY_DISABLED' is selected, reads are supported on any version of the data from within the past 1 hour. Default value: "POINT_IN_TIME_RECOVERY_DISABLED" Possible values: ["POINT_IN_TIME_RECOVERY_ENABLED", "POINT_IN_TIME_RECOVERY_DISABLED"] When `null`, the `point_in_time_recovery_enablement` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `type` (`string`): The type of the database.\nSee https://cloud.google.com/datastore/docs/firestore-or-datastore\nfor information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"]\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.firestore_database.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 `firestore_database` resource into the root Terraform configuration.\n', args=[]), newAttrs( location_id, name, type, app_engine_integration_mode=null, concurrency_mode=null, + delete_protection_state=null, point_in_time_recovery_enablement=null, project=null, timeouts=null ):: std.prune(a={ app_engine_integration_mode: app_engine_integration_mode, concurrency_mode: concurrency_mode, + delete_protection_state: delete_protection_state, location_id: location_id, name: name, point_in_time_recovery_enablement: point_in_time_recovery_enablement, @@ -81,6 +85,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withDeleteProtectionState':: d.fn(help='`google.string.withDeleteProtectionState` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the delete_protection_state 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 `delete_protection_state` field.\n', args=[]), + withDeleteProtectionState(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + delete_protection_state: value, + }, + }, + }, + }, '#withLocationId':: d.fn(help='`google.string.withLocationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location_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 `location_id` field.\n', args=[]), withLocationId(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/gke_backup_restore_plan.libsonnet b/4.x/_gen/resources/gke_backup_restore_plan.libsonnet new file mode 100644 index 00000000..f126671e --- /dev/null +++ b/4.x/_gen/resources/gke_backup_restore_plan.libsonnet @@ -0,0 +1,320 @@ +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='gke_backup_restore_plan', url='', help='`gke_backup_restore_plan` represents the `google_gke_backup_restore_plan` 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.gke_backup_restore_plan.new` injects a new `google_gke_backup_restore_plan` 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.gke_backup_restore_plan.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_backup_restore_plan` using the reference:\n\n $._ref.google_gke_backup_restore_plan.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_backup_restore_plan.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `backup_plan` (`string`): A reference to the BackupPlan from which Backups may be used\nas the source for Restores created via this RestorePlan.\n - `cluster` (`string`): The source cluster from which Restores will be created via this RestorePlan.\n - `description` (`string`): User specified descriptive string for this RestorePlan. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Description: A set of custom labels supplied by the user.\nA list of key-\u0026gt;value pairs.\nExample: { \u0026#34;name\u0026#34;: \u0026#34;wrench\u0026#34;, \u0026#34;mass\u0026#34;: \u0026#34;1.3kg\u0026#34;, \u0026#34;count\u0026#34;: \u0026#34;3\u0026#34; }. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The region of the Restore Plan.\n - `name` (`string`): The full name of the BackupPlan Resource.\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 - `restore_config` (`list[obj]`): Defines the configuration of Restores created via this RestorePlan. When `null`, the `restore_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.gke_backup_restore_plan.restore_config.new](#fn-restore_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.gke_backup_restore_plan.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + backup_plan, + cluster, + location, + name, + description=null, + labels=null, + project=null, + restore_config=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_gke_backup_restore_plan', + label=resourceLabel, + attrs=self.newAttrs( + backup_plan=backup_plan, + cluster=cluster, + description=description, + labels=labels, + location=location, + name=name, + project=project, + restore_config=restore_config, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_backup_restore_plan.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan`\nTerraform resource.\n\nUnlike [google.gke_backup_restore_plan.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `backup_plan` (`string`): A reference to the BackupPlan from which Backups may be used\nas the source for Restores created via this RestorePlan.\n - `cluster` (`string`): The source cluster from which Restores will be created via this RestorePlan.\n - `description` (`string`): User specified descriptive string for this RestorePlan. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Description: A set of custom labels supplied by the user.\nA list of key->value pairs.\nExample: { "name": "wrench", "mass": "1.3kg", "count": "3" }. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The region of the Restore Plan.\n - `name` (`string`): The full name of the BackupPlan Resource.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `restore_config` (`list[obj]`): Defines the configuration of Restores created via this RestorePlan. When `null`, the `restore_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.gke_backup_restore_plan.restore_config.new](#fn-restore_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.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 `gke_backup_restore_plan` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + backup_plan, + cluster, + location, + name, + description=null, + labels=null, + project=null, + restore_config=null, + timeouts=null + ):: std.prune(a={ + backup_plan: backup_plan, + cluster: cluster, + description: description, + labels: labels, + location: location, + name: name, + project: project, + restore_config: restore_config, + timeouts: timeouts, + }), + restore_config:: { + cluster_resource_restore_scope:: { + excluded_group_kinds:: { + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.excluded_group_kinds.new` constructs a new object with attributes and blocks configured for the `excluded_group_kinds`\nTerraform sub block.\n\n\n\n**Args**:\n - `resource_group` (`string`): API Group string of a Kubernetes resource, e.g.\n"apiextensions.k8s.io", "storage.k8s.io", etc.\nUse empty string for core group. When `null`, the `resource_group` field will be omitted from the resulting object.\n - `resource_kind` (`string`): Kind of a Kubernetes resource, e.g.\n"CustomResourceDefinition", "StorageClass", etc. When `null`, the `resource_kind` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `excluded_group_kinds` sub block.\n', args=[]), + new( + resource_group=null, + resource_kind=null + ):: std.prune(a={ + resource_group: resource_group, + resource_kind: resource_kind, + }), + }, + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.new` constructs a new object with attributes and blocks configured for the `cluster_resource_restore_scope`\nTerraform sub block.\n\n\n\n**Args**:\n - `all_group_kinds` (`bool`): If True, all valid cluster-scoped resources will be restored.\nMutually exclusive to any other field in 'clusterResourceRestoreScope'. When `null`, the `all_group_kinds` field will be omitted from the resulting object.\n - `no_group_kinds` (`bool`): If True, no cluster-scoped resources will be restored.\nMutually exclusive to any other field in 'clusterResourceRestoreScope'. When `null`, the `no_group_kinds` field will be omitted from the resulting object.\n - `excluded_group_kinds` (`list[obj]`): A list of cluster-scoped resource group kinds to NOT restore from the backup.\nIf specified, all valid cluster-scoped resources will be restored except\nfor those specified in the list.\nMutually exclusive to any other field in 'clusterResourceRestoreScope'. When `null`, the `excluded_group_kinds` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.excluded_group_kinds.new](#fn-restore_configrestore_configexcluded_group_kindsnew) constructor.\n - `selected_group_kinds` (`list[obj]`): A list of cluster-scoped resource group kinds to restore from the backup.\nIf specified, only the selected resources will be restored.\nMutually exclusive to any other field in the 'clusterResourceRestoreScope'. When `null`, the `selected_group_kinds` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.selected_group_kinds.new](#fn-restore_configrestore_configselected_group_kindsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cluster_resource_restore_scope` sub block.\n', args=[]), + new( + all_group_kinds=null, + excluded_group_kinds=null, + no_group_kinds=null, + selected_group_kinds=null + ):: std.prune(a={ + all_group_kinds: all_group_kinds, + excluded_group_kinds: excluded_group_kinds, + no_group_kinds: no_group_kinds, + selected_group_kinds: selected_group_kinds, + }), + selected_group_kinds:: { + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.selected_group_kinds.new` constructs a new object with attributes and blocks configured for the `selected_group_kinds`\nTerraform sub block.\n\n\n\n**Args**:\n - `resource_group` (`string`): API Group string of a Kubernetes resource, e.g.\n"apiextensions.k8s.io", "storage.k8s.io", etc.\nUse empty string for core group. When `null`, the `resource_group` field will be omitted from the resulting object.\n - `resource_kind` (`string`): Kind of a Kubernetes resource, e.g.\n"CustomResourceDefinition", "StorageClass", etc. When `null`, the `resource_kind` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `selected_group_kinds` sub block.\n', args=[]), + new( + resource_group=null, + resource_kind=null + ):: std.prune(a={ + resource_group: resource_group, + resource_kind: resource_kind, + }), + }, + }, + excluded_namespaces:: { + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.excluded_namespaces.new` constructs a new object with attributes and blocks configured for the `excluded_namespaces`\nTerraform sub block.\n\n\n\n**Args**:\n - `namespaces` (`list`): A list of Kubernetes Namespaces.\n\n**Returns**:\n - An attribute object that represents the `excluded_namespaces` sub block.\n', args=[]), + new( + namespaces + ):: std.prune(a={ + namespaces: namespaces, + }), + }, + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.new` constructs a new object with attributes and blocks configured for the `restore_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `all_namespaces` (`bool`): If True, restore all namespaced resources in the Backup.\nSetting this field to False will result in an error. When `null`, the `all_namespaces` field will be omitted from the resulting object.\n - `cluster_resource_conflict_policy` (`string`): Defines the behavior for handling the situation where cluster-scoped resources\nbeing restored already exist in the target cluster.\nThis MUST be set to a value other than 'CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED'\nif 'clusterResourceRestoreScope' is anyting other than 'noGroupKinds'.\nSee https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#clusterresourceconflictpolicy\nfor more information on each policy option. Possible values: ["USE_EXISTING_VERSION", "USE_BACKUP_VERSION"] When `null`, the `cluster_resource_conflict_policy` field will be omitted from the resulting object.\n - `namespaced_resource_restore_mode` (`string`): Defines the behavior for handling the situation where sets of namespaced resources\nbeing restored already exist in the target cluster.\nThis MUST be set to a value other than 'NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED'\nif the 'namespacedResourceRestoreScope' is anything other than 'noNamespaces'.\nSee https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#namespacedresourcerestoremode\nfor more information on each mode. Possible values: ["DELETE_AND_RESTORE", "FAIL_ON_CONFLICT"] When `null`, the `namespaced_resource_restore_mode` field will be omitted from the resulting object.\n - `no_namespaces` (`bool`): Do not restore any namespaced resources if set to "True".\nSpecifying this field to "False" is not allowed. When `null`, the `no_namespaces` field will be omitted from the resulting object.\n - `volume_data_restore_policy` (`string`): Specifies the mechanism to be used to restore volume data.\nThis should be set to a value other than 'NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED'\nif the 'namespacedResourceRestoreScope' is anything other than 'noNamespaces'.\nIf not specified, it will be treated as 'NO_VOLUME_DATA_RESTORATION'.\nSee https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#VolumeDataRestorePolicy\nfor more information on each policy option. Possible values: ["RESTORE_VOLUME_DATA_FROM_BACKUP", "REUSE_VOLUME_HANDLE_FROM_BACKUP", "NO_VOLUME_DATA_RESTORATION"] When `null`, the `volume_data_restore_policy` field will be omitted from the resulting object.\n - `cluster_resource_restore_scope` (`list[obj]`): Identifies the cluster-scoped resources to restore from the Backup. When `null`, the `cluster_resource_restore_scope` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.new](#fn-restore_configcluster_resource_restore_scopenew) constructor.\n - `excluded_namespaces` (`list[obj]`): A list of selected namespaces excluded from restoration.\nAll namespaces except those in this list will be restored. When `null`, the `excluded_namespaces` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.excluded_namespaces.new](#fn-restore_configexcluded_namespacesnew) constructor.\n - `selected_applications` (`list[obj]`): A list of selected ProtectedApplications to restore.\nThe listed ProtectedApplications and all the resources\nto which they refer will be restored. When `null`, the `selected_applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.selected_applications.new](#fn-restore_configselected_applicationsnew) constructor.\n - `selected_namespaces` (`list[obj]`): A list of selected namespaces to restore from the Backup.\nThe listed Namespaces and all resources contained in them will be restored. When `null`, the `selected_namespaces` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.selected_namespaces.new](#fn-restore_configselected_namespacesnew) constructor.\n - `transformation_rules` (`list[obj]`): A list of transformation rules to be applied against Kubernetes\nresources as they are selected for restoration from a Backup.\nRules are executed in order defined - this order matters,\nas changes made by a rule may impact the filtering logic of subsequent\nrules. An empty list means no transformation will occur. When `null`, the `transformation_rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.transformation_rules.new](#fn-restore_configtransformation_rulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `restore_config` sub block.\n', args=[]), + new( + all_namespaces=null, + cluster_resource_conflict_policy=null, + cluster_resource_restore_scope=null, + excluded_namespaces=null, + namespaced_resource_restore_mode=null, + no_namespaces=null, + selected_applications=null, + selected_namespaces=null, + transformation_rules=null, + volume_data_restore_policy=null + ):: std.prune(a={ + all_namespaces: all_namespaces, + cluster_resource_conflict_policy: cluster_resource_conflict_policy, + cluster_resource_restore_scope: cluster_resource_restore_scope, + excluded_namespaces: excluded_namespaces, + namespaced_resource_restore_mode: namespaced_resource_restore_mode, + no_namespaces: no_namespaces, + selected_applications: selected_applications, + selected_namespaces: selected_namespaces, + transformation_rules: transformation_rules, + volume_data_restore_policy: volume_data_restore_policy, + }), + selected_applications:: { + namespaced_names:: { + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.selected_applications.namespaced_names.new` constructs a new object with attributes and blocks configured for the `namespaced_names`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): The name of a Kubernetes Resource.\n - `namespace` (`string`): The namespace of a Kubernetes Resource.\n\n**Returns**:\n - An attribute object that represents the `namespaced_names` sub block.\n', args=[]), + new( + name, + namespace + ):: std.prune(a={ + name: name, + namespace: namespace, + }), + }, + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.selected_applications.new` constructs a new object with attributes and blocks configured for the `selected_applications`\nTerraform sub block.\n\n\n\n**Args**:\n - `namespaced_names` (`list[obj]`): A list of namespaced Kubernetes resources. When `null`, the `namespaced_names` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.selected_applications.namespaced_names.new](#fn-restore_configrestore_confignamespaced_namesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `selected_applications` sub block.\n', args=[]), + new( + namespaced_names=null + ):: std.prune(a={ + namespaced_names: namespaced_names, + }), + }, + selected_namespaces:: { + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.selected_namespaces.new` constructs a new object with attributes and blocks configured for the `selected_namespaces`\nTerraform sub block.\n\n\n\n**Args**:\n - `namespaces` (`list`): A list of Kubernetes Namespaces.\n\n**Returns**:\n - An attribute object that represents the `selected_namespaces` sub block.\n', args=[]), + new( + namespaces + ):: std.prune(a={ + namespaces: namespaces, + }), + }, + transformation_rules:: { + field_actions:: { + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.transformation_rules.field_actions.new` constructs a new object with attributes and blocks configured for the `field_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `from_path` (`string`): A string containing a JSON Pointer value that references the\nlocation in the target document to move the value from. When `null`, the `from_path` field will be omitted from the resulting object.\n - `op` (`string`): Specifies the operation to perform. Possible values: ["REMOVE", "MOVE", "COPY", "ADD", "TEST", "REPLACE"]\n - `path` (`string`): A string containing a JSON-Pointer value that references a\nlocation within the target document where the operation is performed. When `null`, the `path` field will be omitted from the resulting object.\n - `value` (`string`): A string that specifies the desired value in string format\nto use for transformation. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `field_actions` sub block.\n', args=[]), + new( + op, + from_path=null, + path=null, + value=null + ):: std.prune(a={ + from_path: from_path, + op: op, + path: path, + value: value, + }), + }, + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.transformation_rules.new` constructs a new object with attributes and blocks configured for the `transformation_rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): The description is a user specified string description\nof the transformation rule. When `null`, the `description` field will be omitted from the resulting object.\n - `field_actions` (`list[obj]`): A list of transformation rule actions to take against candidate\nresources. Actions are executed in order defined - this order\nmatters, as they could potentially interfere with each other and\nthe first operation could affect the outcome of the second operation. When `null`, the `field_actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.transformation_rules.field_actions.new](#fn-restore_configrestore_configfield_actionsnew) constructor.\n - `resource_filter` (`list[obj]`): This field is used to specify a set of fields that should be used to\ndetermine which resources in backup should be acted upon by the\nsupplied transformation rule actions, and this will ensure that only\nspecific resources are affected by transformation rule actions. When `null`, the `resource_filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.transformation_rules.resource_filter.new](#fn-restore_configrestore_configresource_filternew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transformation_rules` sub block.\n', args=[]), + new( + description=null, + field_actions=null, + resource_filter=null + ):: std.prune(a={ + description: description, + field_actions: field_actions, + resource_filter: resource_filter, + }), + resource_filter:: { + group_kinds:: { + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.transformation_rules.resource_filter.group_kinds.new` constructs a new object with attributes and blocks configured for the `group_kinds`\nTerraform sub block.\n\n\n\n**Args**:\n - `resource_group` (`string`): API Group string of a Kubernetes resource, e.g.\n"apiextensions.k8s.io", "storage.k8s.io", etc.\nUse empty string for core group. When `null`, the `resource_group` field will be omitted from the resulting object.\n - `resource_kind` (`string`): Kind of a Kubernetes resource, e.g.\n"CustomResourceDefinition", "StorageClass", etc. When `null`, the `resource_kind` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `group_kinds` sub block.\n', args=[]), + new( + resource_group=null, + resource_kind=null + ):: std.prune(a={ + resource_group: resource_group, + resource_kind: resource_kind, + }), + }, + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.restore_config.transformation_rules.resource_filter.new` constructs a new object with attributes and blocks configured for the `resource_filter`\nTerraform sub block.\n\n\n\n**Args**:\n - `json_path` (`string`): This is a JSONPath expression that matches specific fields of\ncandidate resources and it operates as a filtering parameter\n(resources that are not matched with this expression will not\nbe candidates for transformation). When `null`, the `json_path` field will be omitted from the resulting object.\n - `namespaces` (`list`): (Filtering parameter) Any resource subject to transformation must\nbe contained within one of the listed Kubernetes Namespace in the\nBackup. If this field is not provided, no namespace filtering will\nbe performed (all resources in all Namespaces, including all\ncluster-scoped resources, will be candidates for transformation).\nTo mix cluster-scoped and namespaced resources in the same rule,\nuse an empty string ("") as one of the target namespaces. When `null`, the `namespaces` field will be omitted from the resulting object.\n - `group_kinds` (`list[obj]`): (Filtering parameter) Any resource subject to transformation must\nbelong to one of the listed "types". If this field is not provided,\nno type filtering will be performed\n(all resources of all types matching previous filtering parameters\nwill be candidates for transformation). When `null`, the `group_kinds` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.transformation_rules.resource_filter.group_kinds.new](#fn-restore_configrestore_configtransformation_rulesgroup_kindsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `resource_filter` sub block.\n', args=[]), + new( + group_kinds=null, + json_path=null, + namespaces=null + ):: std.prune(a={ + group_kinds: group_kinds, + json_path: json_path, + namespaces: namespaces, + }), + }, + }, + }, + timeouts:: { + '#new':: d.fn(help='\n`google.gke_backup_restore_plan.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, + }), + }, + '#withBackupPlan':: d.fn(help='`google.string.withBackupPlan` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the backup_plan field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `backup_plan` field.\n', args=[]), + withBackupPlan(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [resourceLabel]+: { + backup_plan: value, + }, + }, + }, + }, + '#withCluster':: d.fn(help='`google.string.withCluster` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the cluster 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 `cluster` field.\n', args=[]), + withCluster(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [resourceLabel]+: { + cluster: 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_gke_backup_restore_plan+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google.obj.withLabels` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the labels field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `labels` field.\n', args=[]), + withLabels(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRestoreConfig':: d.fn(help='`google.list[obj].withRestoreConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the restore_config 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].withRestoreConfigMixin](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 `restore_config` field.\n', args=[]), + withRestoreConfig(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [resourceLabel]+: { + restore_config: value, + }, + }, + }, + }, + '#withRestoreConfigMixin':: d.fn(help='`google.list[obj].withRestoreConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the restore_config 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].withRestoreConfig](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 `restore_config` field.\n', args=[]), + withRestoreConfigMixin(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [resourceLabel]+: { + restore_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan+: { + [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_gke_backup_restore_plan+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_backup_restore_plan_iam_binding.libsonnet b/4.x/_gen/resources/gke_backup_restore_plan_iam_binding.libsonnet new file mode 100644 index 00000000..09259cd9 --- /dev/null +++ b/4.x/_gen/resources/gke_backup_restore_plan_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='gke_backup_restore_plan_iam_binding', url='', help='`gke_backup_restore_plan_iam_binding` represents the `google_gke_backup_restore_plan_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.gke_backup_restore_plan_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.gke_backup_restore_plan_iam_binding.new` injects a new `google_gke_backup_restore_plan_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.gke_backup_restore_plan_iam_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_backup_restore_plan_iam_binding` using the reference:\n\n $._ref.google_gke_backup_restore_plan_iam_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_backup_restore_plan_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 - `location` (`string`): Set the `location` field on the resulting resource block. When `null`, the `location` field will be omitted from the resulting object.\n - `members` (`list`): Set the `members` field on the resulting resource block.\n - `name` (`string`): Set the `name` 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 - `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.gke_backup_restore_plan_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, + name, + role, + condition=null, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_gke_backup_restore_plan_iam_binding', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + location=location, + members=members, + name=name, + project=project, + role=role + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_backup_restore_plan_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan_iam_binding`\nTerraform resource.\n\nUnlike [google.gke_backup_restore_plan_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 - `location` (`string`): Set the `location` field on the resulting object. When `null`, the `location` field will be omitted from the resulting object.\n - `members` (`list`): Set the `members` field on the resulting object.\n - `name` (`string`): Set the `name` 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 - `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.gke_backup_restore_plan_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 `gke_backup_restore_plan_iam_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + members, + name, + role, + condition=null, + location=null, + project=null + ):: std.prune(a={ + condition: condition, + location: location, + members: members, + name: name, + project: project, + 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_gke_backup_restore_plan_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_gke_backup_restore_plan_iam_binding+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan_iam_binding+: { + [resourceLabel]+: { + location: 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_gke_backup_restore_plan_iam_binding+: { + [resourceLabel]+: { + members: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan_iam_binding+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan_iam_binding+: { + [resourceLabel]+: { + project: 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_gke_backup_restore_plan_iam_binding+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_backup_restore_plan_iam_member.libsonnet b/4.x/_gen/resources/gke_backup_restore_plan_iam_member.libsonnet new file mode 100644 index 00000000..49e27e45 --- /dev/null +++ b/4.x/_gen/resources/gke_backup_restore_plan_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='gke_backup_restore_plan_iam_member', url='', help='`gke_backup_restore_plan_iam_member` represents the `google_gke_backup_restore_plan_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.gke_backup_restore_plan_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.gke_backup_restore_plan_iam_member.new` injects a new `google_gke_backup_restore_plan_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.gke_backup_restore_plan_iam_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_backup_restore_plan_iam_member` using the reference:\n\n $._ref.google_gke_backup_restore_plan_iam_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_backup_restore_plan_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 - `location` (`string`): Set the `location` field on the resulting resource block. When `null`, the `location` field will be omitted from the resulting object.\n - `member` (`string`): Set the `member` field on the resulting resource block.\n - `name` (`string`): Set the `name` 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 - `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.gke_backup_restore_plan_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, + name, + role, + condition=null, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_gke_backup_restore_plan_iam_member', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + location=location, + member=member, + name=name, + project=project, + role=role + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_backup_restore_plan_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan_iam_member`\nTerraform resource.\n\nUnlike [google.gke_backup_restore_plan_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 - `location` (`string`): Set the `location` field on the resulting object. When `null`, the `location` field will be omitted from the resulting object.\n - `member` (`string`): Set the `member` field on the resulting object.\n - `name` (`string`): Set the `name` 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 - `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.gke_backup_restore_plan_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 `gke_backup_restore_plan_iam_member` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + member, + name, + role, + condition=null, + location=null, + project=null + ):: std.prune(a={ + condition: condition, + location: location, + member: member, + name: name, + project: project, + 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_gke_backup_restore_plan_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_gke_backup_restore_plan_iam_member+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan_iam_member+: { + [resourceLabel]+: { + location: 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_gke_backup_restore_plan_iam_member+: { + [resourceLabel]+: { + member: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan_iam_member+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan_iam_member+: { + [resourceLabel]+: { + project: 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_gke_backup_restore_plan_iam_member+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_backup_restore_plan_iam_policy.libsonnet b/4.x/_gen/resources/gke_backup_restore_plan_iam_policy.libsonnet new file mode 100644 index 00000000..01a509d4 --- /dev/null +++ b/4.x/_gen/resources/gke_backup_restore_plan_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='gke_backup_restore_plan_iam_policy', url='', help='`gke_backup_restore_plan_iam_policy` represents the `google_gke_backup_restore_plan_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.gke_backup_restore_plan_iam_policy.new` injects a new `google_gke_backup_restore_plan_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.gke_backup_restore_plan_iam_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_backup_restore_plan_iam_policy` using the reference:\n\n $._ref.google_gke_backup_restore_plan_iam_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_backup_restore_plan_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 - `location` (`string`): Set the `location` field on the resulting resource block. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource 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\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + name, + policy_data, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_gke_backup_restore_plan_iam_policy', + label=resourceLabel, + attrs=self.newAttrs( + location=location, + name=name, + policy_data=policy_data, + project=project + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_backup_restore_plan_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan_iam_policy`\nTerraform resource.\n\nUnlike [google.gke_backup_restore_plan_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 - `location` (`string`): Set the `location` field on the resulting object. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\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\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 `gke_backup_restore_plan_iam_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + policy_data, + location=null, + project=null + ):: std.prune(a={ + location: location, + name: name, + policy_data: policy_data, + project: project, + }), + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan_iam_policy+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_gke_backup_restore_plan_iam_policy+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#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_gke_backup_restore_plan_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_gke_backup_restore_plan_iam_policy+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/identity_platform_config.libsonnet b/4.x/_gen/resources/identity_platform_config.libsonnet index 35d70065..bb47898b 100644 --- a/4.x/_gen/resources/identity_platform_config.libsonnet +++ b/4.x/_gen/resources/identity_platform_config.libsonnet @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`google.identity_platform_config.new` injects a new `google_identity_platform_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.identity_platform_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.identity_platform_config` using the reference:\n\n $._ref.google_identity_platform_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_identity_platform_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 - `authorized_domains` (`list`): List of domains authorized for OAuth redirects. When `null`, the `authorized_domains` field will be omitted from the resulting object.\n - `autodelete_anonymous_users` (`bool`): Whether anonymous users will be auto-deleted after a period of 30 days When `null`, the `autodelete_anonymous_users` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `blocking_functions` (`list[obj]`): Configuration related to blocking functions. When `null`, the `blocking_functions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.blocking_functions.new](#fn-blocking_functionsnew) constructor.\n - `quota` (`list[obj]`): Configuration related to quotas. When `null`, the `quota` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.quota.new](#fn-quotanew) 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.identity_platform_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':: d.fn(help="\n`google.identity_platform_config.new` injects a new `google_identity_platform_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.identity_platform_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.identity_platform_config` using the reference:\n\n $._ref.google_identity_platform_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_identity_platform_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 - `authorized_domains` (`list`): List of domains authorized for OAuth redirects. When `null`, the `authorized_domains` field will be omitted from the resulting object.\n - `autodelete_anonymous_users` (`bool`): Whether anonymous users will be auto-deleted after a period of 30 days When `null`, the `autodelete_anonymous_users` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `blocking_functions` (`list[obj]`): Configuration related to blocking functions. When `null`, the `blocking_functions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.blocking_functions.new](#fn-blocking_functionsnew) constructor.\n - `quota` (`list[obj]`): Configuration related to quotas. When `null`, the `quota` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.quota.new](#fn-quotanew) constructor.\n - `sign_in` (`list[obj]`): Configuration related to local sign in methods. When `null`, the `sign_in` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.new](#fn-sign_innew) 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.identity_platform_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, authorized_domains=null, @@ -42,6 +42,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); blocking_functions=null, project=null, quota=null, + sign_in=null, timeouts=null, _meta={} ):: tf.withResource( @@ -53,17 +54,19 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); blocking_functions=blocking_functions, project=project, quota=quota, + sign_in=sign_in, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.identity_platform_config.newAttrs` constructs a new object with attributes and blocks configured for the `identity_platform_config`\nTerraform resource.\n\nUnlike [google.identity_platform_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 - `authorized_domains` (`list`): List of domains authorized for OAuth redirects. When `null`, the `authorized_domains` field will be omitted from the resulting object.\n - `autodelete_anonymous_users` (`bool`): Whether anonymous users will be auto-deleted after a period of 30 days When `null`, the `autodelete_anonymous_users` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `blocking_functions` (`list[obj]`): Configuration related to blocking functions. When `null`, the `blocking_functions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.blocking_functions.new](#fn-blocking_functionsnew) constructor.\n - `quota` (`list[obj]`): Configuration related to quotas. When `null`, the `quota` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.quota.new](#fn-quotanew) 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.identity_platform_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 `identity_platform_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.identity_platform_config.newAttrs` constructs a new object with attributes and blocks configured for the `identity_platform_config`\nTerraform resource.\n\nUnlike [google.identity_platform_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 - `authorized_domains` (`list`): List of domains authorized for OAuth redirects. When `null`, the `authorized_domains` field will be omitted from the resulting object.\n - `autodelete_anonymous_users` (`bool`): Whether anonymous users will be auto-deleted after a period of 30 days When `null`, the `autodelete_anonymous_users` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `blocking_functions` (`list[obj]`): Configuration related to blocking functions. When `null`, the `blocking_functions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.blocking_functions.new](#fn-blocking_functionsnew) constructor.\n - `quota` (`list[obj]`): Configuration related to quotas. When `null`, the `quota` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.quota.new](#fn-quotanew) constructor.\n - `sign_in` (`list[obj]`): Configuration related to local sign in methods. When `null`, the `sign_in` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.new](#fn-sign_innew) 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.identity_platform_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 `identity_platform_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( authorized_domains=null, autodelete_anonymous_users=null, blocking_functions=null, project=null, quota=null, + sign_in=null, timeouts=null ):: std.prune(a={ authorized_domains: authorized_domains, @@ -71,6 +74,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); blocking_functions: blocking_functions, project: project, quota: quota, + sign_in: sign_in, timeouts: timeouts, }), quota:: { @@ -93,6 +97,48 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, + sign_in:: { + anonymous:: { + '#new':: d.fn(help='\n`google.identity_platform_config.sign_in.anonymous.new` constructs a new object with attributes and blocks configured for the `anonymous`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether anonymous user auth is enabled for the project or not.\n\n**Returns**:\n - An attribute object that represents the `anonymous` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, + email:: { + '#new':: d.fn(help='\n`google.identity_platform_config.sign_in.email.new` constructs a new object with attributes and blocks configured for the `email`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether email auth is enabled for the project or not.\n - `password_required` (`bool`): Whether a password is required for email auth or not. If true, both an email and\npassword must be provided to sign in. If false, a user may sign in via either\nemail/password or email link. When `null`, the `password_required` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `email` sub block.\n', args=[]), + new( + enabled, + password_required=null + ):: std.prune(a={ + enabled: enabled, + password_required: password_required, + }), + }, + '#new':: d.fn(help='\n`google.identity_platform_config.sign_in.new` constructs a new object with attributes and blocks configured for the `sign_in`\nTerraform sub block.\n\n\n\n**Args**:\n - `allow_duplicate_emails` (`bool`): Whether to allow more than one account to have the same email. When `null`, the `allow_duplicate_emails` field will be omitted from the resulting object.\n - `anonymous` (`list[obj]`): Configuration options related to authenticating an anonymous user. When `null`, the `anonymous` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.anonymous.new](#fn-sign_inanonymousnew) constructor.\n - `email` (`list[obj]`): Configuration options related to authenticating a user by their email address. When `null`, the `email` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.email.new](#fn-sign_inemailnew) constructor.\n - `phone_number` (`list[obj]`): Configuration options related to authenticated a user by their phone number. When `null`, the `phone_number` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.phone_number.new](#fn-sign_inphone_numbernew) constructor.\n\n**Returns**:\n - An attribute object that represents the `sign_in` sub block.\n', args=[]), + new( + allow_duplicate_emails=null, + anonymous=null, + email=null, + phone_number=null + ):: std.prune(a={ + allow_duplicate_emails: allow_duplicate_emails, + anonymous: anonymous, + email: email, + phone_number: phone_number, + }), + phone_number:: { + '#new':: d.fn(help='\n`google.identity_platform_config.sign_in.phone_number.new` constructs a new object with attributes and blocks configured for the `phone_number`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether phone number auth is enabled for the project or not.\n - `test_phone_numbers` (`obj`): A map of <test phone number, fake code> that can be used for phone auth testing. When `null`, the `test_phone_numbers` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `phone_number` sub block.\n', args=[]), + new( + enabled, + test_phone_numbers=null + ):: std.prune(a={ + enabled: enabled, + test_phone_numbers: test_phone_numbers, + }), + }, + }, timeouts:: { '#new':: d.fn(help='\n`google.identity_platform_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( @@ -175,6 +221,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSignIn':: d.fn(help='`google.list[obj].withSignIn` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the sign_in 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].withSignInMixin](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 `sign_in` field.\n', args=[]), + withSignIn(resourceLabel, value): { + resource+: { + google_identity_platform_config+: { + [resourceLabel]+: { + sign_in: value, + }, + }, + }, + }, + '#withSignInMixin':: d.fn(help='`google.list[obj].withSignInMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the sign_in 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].withSignIn](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 `sign_in` field.\n', args=[]), + withSignInMixin(resourceLabel, value): { + resource+: { + google_identity_platform_config+: { + [resourceLabel]+: { + sign_in+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), withTimeouts(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/network_connectivity_spoke.libsonnet b/4.x/_gen/resources/network_connectivity_spoke.libsonnet index 6edcf937..24110b39 100644 --- a/4.x/_gen/resources/network_connectivity_spoke.libsonnet +++ b/4.x/_gen/resources/network_connectivity_spoke.libsonnet @@ -32,6 +32,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); site_to_site_data_transfer: site_to_site_data_transfer, }), }, + linked_vpc_network:: { + '#new':: d.fn(help='\n`google.network_connectivity_spoke.linked_vpc_network.new` constructs a new object with attributes and blocks configured for the `linked_vpc_network`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclude_export_ranges` (`list`): IP ranges encompassing the subnets to be excluded from peering. When `null`, the `exclude_export_ranges` field will be omitted from the resulting object.\n - `uri` (`string`): The URI of the VPC network resource.\n\n**Returns**:\n - An attribute object that represents the `linked_vpc_network` sub block.\n', args=[]), + new( + uri, + exclude_export_ranges=null + ):: std.prune(a={ + exclude_export_ranges: exclude_export_ranges, + uri: uri, + }), + }, linked_vpn_tunnels:: { '#new':: d.fn(help='\n`google.network_connectivity_spoke.linked_vpn_tunnels.new` constructs a new object with attributes and blocks configured for the `linked_vpn_tunnels`\nTerraform sub block.\n\n\n\n**Args**:\n - `site_to_site_data_transfer` (`bool`): A value that controls whether site-to-site data transfer is enabled for these resources. Note that data transfer is available only in supported locations.\n - `uris` (`list`): The URIs of linked VPN tunnel resources.\n\n**Returns**:\n - An attribute object that represents the `linked_vpn_tunnels` sub block.\n', args=[]), new( @@ -42,7 +52,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); uris: uris, }), }, - '#new':: d.fn(help="\n`google.network_connectivity_spoke.new` injects a new `google_network_connectivity_spoke` 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.network_connectivity_spoke.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.network_connectivity_spoke` using the reference:\n\n $._ref.google_network_connectivity_spoke.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_network_connectivity_spoke.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of the spoke. When `null`, the `description` field will be omitted from the resulting object.\n - `hub` (`string`): Immutable. The URI of the hub that this spoke is attached to.\n - `labels` (`obj`): Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): Immutable. The name of the spoke. Spoke names must be unique.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `linked_interconnect_attachments` (`list[obj]`): A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. When `null`, the `linked_interconnect_attachments` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_interconnect_attachments.new](#fn-linked_interconnect_attachmentsnew) constructor.\n - `linked_router_appliance_instances` (`list[obj]`): The URIs of linked Router appliance resources When `null`, the `linked_router_appliance_instances` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_router_appliance_instances.new](#fn-linked_router_appliance_instancesnew) constructor.\n - `linked_vpn_tunnels` (`list[obj]`): The URIs of linked VPN tunnel resources When `null`, the `linked_vpn_tunnels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpn_tunnels.new](#fn-linked_vpn_tunnelsnew) 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.network_connectivity_spoke.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.network_connectivity_spoke.new` injects a new `google_network_connectivity_spoke` 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.network_connectivity_spoke.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.network_connectivity_spoke` using the reference:\n\n $._ref.google_network_connectivity_spoke.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_network_connectivity_spoke.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of the spoke. When `null`, the `description` field will be omitted from the resulting object.\n - `hub` (`string`): Immutable. The URI of the hub that this spoke is attached to.\n - `labels` (`obj`): Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): Immutable. The name of the spoke. Spoke names must be unique.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `linked_interconnect_attachments` (`list[obj]`): A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. When `null`, the `linked_interconnect_attachments` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_interconnect_attachments.new](#fn-linked_interconnect_attachmentsnew) constructor.\n - `linked_router_appliance_instances` (`list[obj]`): The URIs of linked Router appliance resources When `null`, the `linked_router_appliance_instances` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_router_appliance_instances.new](#fn-linked_router_appliance_instancesnew) constructor.\n - `linked_vpc_network` (`list[obj]`): VPC network that is associated with the spoke. When `null`, the `linked_vpc_network` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpc_network.new](#fn-linked_vpc_networknew) constructor.\n - `linked_vpn_tunnels` (`list[obj]`): The URIs of linked VPN tunnel resources When `null`, the `linked_vpn_tunnels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpn_tunnels.new](#fn-linked_vpn_tunnelsnew) 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.network_connectivity_spoke.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, hub, @@ -52,6 +62,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels=null, linked_interconnect_attachments=null, linked_router_appliance_instances=null, + linked_vpc_network=null, linked_vpn_tunnels=null, project=null, timeouts=null, @@ -65,6 +76,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels=labels, linked_interconnect_attachments=linked_interconnect_attachments, linked_router_appliance_instances=linked_router_appliance_instances, + linked_vpc_network=linked_vpc_network, linked_vpn_tunnels=linked_vpn_tunnels, location=location, name=name, @@ -73,7 +85,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.network_connectivity_spoke.newAttrs` constructs a new object with attributes and blocks configured for the `network_connectivity_spoke`\nTerraform resource.\n\nUnlike [google.network_connectivity_spoke.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of the spoke. When `null`, the `description` field will be omitted from the resulting object.\n - `hub` (`string`): Immutable. The URI of the hub that this spoke is attached to.\n - `labels` (`obj`): Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): Immutable. The name of the spoke. Spoke names must be unique.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `linked_interconnect_attachments` (`list[obj]`): A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. When `null`, the `linked_interconnect_attachments` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_interconnect_attachments.new](#fn-linked_interconnect_attachmentsnew) constructor.\n - `linked_router_appliance_instances` (`list[obj]`): The URIs of linked Router appliance resources When `null`, the `linked_router_appliance_instances` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_router_appliance_instances.new](#fn-linked_router_appliance_instancesnew) constructor.\n - `linked_vpn_tunnels` (`list[obj]`): The URIs of linked VPN tunnel resources When `null`, the `linked_vpn_tunnels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpn_tunnels.new](#fn-linked_vpn_tunnelsnew) 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.network_connectivity_spoke.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 `network_connectivity_spoke` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.network_connectivity_spoke.newAttrs` constructs a new object with attributes and blocks configured for the `network_connectivity_spoke`\nTerraform resource.\n\nUnlike [google.network_connectivity_spoke.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of the spoke. When `null`, the `description` field will be omitted from the resulting object.\n - `hub` (`string`): Immutable. The URI of the hub that this spoke is attached to.\n - `labels` (`obj`): Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): Immutable. The name of the spoke. Spoke names must be unique.\n - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object.\n - `linked_interconnect_attachments` (`list[obj]`): A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. When `null`, the `linked_interconnect_attachments` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_interconnect_attachments.new](#fn-linked_interconnect_attachmentsnew) constructor.\n - `linked_router_appliance_instances` (`list[obj]`): The URIs of linked Router appliance resources When `null`, the `linked_router_appliance_instances` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_router_appliance_instances.new](#fn-linked_router_appliance_instancesnew) constructor.\n - `linked_vpc_network` (`list[obj]`): VPC network that is associated with the spoke. When `null`, the `linked_vpc_network` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpc_network.new](#fn-linked_vpc_networknew) constructor.\n - `linked_vpn_tunnels` (`list[obj]`): The URIs of linked VPN tunnel resources When `null`, the `linked_vpn_tunnels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpn_tunnels.new](#fn-linked_vpn_tunnelsnew) 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.network_connectivity_spoke.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 `network_connectivity_spoke` resource into the root Terraform configuration.\n', args=[]), newAttrs( hub, location, @@ -82,6 +94,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels=null, linked_interconnect_attachments=null, linked_router_appliance_instances=null, + linked_vpc_network=null, linked_vpn_tunnels=null, project=null, timeouts=null @@ -91,6 +104,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels: labels, linked_interconnect_attachments: linked_interconnect_attachments, linked_router_appliance_instances: linked_router_appliance_instances, + linked_vpc_network: linked_vpc_network, linked_vpn_tunnels: linked_vpn_tunnels, location: location, name: name, @@ -179,6 +193,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withLinkedVpcNetwork':: d.fn(help='`google.list[obj].withLinkedVpcNetwork` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the linked_vpc_network 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].withLinkedVpcNetworkMixin](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 `linked_vpc_network` field.\n', args=[]), + withLinkedVpcNetwork(resourceLabel, value): { + resource+: { + google_network_connectivity_spoke+: { + [resourceLabel]+: { + linked_vpc_network: value, + }, + }, + }, + }, + '#withLinkedVpcNetworkMixin':: d.fn(help='`google.list[obj].withLinkedVpcNetworkMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the linked_vpc_network 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].withLinkedVpcNetwork](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 `linked_vpc_network` field.\n', args=[]), + withLinkedVpcNetworkMixin(resourceLabel, value): { + resource+: { + google_network_connectivity_spoke+: { + [resourceLabel]+: { + linked_vpc_network+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withLinkedVpnTunnels':: d.fn(help='`google.list[obj].withLinkedVpnTunnels` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the linked_vpn_tunnels 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].withLinkedVpnTunnelsMixin](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 `linked_vpn_tunnels` field.\n', args=[]), withLinkedVpnTunnels(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/scc_project_custom_module.libsonnet b/4.x/_gen/resources/scc_project_custom_module.libsonnet new file mode 100644 index 00000000..d5141456 --- /dev/null +++ b/4.x/_gen/resources/scc_project_custom_module.libsonnet @@ -0,0 +1,194 @@ +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_project_custom_module', url='', help='`scc_project_custom_module` represents the `google_scc_project_custom_module` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + custom_config:: { + custom_output:: { + '#new':: d.fn(help='\n`google.scc_project_custom_module.custom_config.custom_output.new` constructs a new object with attributes and blocks configured for the `custom_output`\nTerraform sub block.\n\n\n\n**Args**:\n - `properties` (`list[obj]`): A list of custom output properties to add to the finding. When `null`, the `properties` 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_project_custom_module.custom_config.custom_output.properties.new](#fn-custom_configcustom_configpropertiesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_output` sub block.\n', args=[]), + new( + properties=null + ):: std.prune(a={ + properties: properties, + }), + properties:: { + '#new':: d.fn(help='\n`google.scc_project_custom_module.custom_config.custom_output.properties.new` constructs a new object with attributes and blocks configured for the `properties`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the property for the custom output. When `null`, the `name` field will be omitted from the resulting object.\n - `value_expression` (`list[obj]`): The CEL expression for the custom output. A resource property can be specified\nto return the value of the property or a text string enclosed in quotation marks. When `null`, the `value_expression` 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_project_custom_module.custom_config.custom_output.properties.value_expression.new](#fn-custom_configcustom_configcustom_outputvalue_expressionnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `properties` sub block.\n', args=[]), + new( + name=null, + value_expression=null + ):: std.prune(a={ + name: name, + value_expression: value_expression, + }), + value_expression:: { + '#new':: d.fn(help='\n`google.scc_project_custom_module.custom_config.custom_output.properties.value_expression.new` constructs a new object with attributes and blocks configured for the `value_expression`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Description of the expression. This is a longer text which describes the\nexpression, e.g. when hovered over it in a UI. When `null`, the `description` field will be omitted from the resulting object.\n - `expression` (`string`): Textual representation of an expression in Common Expression Language syntax.\n - `location` (`string`): String indicating the location of the expression for error reporting, e.g. a\nfile name and a position in the file. When `null`, the `location` field will be omitted from the resulting object.\n - `title` (`string`): Title for the expression, i.e. a short string describing its purpose. This can\nbe used e.g. in UIs which allow to enter the expression. When `null`, the `title` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `value_expression` sub block.\n', args=[]), + new( + expression, + description=null, + location=null, + title=null + ):: std.prune(a={ + description: description, + expression: expression, + location: location, + title: title, + }), + }, + }, + }, + '#new':: d.fn(help='\n`google.scc_project_custom_module.custom_config.new` constructs a new object with attributes and blocks configured for the `custom_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Text that describes the vulnerability or misconfiguration that the custom\nmodule detects. This explanation is returned with each finding instance to\nhelp investigators understand the detected issue. The text must be enclosed in quotation marks. When `null`, the `description` field will be omitted from the resulting object.\n - `recommendation` (`string`): An explanation of the recommended steps that security teams can take to resolve\nthe detected issue. This explanation is returned with each finding generated by\nthis module in the nextSteps property of the finding JSON.\n - `severity` (`string`): The severity to assign to findings generated by the module. Possible values: ["CRITICAL", "HIGH", "MEDIUM", "LOW"]\n - `custom_output` (`list[obj]`): Custom output properties. When `null`, the `custom_output` 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_project_custom_module.custom_config.custom_output.new](#fn-custom_configcustom_outputnew) constructor.\n - `predicate` (`list[obj]`): The CEL expression to evaluate to produce findings. When the expression evaluates\nto true against a resource, a finding is generated. When `null`, the `predicate` 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_project_custom_module.custom_config.predicate.new](#fn-custom_configpredicatenew) constructor.\n - `resource_selector` (`list[obj]`): The resource types that the custom module operates on. Each custom module\ncan specify up to 5 resource types. When `null`, the `resource_selector` 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_project_custom_module.custom_config.resource_selector.new](#fn-custom_configresource_selectornew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_config` sub block.\n', args=[]), + new( + recommendation, + severity, + custom_output=null, + description=null, + predicate=null, + resource_selector=null + ):: std.prune(a={ + custom_output: custom_output, + description: description, + predicate: predicate, + recommendation: recommendation, + resource_selector: resource_selector, + severity: severity, + }), + predicate:: { + '#new':: d.fn(help='\n`google.scc_project_custom_module.custom_config.predicate.new` constructs a new object with attributes and blocks configured for the `predicate`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Description of the expression. This is a longer text which describes the\nexpression, e.g. when hovered over it in a UI. When `null`, the `description` field will be omitted from the resulting object.\n - `expression` (`string`): Textual representation of an expression in Common Expression Language syntax.\n - `location` (`string`): String indicating the location of the expression for error reporting, e.g. a\nfile name and a position in the file. When `null`, the `location` field will be omitted from the resulting object.\n - `title` (`string`): Title for the expression, i.e. a short string describing its purpose. This can\nbe used e.g. in UIs which allow to enter the expression. When `null`, the `title` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `predicate` sub block.\n', args=[]), + new( + expression, + description=null, + location=null, + title=null + ):: std.prune(a={ + description: description, + expression: expression, + location: location, + title: title, + }), + }, + resource_selector:: { + '#new':: d.fn(help='\n`google.scc_project_custom_module.custom_config.resource_selector.new` constructs a new object with attributes and blocks configured for the `resource_selector`\nTerraform sub block.\n\n\n\n**Args**:\n - `resource_types` (`list`): The resource types to run the detector on.\n\n**Returns**:\n - An attribute object that represents the `resource_selector` sub block.\n', args=[]), + new( + resource_types + ):: std.prune(a={ + resource_types: resource_types, + }), + }, + }, + '#new':: d.fn(help="\n`google.scc_project_custom_module.new` injects a new `google_scc_project_custom_module` 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_project_custom_module.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.scc_project_custom_module` using the reference:\n\n $._ref.google_scc_project_custom_module.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_scc_project_custom_module.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 - `display_name` (`string`): The display name of the Security Health Analytics custom module. This\ndisplay name becomes the finding category for all findings that are\nreturned by this custom module. The display name must be between 1 and\n128 characters, start with a lowercase letter, and contain alphanumeric\ncharacters or underscores only.\n - `enablement_state` (`string`): The enablement state of the custom module. Possible values: [\u0026#34;ENABLED\u0026#34;, \u0026#34;DISABLED\u0026#34;]\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `custom_config` (`list[obj]`): The user specified custom configuration for the module. When `null`, the `custom_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.scc_project_custom_module.custom_config.new](#fn-custom_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.scc_project_custom_module.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, + enablement_state, + custom_config=null, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_scc_project_custom_module', + label=resourceLabel, + attrs=self.newAttrs( + custom_config=custom_config, + display_name=display_name, + enablement_state=enablement_state, + project=project, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.scc_project_custom_module.newAttrs` constructs a new object with attributes and blocks configured for the `scc_project_custom_module`\nTerraform resource.\n\nUnlike [google.scc_project_custom_module.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 - `display_name` (`string`): The display name of the Security Health Analytics custom module. This\ndisplay name becomes the finding category for all findings that are\nreturned by this custom module. The display name must be between 1 and\n128 characters, start with a lowercase letter, and contain alphanumeric\ncharacters or underscores only.\n - `enablement_state` (`string`): The enablement state of the custom module. Possible values: ["ENABLED", "DISABLED"]\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `custom_config` (`list[obj]`): The user specified custom configuration for the module. When `null`, the `custom_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.scc_project_custom_module.custom_config.new](#fn-custom_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.scc_project_custom_module.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_project_custom_module` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + display_name, + enablement_state, + custom_config=null, + project=null, + timeouts=null + ):: std.prune(a={ + custom_config: custom_config, + display_name: display_name, + enablement_state: enablement_state, + project: project, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.scc_project_custom_module.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, + }), + }, + '#withCustomConfig':: d.fn(help='`google.list[obj].withCustomConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the custom_config 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].withCustomConfigMixin](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 `custom_config` field.\n', args=[]), + withCustomConfig(resourceLabel, value): { + resource+: { + google_scc_project_custom_module+: { + [resourceLabel]+: { + custom_config: value, + }, + }, + }, + }, + '#withCustomConfigMixin':: d.fn(help='`google.list[obj].withCustomConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the custom_config 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].withCustomConfig](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 `custom_config` field.\n', args=[]), + withCustomConfigMixin(resourceLabel, value): { + resource+: { + google_scc_project_custom_module+: { + [resourceLabel]+: { + custom_config+: if std.isArray(v=value) then value else [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_scc_project_custom_module+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withEnablementState':: d.fn(help='`google.string.withEnablementState` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the enablement_state 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 `enablement_state` field.\n', args=[]), + withEnablementState(resourceLabel, value): { + resource+: { + google_scc_project_custom_module+: { + [resourceLabel]+: { + enablement_state: 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_scc_project_custom_module+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_scc_project_custom_module+: { + [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_project_custom_module+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/secret_manager_secret_version.libsonnet b/4.x/_gen/resources/secret_manager_secret_version.libsonnet index 2419ce28..59ba276a 100644 --- a/4.x/_gen/resources/secret_manager_secret_version.libsonnet +++ b/4.x/_gen/resources/secret_manager_secret_version.libsonnet @@ -2,13 +2,14 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='secret_manager_secret_version', url='', help='`secret_manager_secret_version` represents the `google_secret_manager_secret_version` 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.secret_manager_secret_version.new` injects a new `google_secret_manager_secret_version` 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.secret_manager_secret_version.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.secret_manager_secret_version` using the reference:\n\n $._ref.google_secret_manager_secret_version.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_secret_manager_secret_version.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `deletion_policy` (`string`): The deletion policy for the secret version. Setting \u0026#39;ABANDON\u0026#39; allows the resource\nto be abandoned rather than deleted. Setting \u0026#39;DISABLE\u0026#39; allows the resource to be\ndisabled rather than deleted. Default is \u0026#39;DELETE\u0026#39;. Possible values are:\n * DELETE\n * DISABLE\n * ABANDON When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `enabled` (`bool`): The current state of the SecretVersion. When `null`, the `enabled` field will be omitted from the resulting object.\n - `secret` (`string`): Secret Manager secret resource\n - `secret_data` (`string`): The secret data. Must be no larger than 64KiB.\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.secret_manager_secret_version.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.secret_manager_secret_version.new` injects a new `google_secret_manager_secret_version` 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.secret_manager_secret_version.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.secret_manager_secret_version` using the reference:\n\n $._ref.google_secret_manager_secret_version.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_secret_manager_secret_version.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `deletion_policy` (`string`): The deletion policy for the secret version. Setting \u0026#39;ABANDON\u0026#39; allows the resource\nto be abandoned rather than deleted. Setting \u0026#39;DISABLE\u0026#39; allows the resource to be\ndisabled rather than deleted. Default is \u0026#39;DELETE\u0026#39;. Possible values are:\n * DELETE\n * DISABLE\n * ABANDON When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `enabled` (`bool`): The current state of the SecretVersion. When `null`, the `enabled` field will be omitted from the resulting object.\n - `is_secret_data_base64` (`bool`): If set to \u0026#39;true\u0026#39;, the secret data is expected to be base64-encoded string and would be sent as is. When `null`, the `is_secret_data_base64` field will be omitted from the resulting object.\n - `secret` (`string`): Secret Manager secret resource\n - `secret_data` (`string`): The secret data. Must be no larger than 64KiB.\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.secret_manager_secret_version.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, secret, secret_data, deletion_policy=null, enabled=null, + is_secret_data_base64=null, timeouts=null, _meta={} ):: tf.withResource( @@ -17,22 +18,25 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs( deletion_policy=deletion_policy, enabled=enabled, + is_secret_data_base64=is_secret_data_base64, secret=secret, secret_data=secret_data, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.secret_manager_secret_version.newAttrs` constructs a new object with attributes and blocks configured for the `secret_manager_secret_version`\nTerraform resource.\n\nUnlike [google.secret_manager_secret_version.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 secret version. Setting 'ABANDON' allows the resource\nto be abandoned rather than deleted. Setting 'DISABLE' allows the resource to be\ndisabled rather than deleted. Default is 'DELETE'. Possible values are:\n * DELETE\n * DISABLE\n * ABANDON When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `enabled` (`bool`): The current state of the SecretVersion. When `null`, the `enabled` field will be omitted from the resulting object.\n - `secret` (`string`): Secret Manager secret resource\n - `secret_data` (`string`): The secret data. Must be no larger than 64KiB.\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.secret_manager_secret_version.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 `secret_manager_secret_version` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.secret_manager_secret_version.newAttrs` constructs a new object with attributes and blocks configured for the `secret_manager_secret_version`\nTerraform resource.\n\nUnlike [google.secret_manager_secret_version.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 secret version. Setting 'ABANDON' allows the resource\nto be abandoned rather than deleted. Setting 'DISABLE' allows the resource to be\ndisabled rather than deleted. Default is 'DELETE'. Possible values are:\n * DELETE\n * DISABLE\n * ABANDON When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `enabled` (`bool`): The current state of the SecretVersion. When `null`, the `enabled` field will be omitted from the resulting object.\n - `is_secret_data_base64` (`bool`): If set to 'true', the secret data is expected to be base64-encoded string and would be sent as is. When `null`, the `is_secret_data_base64` field will be omitted from the resulting object.\n - `secret` (`string`): Secret Manager secret resource\n - `secret_data` (`string`): The secret data. Must be no larger than 64KiB.\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.secret_manager_secret_version.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 `secret_manager_secret_version` resource into the root Terraform configuration.\n', args=[]), newAttrs( secret, secret_data, deletion_policy=null, enabled=null, + is_secret_data_base64=null, timeouts=null ):: std.prune(a={ deletion_policy: deletion_policy, enabled: enabled, + is_secret_data_base64: is_secret_data_base64, secret: secret, secret_data: secret_data, timeouts: timeouts, @@ -67,6 +71,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withIsSecretDataBase64':: d.fn(help='`google.bool.withIsSecretDataBase64` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the is_secret_data_base64 field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `is_secret_data_base64` field.\n', args=[]), + withIsSecretDataBase64(resourceLabel, value): { + resource+: { + google_secret_manager_secret_version+: { + [resourceLabel]+: { + is_secret_data_base64: value, + }, + }, + }, + }, '#withSecret':: d.fn(help='`google.string.withSecret` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the secret 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 `secret` field.\n', args=[]), withSecret(resourceLabel, value): { resource+: { diff --git a/docs/4.x/README.md b/docs/4.x/README.md index 73cd1efa..d451320c 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -387,6 +387,7 @@ project. * [dialogflow_cx_flow](dialogflow_cx_flow.md) * [dialogflow_cx_intent](dialogflow_cx_intent.md) * [dialogflow_cx_page](dialogflow_cx_page.md) +* [dialogflow_cx_security_settings](dialogflow_cx_security_settings.md) * [dialogflow_cx_test_case](dialogflow_cx_test_case.md) * [dialogflow_cx_version](dialogflow_cx_version.md) * [dialogflow_cx_webhook](dialogflow_cx_webhook.md) @@ -405,6 +406,8 @@ project. * [document_ai_processor_default_version](document_ai_processor_default_version.md) * [document_ai_warehouse_document_schema](document_ai_warehouse_document_schema.md) * [document_ai_warehouse_location](document_ai_warehouse_location.md) +* [edgenetwork_network](edgenetwork_network.md) +* [edgenetwork_subnet](edgenetwork_subnet.md) * [endpoints_service](endpoints_service.md) * [endpoints_service_consumers_iam_binding](endpoints_service_consumers_iam_binding.md) * [endpoints_service_consumers_iam_member](endpoints_service_consumers_iam_member.md) @@ -441,6 +444,10 @@ project. * [gke_backup_backup_plan_iam_binding](gke_backup_backup_plan_iam_binding.md) * [gke_backup_backup_plan_iam_member](gke_backup_backup_plan_iam_member.md) * [gke_backup_backup_plan_iam_policy](gke_backup_backup_plan_iam_policy.md) +* [gke_backup_restore_plan](gke_backup_restore_plan.md) +* [gke_backup_restore_plan_iam_binding](gke_backup_restore_plan_iam_binding.md) +* [gke_backup_restore_plan_iam_member](gke_backup_restore_plan_iam_member.md) +* [gke_backup_restore_plan_iam_policy](gke_backup_restore_plan_iam_policy.md) * [gke_hub_feature](gke_hub_feature.md) * [gke_hub_feature_iam_binding](gke_hub_feature_iam_binding.md) * [gke_hub_feature_iam_member](gke_hub_feature_iam_member.md) @@ -633,6 +640,7 @@ project. * [resource_manager_lien](resource_manager_lien.md) * [scc_mute_config](scc_mute_config.md) * [scc_notification_config](scc_notification_config.md) +* [scc_project_custom_module](scc_project_custom_module.md) * [scc_source](scc_source.md) * [scc_source_iam_binding](scc_source_iam_binding.md) * [scc_source_iam_member](scc_source_iam_member.md) diff --git a/docs/4.x/alloydb_cluster.md b/docs/4.x/alloydb_cluster.md index f5c49bde..2a95eca2 100644 --- a/docs/4.x/alloydb_cluster.md +++ b/docs/4.x/alloydb_cluster.md @@ -28,6 +28,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withLabels()`](#fn-withlabels) * [`fn withLocation()`](#fn-withlocation) * [`fn withNetwork()`](#fn-withnetwork) +* [`fn withNetworkConfig()`](#fn-withnetworkconfig) +* [`fn withNetworkConfigMixin()`](#fn-withnetworkconfigmixin) * [`fn withProject()`](#fn-withproject) * [`fn withRestoreBackupSource()`](#fn-withrestorebackupsource) * [`fn withRestoreBackupSourceMixin()`](#fn-withrestorebackupsourcemixin) @@ -55,6 +57,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-encryption_confignew) * [`obj initial_user`](#obj-initial_user) * [`fn new()`](#fn-initial_usernew) +* [`obj network_config`](#obj-network_config) + * [`fn new()`](#fn-network_confignew) * [`obj restore_backup_source`](#obj-restore_backup_source) * [`fn new()`](#fn-restore_backup_sourcenew) * [`obj restore_continuous_backup_source`](#obj-restore_continuous_backup_source) @@ -97,7 +101,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `location` (`string`): The location where the alloydb cluster should reside. - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: -"projects/{projectNumber}/global/networks/{network_id}". +"projects/{projectNumber}/global/networks/{network_id}". When `null`, the `network` field will be omitted from the resulting object. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor. - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster. @@ -105,6 +109,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor. - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor. - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor. + - `network_config` (`list[obj]`): Metadata related to network configuration. 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.alloydb_cluster.network_config.new](#fn-network_confignew) constructor. - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. When `null`, the `restore_backup_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.alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor. - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. When `null`, the `restore_continuous_backup_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.alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor. @@ -137,7 +142,7 @@ injecting into a complete block. - `location` (`string`): The location where the alloydb cluster should reside. - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: -"projects/{projectNumber}/global/networks/{network_id}". +"projects/{projectNumber}/global/networks/{network_id}". When `null`, the `network` field will be omitted from 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. - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor. - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster. @@ -145,6 +150,7 @@ injecting into a complete block. If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor. - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor. - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor. + - `network_config` (`list[obj]`): Metadata related to network configuration. 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.alloydb_cluster.network_config.new](#fn-network_confignew) constructor. - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. When `null`, the `restore_backup_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.alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor. - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. When `null`, the `restore_continuous_backup_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.alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor. @@ -381,6 +387,43 @@ Terraform resource block to set or update the network field. - `value` (`string`): The value to set for the `network` field. +### fn withNetworkConfig + +```ts +withNetworkConfig() +``` + +`google.list[obj].withNetworkConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the network_config 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].withNetworkConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `network_config` field. + + +### fn withNetworkConfigMixin + +```ts +withNetworkConfigMixin() +``` + +`google.list[obj].withNetworkConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the network_config 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].withNetworkConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `network_config` field. + + ### fn withProject ```ts @@ -758,6 +801,32 @@ Terraform sub block. - An attribute object that represents the `initial_user` sub block. +## obj network_config + + + +### fn network_config.new + +```ts +new() +``` + + +`google.alloydb_cluster.network_config.new` constructs a new object with attributes and blocks configured for the `network_config` +Terraform sub block. + + + +**Args**: + - `allocated_ip_range` (`string`): The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default". +If set, the instance IPs for this cluster will be created in the allocated range. When `null`, the `allocated_ip_range` field will be omitted from the resulting object. + - `network` (`string`): The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. +It is specified in the form: "projects/{projectNumber}/global/networks/{network_id}". When `null`, the `network` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `network_config` sub block. + + ## obj restore_backup_source diff --git a/docs/4.x/bigtable_instance.md b/docs/4.x/bigtable_instance.md index 08f6a83f..b1b92f44 100644 --- a/docs/4.x/bigtable_instance.md +++ b/docs/4.x/bigtable_instance.md @@ -346,6 +346,7 @@ 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. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/cloud_run_v2_job.md b/docs/4.x/cloud_run_v2_job.md index 344f114a..272718cf 100644 --- a/docs/4.x/cloud_run_v2_job.md +++ b/docs/4.x/cloud_run_v2_job.md @@ -75,6 +75,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-templatetemplatevolumessecretitemsnew) * [`obj template.template.vpc_access`](#obj-templatetemplatevpc_access) * [`fn new()`](#fn-templatetemplatevpc_accessnew) + * [`obj template.template.vpc_access.network_interfaces`](#obj-templatetemplatevpc_accessnetwork_interfaces) + * [`fn new()`](#fn-templatetemplatevpc_accessnetwork_interfacesnew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -1007,11 +1009,41 @@ Terraform sub block. **Args**: - `connector` (`string`): VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. When `null`, the `connector` field will be omitted from the resulting object. - `egress` (`string`): Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"] When `null`, the `egress` field will be omitted from the resulting object. + - `network_interfaces` (`list[obj]`): Direct VPC egress settings. Currently only single network interface is supported. When `null`, the `network_interfaces` 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_job.template.template.vpc_access.network_interfaces.new](#fn-templatetemplatetemplatenetwork_interfacesnew) constructor. **Returns**: - An attribute object that represents the `vpc_access` sub block. +## obj template.template.vpc_access.network_interfaces + + + +### fn template.template.vpc_access.network_interfaces.new + +```ts +new() +``` + + +`google.cloud_run_v2_job.template.template.vpc_access.network_interfaces.new` constructs a new object with attributes and blocks configured for the `network_interfaces` +Terraform sub block. + + + +**Args**: + - `network` (`string`): The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both +network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be +looked up from the subnetwork. When `null`, the `network` field will be omitted from the resulting object. + - `subnetwork` (`string`): The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both +network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the +subnetwork with the same name with the network will be used. When `null`, the `subnetwork` field will be omitted from the resulting object. + - `tags` (`list`): Network tags applied to this Cloud Run job. When `null`, the `tags` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `network_interfaces` sub block. + + ## obj timeouts diff --git a/docs/4.x/cloud_run_v2_service.md b/docs/4.x/cloud_run_v2_service.md index 1e2ae3ca..43aaa411 100644 --- a/docs/4.x/cloud_run_v2_service.md +++ b/docs/4.x/cloud_run_v2_service.md @@ -83,6 +83,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-templatevolumessecretitemsnew) * [`obj template.vpc_access`](#obj-templatevpc_access) * [`fn new()`](#fn-templatevpc_accessnew) + * [`obj template.vpc_access.network_interfaces`](#obj-templatevpc_accessnetwork_interfaces) + * [`fn new()`](#fn-templatevpc_accessnetwork_interfacesnew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) * [`obj traffic`](#obj-traffic) @@ -1154,11 +1156,41 @@ Terraform sub block. **Args**: - `connector` (`string`): VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. When `null`, the `connector` field will be omitted from the resulting object. - `egress` (`string`): Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"] When `null`, the `egress` field will be omitted from the resulting object. + - `network_interfaces` (`list[obj]`): Direct VPC egress settings. Currently only single network interface is supported. When `null`, the `network_interfaces` 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.vpc_access.network_interfaces.new](#fn-templatetemplatenetwork_interfacesnew) constructor. **Returns**: - An attribute object that represents the `vpc_access` sub block. +## obj template.vpc_access.network_interfaces + + + +### fn template.vpc_access.network_interfaces.new + +```ts +new() +``` + + +`google.cloud_run_v2_service.template.vpc_access.network_interfaces.new` constructs a new object with attributes and blocks configured for the `network_interfaces` +Terraform sub block. + + + +**Args**: + - `network` (`string`): The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both +network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be +looked up from the subnetwork. When `null`, the `network` field will be omitted from the resulting object. + - `subnetwork` (`string`): The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both +network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the +subnetwork with the same name with the network will be used. When `null`, the `subnetwork` field will be omitted from the resulting object. + - `tags` (`list`): Network tags applied to this Cloud Run service. When `null`, the `tags` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `network_interfaces` sub block. + + ## obj timeouts diff --git a/docs/4.x/compute_autoscaler.md b/docs/4.x/compute_autoscaler.md index 2860ce0b..e0f2c1e9 100644 --- a/docs/4.x/compute_autoscaler.md +++ b/docs/4.x/compute_autoscaler.md @@ -318,7 +318,7 @@ of replicas. to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. - - `mode` (`string`): Defines operating mode for this policy. Default value: "ON" Possible values: ["OFF", "ONLY_UP", "ON"] When `null`, the `mode` field will be omitted from the resulting object. + - `mode` (`string`): Defines operating mode for this policy. When `null`, the `mode` field will be omitted from the resulting object. - `cpu_utilization` (`list[obj]`): Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. When `null`, the `cpu_utilization` 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_autoscaler.autoscaling_policy.cpu_utilization.new](#fn-autoscaling_policycpu_utilizationnew) constructor. diff --git a/docs/4.x/compute_region_autoscaler.md b/docs/4.x/compute_region_autoscaler.md index 983d06bf..99752385 100644 --- a/docs/4.x/compute_region_autoscaler.md +++ b/docs/4.x/compute_region_autoscaler.md @@ -318,7 +318,7 @@ of replicas. to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. - - `mode` (`string`): Defines operating mode for this policy. Default value: "ON" Possible values: ["OFF", "ONLY_UP", "ON"] When `null`, the `mode` field will be omitted from the resulting object. + - `mode` (`string`): Defines operating mode for this policy. When `null`, the `mode` field will be omitted from the resulting object. - `cpu_utilization` (`list[obj]`): Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. When `null`, the `cpu_utilization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_region_autoscaler.autoscaling_policy.cpu_utilization.new](#fn-autoscaling_policycpu_utilizationnew) constructor. diff --git a/docs/4.x/compute_target_https_proxy.md b/docs/4.x/compute_target_https_proxy.md index 165e1352..21b13c5f 100644 --- a/docs/4.x/compute_target_https_proxy.md +++ b/docs/4.x/compute_target_https_proxy.md @@ -22,6 +22,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withProject()`](#fn-withproject) * [`fn withProxyBind()`](#fn-withproxybind) * [`fn withQuicOverride()`](#fn-withquicoverride) +* [`fn withServerTlsPolicy()`](#fn-withservertlspolicy) * [`fn withSslCertificates()`](#fn-withsslcertificates) * [`fn withSslPolicy()`](#fn-withsslpolicy) * [`fn withTimeouts()`](#fn-withtimeouts) @@ -83,6 +84,15 @@ this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When ` whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is specified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object. + - `server_tls_policy` (`string`): A URL referring to a networksecurity.ServerTlsPolicy +resource that describes how the proxy should authenticate inbound +traffic. serverTlsPolicy only applies to a global TargetHttpsProxy +attached to globalForwardingRules with the loadBalancingScheme +set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. +For details which ServerTlsPolicy resources are accepted with +INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED +loadBalancingScheme consult ServerTlsPolicy documentation. +If left blank, communications are not encrypted. When `null`, the `server_tls_policy` field will be omitted from the resulting object. - `ssl_certificates` (`list`): A list of SslCertificate resource URLs or Certificate Manager certificate URLs that are used to authenticate connections between users and the load balancer. At least one resource must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object. - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with @@ -138,6 +148,15 @@ this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When ` whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is specified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object. + - `server_tls_policy` (`string`): A URL referring to a networksecurity.ServerTlsPolicy +resource that describes how the proxy should authenticate inbound +traffic. serverTlsPolicy only applies to a global TargetHttpsProxy +attached to globalForwardingRules with the loadBalancingScheme +set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. +For details which ServerTlsPolicy resources are accepted with +INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED +loadBalancingScheme consult ServerTlsPolicy documentation. +If left blank, communications are not encrypted. When `null`, the `server_tls_policy` field will be omitted from the resulting object. - `ssl_certificates` (`list`): A list of SslCertificate resource URLs or Certificate Manager certificate URLs that are used to authenticate connections between users and the load balancer. At least one resource must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object. - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with @@ -263,6 +282,22 @@ Terraform resource block to set or update the quic_override field. - `value` (`string`): The value to set for the `quic_override` field. +### fn withServerTlsPolicy + +```ts +withServerTlsPolicy() +``` + +`google.string.withServerTlsPolicy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the server_tls_policy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `server_tls_policy` field. + + ### fn withSslCertificates ```ts diff --git a/docs/4.x/container_aws_node_pool.md b/docs/4.x/container_aws_node_pool.md index 54687753..c97759e9 100644 --- a/docs/4.x/container_aws_node_pool.md +++ b/docs/4.x/container_aws_node_pool.md @@ -22,6 +22,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withConfig()`](#fn-withconfig) * [`fn withConfigMixin()`](#fn-withconfigmixin) * [`fn withLocation()`](#fn-withlocation) +* [`fn withManagement()`](#fn-withmanagement) +* [`fn withManagementMixin()`](#fn-withmanagementmixin) * [`fn withMaxPodsConstraint()`](#fn-withmaxpodsconstraint) * [`fn withMaxPodsConstraintMixin()`](#fn-withmaxpodsconstraintmixin) * [`fn withName()`](#fn-withname) @@ -46,6 +48,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-configssh_confignew) * [`obj config.taints`](#obj-configtaints) * [`fn new()`](#fn-configtaintsnew) +* [`obj management`](#obj-management) + * [`fn new()`](#fn-managementnew) * [`obj max_pods_constraint`](#obj-max_pods_constraint) * [`fn new()`](#fn-max_pods_constraintnew) * [`obj timeouts`](#obj-timeouts) @@ -89,6 +93,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `version` (`string`): The Kubernetes version to run on this node pool (e.g. `1.19.10-gke.1000`). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig. - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_aws_node_pool.autoscaling.new](#fn-autoscalingnew) constructor. - `config` (`list[obj]`): The configuration of the node pool. When `null`, the `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.container_aws_node_pool.config.new](#fn-confignew) constructor. + - `management` (`list[obj]`): The Management configuration for this node pool. When `null`, the `management` 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_aws_node_pool.management.new](#fn-managementnew) constructor. - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_aws_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_aws_node_pool.timeouts.new](#fn-timeoutsnew) constructor. @@ -123,6 +128,7 @@ injecting into a complete block. - `version` (`string`): The Kubernetes version to run on this node pool (e.g. `1.19.10-gke.1000`). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig. - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_aws_node_pool.autoscaling.new](#fn-autoscalingnew) constructor. - `config` (`list[obj]`): The configuration of the node pool. When `null`, the `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.container_aws_node_pool.config.new](#fn-confignew) constructor. + - `management` (`list[obj]`): The Management configuration for this node pool. When `null`, the `management` 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_aws_node_pool.management.new](#fn-managementnew) constructor. - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_aws_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_aws_node_pool.timeouts.new](#fn-timeoutsnew) constructor. @@ -252,6 +258,43 @@ Terraform resource block to set or update the location field. - `value` (`string`): The value to set for the `location` field. +### fn withManagement + +```ts +withManagement() +``` + +`google.list[obj].withManagement` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the management 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].withManagementMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `management` field. + + +### fn withManagementMixin + +```ts +withManagementMixin() +``` + +`google.list[obj].withManagementMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the management 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].withManagement](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `management` field. + + ### fn withMaxPodsConstraint ```ts @@ -592,6 +635,29 @@ Terraform sub block. - An attribute object that represents the `taints` sub block. +## obj management + + + +### fn management.new + +```ts +new() +``` + + +`google.container_aws_node_pool.management.new` constructs a new object with attributes and blocks configured for the `management` +Terraform sub block. + + + +**Args**: + - `auto_repair` (`bool`): Optional. Whether or not the nodes will be automatically repaired. When `null`, the `auto_repair` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `management` sub block. + + ## obj max_pods_constraint diff --git a/docs/4.x/container_azure_node_pool.md b/docs/4.x/container_azure_node_pool.md index f8f043dd..44c904e6 100644 --- a/docs/4.x/container_azure_node_pool.md +++ b/docs/4.x/container_azure_node_pool.md @@ -23,6 +23,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withConfig()`](#fn-withconfig) * [`fn withConfigMixin()`](#fn-withconfigmixin) * [`fn withLocation()`](#fn-withlocation) +* [`fn withManagement()`](#fn-withmanagement) +* [`fn withManagementMixin()`](#fn-withmanagementmixin) * [`fn withMaxPodsConstraint()`](#fn-withmaxpodsconstraint) * [`fn withMaxPodsConstraintMixin()`](#fn-withmaxpodsconstraintmixin) * [`fn withName()`](#fn-withname) @@ -41,6 +43,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-configroot_volumenew) * [`obj config.ssh_config`](#obj-configssh_config) * [`fn new()`](#fn-configssh_confignew) +* [`obj management`](#obj-management) + * [`fn new()`](#fn-managementnew) * [`obj max_pods_constraint`](#obj-max_pods_constraint) * [`fn new()`](#fn-max_pods_constraintnew) * [`obj timeouts`](#obj-timeouts) @@ -85,6 +89,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `version` (`string`): The Kubernetes version (e.g. `1.19.10-gke.1000`) running on this node pool. - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_node_pool.autoscaling.new](#fn-autoscalingnew) constructor. - `config` (`list[obj]`): The node configuration of the node pool. When `null`, the `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.container_azure_node_pool.config.new](#fn-confignew) constructor. + - `management` (`list[obj]`): The Management configuration for this node pool. When `null`, the `management` 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_node_pool.management.new](#fn-managementnew) constructor. - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_node_pool.timeouts.new](#fn-timeoutsnew) constructor. @@ -120,6 +125,7 @@ injecting into a complete block. - `version` (`string`): The Kubernetes version (e.g. `1.19.10-gke.1000`) running on this node pool. - `autoscaling` (`list[obj]`): Autoscaler configuration for this node pool. When `null`, the `autoscaling` 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_node_pool.autoscaling.new](#fn-autoscalingnew) constructor. - `config` (`list[obj]`): The node configuration of the node pool. When `null`, the `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.container_azure_node_pool.config.new](#fn-confignew) constructor. + - `management` (`list[obj]`): The Management configuration for this node pool. When `null`, the `management` 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_node_pool.management.new](#fn-managementnew) constructor. - `max_pods_constraint` (`list[obj]`): The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. When `null`, the `max_pods_constraint` 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_node_pool.max_pods_constraint.new](#fn-max_pods_constraintnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_azure_node_pool.timeouts.new](#fn-timeoutsnew) constructor. @@ -265,6 +271,43 @@ Terraform resource block to set or update the location field. - `value` (`string`): The value to set for the `location` field. +### fn withManagement + +```ts +withManagement() +``` + +`google.list[obj].withManagement` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the management 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].withManagementMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `management` field. + + +### fn withManagementMixin + +```ts +withManagementMixin() +``` + +`google.list[obj].withManagementMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the management 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].withManagement](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `management` field. + + ### fn withMaxPodsConstraint ```ts @@ -523,6 +566,29 @@ Terraform sub block. - An attribute object that represents the `ssh_config` sub block. +## obj management + + + +### fn management.new + +```ts +new() +``` + + +`google.container_azure_node_pool.management.new` constructs a new object with attributes and blocks configured for the `management` +Terraform sub block. + + + +**Args**: + - `auto_repair` (`bool`): Optional. Whether or not the nodes will be automatically repaired. When `null`, the `auto_repair` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `management` sub block. + + ## obj max_pods_constraint diff --git a/docs/4.x/container_cluster.md b/docs/4.x/container_cluster.md index e4a3a22f..e504c90c 100644 --- a/docs/4.x/container_cluster.md +++ b/docs/4.x/container_cluster.md @@ -78,6 +78,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withNodeConfigMixin()`](#fn-withnodeconfigmixin) * [`fn withNodeLocations()`](#fn-withnodelocations) * [`fn withNodePool()`](#fn-withnodepool) +* [`fn withNodePoolAutoConfig()`](#fn-withnodepoolautoconfig) +* [`fn withNodePoolAutoConfigMixin()`](#fn-withnodepoolautoconfigmixin) * [`fn withNodePoolDefaults()`](#fn-withnodepooldefaults) * [`fn withNodePoolDefaultsMixin()`](#fn-withnodepooldefaultsmixin) * [`fn withNodePoolMixin()`](#fn-withnodepoolmixin) @@ -205,6 +207,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_configconfidential_nodesnew) * [`obj node_config.ephemeral_storage_local_ssd_config`](#obj-node_configephemeral_storage_local_ssd_config) * [`fn new()`](#fn-node_configephemeral_storage_local_ssd_confignew) + * [`obj node_config.fast_socket`](#obj-node_configfast_socket) + * [`fn new()`](#fn-node_configfast_socketnew) * [`obj node_config.gcfs_config`](#obj-node_configgcfs_config) * [`fn new()`](#fn-node_configgcfs_confignew) * [`obj node_config.gvnic`](#obj-node_configgvnic) @@ -245,6 +249,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_poolnode_configconfidential_nodesnew) * [`obj node_pool.node_config.ephemeral_storage_local_ssd_config`](#obj-node_poolnode_configephemeral_storage_local_ssd_config) * [`fn new()`](#fn-node_poolnode_configephemeral_storage_local_ssd_confignew) + * [`obj node_pool.node_config.fast_socket`](#obj-node_poolnode_configfast_socket) + * [`fn new()`](#fn-node_poolnode_configfast_socketnew) * [`obj node_pool.node_config.gcfs_config`](#obj-node_poolnode_configgcfs_config) * [`fn new()`](#fn-node_poolnode_configgcfs_confignew) * [`obj node_pool.node_config.gvnic`](#obj-node_poolnode_configgvnic) @@ -275,6 +281,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_poolupgrade_settingsblue_green_settingsnew) * [`obj node_pool.upgrade_settings.blue_green_settings.standard_rollout_policy`](#obj-node_poolupgrade_settingsblue_green_settingsstandard_rollout_policy) * [`fn new()`](#fn-node_poolupgrade_settingsblue_green_settingsstandard_rollout_policynew) +* [`obj node_pool_auto_config`](#obj-node_pool_auto_config) + * [`fn new()`](#fn-node_pool_auto_confignew) + * [`obj node_pool_auto_config.network_tags`](#obj-node_pool_auto_confignetwork_tags) + * [`fn new()`](#fn-node_pool_auto_confignetwork_tagsnew) * [`obj node_pool_defaults`](#obj-node_pool_defaults) * [`fn new()`](#fn-node_pool_defaultsnew) * [`obj node_pool_defaults.node_config_defaults`](#obj-node_pool_defaultsnode_config_defaults) @@ -384,6 +394,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor. - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_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.container_cluster.node_config.new](#fn-node_confignew) constructor. - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say "these are the only node pools associated with this cluster", use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` 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_cluster.node_pool.new](#fn-node_poolnew) constructor. + - `node_pool_auto_config` (`list[obj]`): Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. When `null`, the `node_pool_auto_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.container_cluster.node_pool_auto_config.new](#fn-node_pool_auto_confignew) constructor. - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` 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_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor. - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_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.container_cluster.notification_config.new](#fn-notification_confignew) constructor. - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_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.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor. @@ -466,6 +477,7 @@ injecting into a complete block. - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor. - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_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.container_cluster.node_config.new](#fn-node_confignew) constructor. - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say "these are the only node pools associated with this cluster", use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` 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_cluster.node_pool.new](#fn-node_poolnew) constructor. + - `node_pool_auto_config` (`list[obj]`): Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. When `null`, the `node_pool_auto_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.container_cluster.node_pool_auto_config.new](#fn-node_pool_auto_confignew) constructor. - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` 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_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor. - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_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.container_cluster.notification_config.new](#fn-notification_confignew) constructor. - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_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.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor. @@ -1591,6 +1603,43 @@ passed in value to the existing array, use the [google.list[obj].withNodePoolMix - `value` (`list[obj]`): The value to set for the `node_pool` field. +### fn withNodePoolAutoConfig + +```ts +withNodePoolAutoConfig() +``` + +`google.list[obj].withNodePoolAutoConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the node_pool_auto_config 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].withNodePoolAutoConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `node_pool_auto_config` field. + + +### fn withNodePoolAutoConfigMixin + +```ts +withNodePoolAutoConfigMixin() +``` + +`google.list[obj].withNodePoolAutoConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the node_pool_auto_config 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].withNodePoolAutoConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `node_pool_auto_config` field. + + ### fn withNodePoolDefaults ```ts @@ -3230,6 +3279,7 @@ Terraform sub block. - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_cluster.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor. - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_cluster.node_config.confidential_nodes.new](#fn-node_configconfidential_nodesnew) constructor. - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_cluster.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor. + - `fast_socket` (`list[obj]`): Enable or disable NCCL Fast Socket in the node pool. When `null`, the `fast_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.container_cluster.node_config.fast_socket.new](#fn-node_configfast_socketnew) constructor. - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_cluster.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor. - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_cluster.node_config.gvnic.new](#fn-node_configgvnicnew) constructor. - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) constructor. @@ -3314,6 +3364,29 @@ Terraform sub block. - An attribute object that represents the `ephemeral_storage_local_ssd_config` sub block. +## obj node_config.fast_socket + + + +### fn node_config.fast_socket.new + +```ts +new() +``` + + +`google.container_cluster.node_config.fast_socket.new` constructs a new object with attributes and blocks configured for the `fast_socket` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether or not NCCL Fast Socket is enabled + +**Returns**: + - An attribute object that represents the `fast_socket` sub block. + + ## obj node_config.gcfs_config @@ -3750,6 +3823,7 @@ Terraform sub block. - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_cluster.node_pool.node_config.advanced_machine_features.new](#fn-node_poolnode_pooladvanced_machine_featuresnew) constructor. - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_cluster.node_pool.node_config.confidential_nodes.new](#fn-node_poolnode_poolconfidential_nodesnew) constructor. - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_cluster.node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_poolnode_poolephemeral_storage_local_ssd_confignew) constructor. + - `fast_socket` (`list[obj]`): Enable or disable NCCL Fast Socket in the node pool. When `null`, the `fast_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.container_cluster.node_pool.node_config.fast_socket.new](#fn-node_poolnode_poolfast_socketnew) constructor. - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_cluster.node_pool.node_config.gcfs_config.new](#fn-node_poolnode_poolgcfs_confignew) constructor. - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_cluster.node_pool.node_config.gvnic.new](#fn-node_poolnode_poolgvnicnew) constructor. - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.host_maintenance_policy.new](#fn-node_poolnode_poolhost_maintenance_policynew) constructor. @@ -3834,6 +3908,29 @@ Terraform sub block. - An attribute object that represents the `ephemeral_storage_local_ssd_config` sub block. +## obj node_pool.node_config.fast_socket + + + +### fn node_pool.node_config.fast_socket.new + +```ts +new() +``` + + +`google.container_cluster.node_pool.node_config.fast_socket.new` constructs a new object with attributes and blocks configured for the `fast_socket` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether or not NCCL Fast Socket is enabled + +**Returns**: + - An attribute object that represents the `fast_socket` sub block. + + ## obj node_pool.node_config.gcfs_config @@ -4113,6 +4210,7 @@ Terraform sub block. **Args**: - `policy_name` (`string`): If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. When `null`, the `policy_name` field will be omitted from the resulting object. + - `tpu_topology` (`string`): TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies When `null`, the `tpu_topology` field will be omitted from the resulting object. - `type` (`string`): Type defines the type of placement policy **Returns**: @@ -4194,6 +4292,52 @@ Terraform sub block. - An attribute object that represents the `standard_rollout_policy` sub block. +## obj node_pool_auto_config + + + +### fn node_pool_auto_config.new + +```ts +new() +``` + + +`google.container_cluster.node_pool_auto_config.new` constructs a new object with attributes and blocks configured for the `node_pool_auto_config` +Terraform sub block. + + + +**Args**: + - `network_tags` (`list[obj]`): Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. When `null`, the `network_tags` 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_cluster.node_pool_auto_config.network_tags.new](#fn-node_pool_auto_confignetwork_tagsnew) constructor. + +**Returns**: + - An attribute object that represents the `node_pool_auto_config` sub block. + + +## obj node_pool_auto_config.network_tags + + + +### fn node_pool_auto_config.network_tags.new + +```ts +new() +``` + + +`google.container_cluster.node_pool_auto_config.network_tags.new` constructs a new object with attributes and blocks configured for the `network_tags` +Terraform sub block. + + + +**Args**: + - `tags` (`list`): List of network tags applied to auto-provisioned node pools. When `null`, the `tags` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `network_tags` sub block. + + ## obj node_pool_defaults diff --git a/docs/4.x/container_node_pool.md b/docs/4.x/container_node_pool.md index 252ee9d4..c88332fb 100644 --- a/docs/4.x/container_node_pool.md +++ b/docs/4.x/container_node_pool.md @@ -55,6 +55,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_configconfidential_nodesnew) * [`obj node_config.ephemeral_storage_local_ssd_config`](#obj-node_configephemeral_storage_local_ssd_config) * [`fn new()`](#fn-node_configephemeral_storage_local_ssd_confignew) + * [`obj node_config.fast_socket`](#obj-node_configfast_socket) + * [`fn new()`](#fn-node_configfast_socketnew) * [`obj node_config.gcfs_config`](#obj-node_configgcfs_config) * [`fn new()`](#fn-node_configgcfs_confignew) * [`obj node_config.gvnic`](#obj-node_configgvnic) @@ -737,6 +739,7 @@ Terraform sub block. - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` 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_node_pool.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor. - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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_node_pool.node_config.confidential_nodes.new](#fn-node_configconfidential_nodesnew) constructor. - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_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.container_node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor. + - `fast_socket` (`list[obj]`): Enable or disable NCCL Fast Socket in the node pool. When `null`, the `fast_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.container_node_pool.node_config.fast_socket.new](#fn-node_configfast_socketnew) constructor. - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_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.container_node_pool.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor. - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` 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_node_pool.node_config.gvnic.new](#fn-node_configgvnicnew) constructor. - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) constructor. @@ -821,6 +824,29 @@ Terraform sub block. - An attribute object that represents the `ephemeral_storage_local_ssd_config` sub block. +## obj node_config.fast_socket + + + +### fn node_config.fast_socket.new + +```ts +new() +``` + + +`google.container_node_pool.node_config.fast_socket.new` constructs a new object with attributes and blocks configured for the `fast_socket` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether or not NCCL Fast Socket is enabled + +**Returns**: + - An attribute object that represents the `fast_socket` sub block. + + ## obj node_config.gcfs_config @@ -1100,6 +1126,7 @@ Terraform sub block. **Args**: - `policy_name` (`string`): If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. When `null`, the `policy_name` field will be omitted from the resulting object. + - `tpu_topology` (`string`): TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies When `null`, the `tpu_topology` field will be omitted from the resulting object. - `type` (`string`): Type defines the type of placement policy **Returns**: diff --git a/docs/4.x/data/certificate_manager_certificate_map.md b/docs/4.x/data/certificate_manager_certificate_map.md new file mode 100644 index 00000000..cd607c6f --- /dev/null +++ b/docs/4.x/data/certificate_manager_certificate_map.md @@ -0,0 +1,113 @@ +--- +permalink: /data/certificate_manager_certificate_map/ +--- + +# data.certificate_manager_certificate_map + +`certificate_manager_certificate_map` represents the `google_certificate_manager_certificate_map` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data.certificate_manager_certificate_map.new` injects a new `data_google_certificate_manager_certificate_map` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google.data.certificate_manager_certificate_map.new('some_id') + +You can get the reference to the `id` field of the created `google.data.certificate_manager_certificate_map` using the reference: + + $._ref.data_google_certificate_manager_certificate_map.some_id.get('id') + +This is the same as directly entering `"${ data_google_certificate_manager_certificate_map.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + - `name` (`string`): A user-defined name of the Certificate Map. Certificate Map names must be unique +globally and match the pattern 'projects/*/locations/*/certificateMaps/*'. + - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data.certificate_manager_certificate_map.newAttrs` constructs a new object with attributes and blocks configured for the `certificate_manager_certificate_map` +Terraform data source. + +Unlike [google.data.certificate_manager_certificate_map.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `name` (`string`): A user-defined name of the Certificate Map. Certificate Map names must be unique +globally and match the pattern 'projects/*/locations/*/certificateMaps/*'. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `certificate_manager_certificate_map` data source into the root Terraform configuration. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the project field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. diff --git a/docs/4.x/data/gke_backup_restore_plan_iam_policy.md b/docs/4.x/data/gke_backup_restore_plan_iam_policy.md new file mode 100644 index 00000000..c89e7ad5 --- /dev/null +++ b/docs/4.x/data/gke_backup_restore_plan_iam_policy.md @@ -0,0 +1,130 @@ +--- +permalink: /data/gke_backup_restore_plan_iam_policy/ +--- + +# data.gke_backup_restore_plan_iam_policy + +`gke_backup_restore_plan_iam_policy` represents the `google_gke_backup_restore_plan_iam_policy` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data.gke_backup_restore_plan_iam_policy.new` injects a new `data_google_gke_backup_restore_plan_iam_policy` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google.data.gke_backup_restore_plan_iam_policy.new('some_id') + +You can get the reference to the `id` field of the created `google.data.gke_backup_restore_plan_iam_policy` using the reference: + + $._ref.data_google_gke_backup_restore_plan_iam_policy.some_id.get('id') + +This is the same as directly entering `"${ data_google_gke_backup_restore_plan_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**: + - `dataSrcLabel` (`string`): The name label of the block. + - `location` (`string`): Set the `location` field on the resulting data source block. When `null`, the `location` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting data source block. + - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data.gke_backup_restore_plan_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan_iam_policy` +Terraform data source. + +Unlike [google.data.gke_backup_restore_plan_iam_policy.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `location` (`string`): Set the `location` field on the resulting object. When `null`, the `location` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` 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. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `gke_backup_restore_plan_iam_policy` data source into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the location field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the project field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. diff --git a/docs/4.x/data/index.md b/docs/4.x/data/index.md index 1f4594d7..27402ae4 100644 --- a/docs/4.x/data/index.md +++ b/docs/4.x/data/index.md @@ -32,6 +32,7 @@ permalink: /data/ * [billing_account](billing_account.md) * [billing_account_iam_policy](billing_account_iam_policy.md) * [binary_authorization_attestor_iam_policy](binary_authorization_attestor_iam_policy.md) +* [certificate_manager_certificate_map](certificate_manager_certificate_map.md) * [client_config](client_config.md) * [client_openid_userinfo](client_openid_userinfo.md) * [cloud_identity_group_memberships](cloud_identity_group_memberships.md) @@ -131,6 +132,7 @@ permalink: /data/ * [folders](folders.md) * [game_services_game_server_deployment_rollout](game_services_game_server_deployment_rollout.md) * [gke_backup_backup_plan_iam_policy](gke_backup_backup_plan_iam_policy.md) +* [gke_backup_restore_plan_iam_policy](gke_backup_restore_plan_iam_policy.md) * [gke_hub_feature_iam_policy](gke_hub_feature_iam_policy.md) * [gke_hub_membership_iam_policy](gke_hub_membership_iam_policy.md) * [gke_hub_scope_iam_policy](gke_hub_scope_iam_policy.md) diff --git a/docs/4.x/dialogflow_cx_security_settings.md b/docs/4.x/dialogflow_cx_security_settings.md new file mode 100644 index 00000000..d9556ad3 --- /dev/null +++ b/docs/4.x/dialogflow_cx_security_settings.md @@ -0,0 +1,494 @@ +--- +permalink: /dialogflow_cx_security_settings/ +--- + +# dialogflow_cx_security_settings + +`dialogflow_cx_security_settings` represents the `google_dialogflow_cx_security_settings` 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 withAudioExportSettings()`](#fn-withaudioexportsettings) +* [`fn withAudioExportSettingsMixin()`](#fn-withaudioexportsettingsmixin) +* [`fn withDeidentifyTemplate()`](#fn-withdeidentifytemplate) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withInsightsExportSettings()`](#fn-withinsightsexportsettings) +* [`fn withInsightsExportSettingsMixin()`](#fn-withinsightsexportsettingsmixin) +* [`fn withInspectTemplate()`](#fn-withinspecttemplate) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withProject()`](#fn-withproject) +* [`fn withPurgeDataTypes()`](#fn-withpurgedatatypes) +* [`fn withRedactionScope()`](#fn-withredactionscope) +* [`fn withRedactionStrategy()`](#fn-withredactionstrategy) +* [`fn withRetentionStrategy()`](#fn-withretentionstrategy) +* [`fn withRetentionWindowDays()`](#fn-withretentionwindowdays) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj audio_export_settings`](#obj-audio_export_settings) + * [`fn new()`](#fn-audio_export_settingsnew) +* [`obj insights_export_settings`](#obj-insights_export_settings) + * [`fn new()`](#fn-insights_export_settingsnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.dialogflow_cx_security_settings.new` injects a new `google_dialogflow_cx_security_settings` 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.dialogflow_cx_security_settings.new('some_id') + +You can get the reference to the `id` field of the created `google.dialogflow_cx_security_settings` using the reference: + + $._ref.google_dialogflow_cx_security_settings.some_id.get('id') + +This is the same as directly entering `"${ google_dialogflow_cx_security_settings.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. + - `deidentify_template` (`string`): [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. If empty, Dialogflow replaces sensitive info with [redacted] text. +Note: deidentifyTemplate must be located in the same region as the SecuritySettings. +Format: projects/<Project ID>/locations/<Location ID>/deidentifyTemplates/<Template ID> OR organizations/<Organization ID>/locations/<Location ID>/deidentifyTemplates/<Template ID> When `null`, the `deidentify_template` field will be omitted from the resulting object. + - `display_name` (`string`): The human-readable name of the security settings, unique within the location. + - `inspect_template` (`string`): [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. +Note: inspectTemplate must be located in the same region as the SecuritySettings. +Format: projects/<Project ID>/locations/<Location ID>/inspectTemplates/<Template ID> OR organizations/<Organization ID>/locations/<Location ID>/inspectTemplates/<Template ID> When `null`, the `inspect_template` field will be omitted from the resulting object. + - `location` (`string`): The location these settings are located in. Settings can only be applied to an agent in the same location. +See [Available Regions](https://cloud.google.com/dialogflow/cx/docs/concept/region#avail) for a list of supported locations. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `purge_data_types` (`list`): List of types of data to remove when retention settings triggers purge. Possible values: ["DIALOGFLOW_HISTORY"] When `null`, the `purge_data_types` field will be omitted from the resulting object. + - `redaction_scope` (`string`): Defines what types of data to redact. If not set, defaults to not redacting any kind of data. +* REDACT_DISK_STORAGE: On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk. Possible values: ["REDACT_DISK_STORAGE"] When `null`, the `redaction_scope` field will be omitted from the resulting object. + - `redaction_strategy` (`string`): Defines how we redact data. If not set, defaults to not redacting. +* REDACT_WITH_SERVICE: Call redaction service to clean up the data to be persisted. Possible values: ["REDACT_WITH_SERVICE"] When `null`, the `redaction_strategy` field will be omitted from the resulting object. + - `retention_strategy` (`string`): Defines how long we retain persisted data that contains sensitive info. Only one of 'retention_window_days' and 'retention_strategy' may be set. +* REMOVE_AFTER_CONVERSATION: Removes data when the conversation ends. If there is no conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends. Possible values: ["REMOVE_AFTER_CONVERSATION"] When `null`, the `retention_strategy` field will be omitted from the resulting object. + - `retention_window_days` (`number`): Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. +Only one of 'retention_window_days' and 'retention_strategy' may be set. When `null`, the `retention_window_days` field will be omitted from the resulting object. + - `audio_export_settings` (`list[obj]`): Controls audio export settings for post-conversation analytics when ingesting audio to conversations. +If retention_strategy is set to REMOVE_AFTER_CONVERSATION or gcs_bucket is empty, audio export is disabled. +If audio export is enabled, audio is recorded and saved to gcs_bucket, subject to retention policy of gcs_bucket. +This setting won't effect audio input for implicit sessions via [Sessions.DetectIntent](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.sessions/detectIntent#google.cloud.dialogflow.cx.v3.Sessions.DetectIntent). When `null`, the `audio_export_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.audio_export_settings.new](#fn-audio_export_settingsnew) constructor. + - `insights_export_settings` (`list[obj]`): Controls conversation exporting settings to Insights after conversation is completed. +If retentionStrategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here. When `null`, the `insights_export_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.insights_export_settings.new](#fn-insights_export_settingsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.dialogflow_cx_security_settings.newAttrs` constructs a new object with attributes and blocks configured for the `dialogflow_cx_security_settings` +Terraform resource. + +Unlike [google.dialogflow_cx_security_settings.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**: + - `deidentify_template` (`string`): [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. If empty, Dialogflow replaces sensitive info with [redacted] text. +Note: deidentifyTemplate must be located in the same region as the SecuritySettings. +Format: projects/<Project ID>/locations/<Location ID>/deidentifyTemplates/<Template ID> OR organizations/<Organization ID>/locations/<Location ID>/deidentifyTemplates/<Template ID> When `null`, the `deidentify_template` field will be omitted from the resulting object. + - `display_name` (`string`): The human-readable name of the security settings, unique within the location. + - `inspect_template` (`string`): [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. +Note: inspectTemplate must be located in the same region as the SecuritySettings. +Format: projects/<Project ID>/locations/<Location ID>/inspectTemplates/<Template ID> OR organizations/<Organization ID>/locations/<Location ID>/inspectTemplates/<Template ID> When `null`, the `inspect_template` field will be omitted from the resulting object. + - `location` (`string`): The location these settings are located in. Settings can only be applied to an agent in the same location. +See [Available Regions](https://cloud.google.com/dialogflow/cx/docs/concept/region#avail) for a list of supported locations. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `purge_data_types` (`list`): List of types of data to remove when retention settings triggers purge. Possible values: ["DIALOGFLOW_HISTORY"] When `null`, the `purge_data_types` field will be omitted from the resulting object. + - `redaction_scope` (`string`): Defines what types of data to redact. If not set, defaults to not redacting any kind of data. +* REDACT_DISK_STORAGE: On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk. Possible values: ["REDACT_DISK_STORAGE"] When `null`, the `redaction_scope` field will be omitted from the resulting object. + - `redaction_strategy` (`string`): Defines how we redact data. If not set, defaults to not redacting. +* REDACT_WITH_SERVICE: Call redaction service to clean up the data to be persisted. Possible values: ["REDACT_WITH_SERVICE"] When `null`, the `redaction_strategy` field will be omitted from the resulting object. + - `retention_strategy` (`string`): Defines how long we retain persisted data that contains sensitive info. Only one of 'retention_window_days' and 'retention_strategy' may be set. +* REMOVE_AFTER_CONVERSATION: Removes data when the conversation ends. If there is no conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends. Possible values: ["REMOVE_AFTER_CONVERSATION"] When `null`, the `retention_strategy` field will be omitted from the resulting object. + - `retention_window_days` (`number`): Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. +Only one of 'retention_window_days' and 'retention_strategy' may be set. When `null`, the `retention_window_days` field will be omitted from the resulting object. + - `audio_export_settings` (`list[obj]`): Controls audio export settings for post-conversation analytics when ingesting audio to conversations. +If retention_strategy is set to REMOVE_AFTER_CONVERSATION or gcs_bucket is empty, audio export is disabled. +If audio export is enabled, audio is recorded and saved to gcs_bucket, subject to retention policy of gcs_bucket. +This setting won't effect audio input for implicit sessions via [Sessions.DetectIntent](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.sessions/detectIntent#google.cloud.dialogflow.cx.v3.Sessions.DetectIntent). When `null`, the `audio_export_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.audio_export_settings.new](#fn-audio_export_settingsnew) constructor. + - `insights_export_settings` (`list[obj]`): Controls conversation exporting settings to Insights after conversation is completed. +If retentionStrategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here. When `null`, the `insights_export_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.insights_export_settings.new](#fn-insights_export_settingsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_security_settings.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 `dialogflow_cx_security_settings` resource into the root Terraform configuration. + + +### fn withAudioExportSettings + +```ts +withAudioExportSettings() +``` + +`google.list[obj].withAudioExportSettings` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the audio_export_settings 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].withAudioExportSettingsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `audio_export_settings` field. + + +### fn withAudioExportSettingsMixin + +```ts +withAudioExportSettingsMixin() +``` + +`google.list[obj].withAudioExportSettingsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the audio_export_settings 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].withAudioExportSettings](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `audio_export_settings` field. + + +### fn withDeidentifyTemplate + +```ts +withDeidentifyTemplate() +``` + +`google.string.withDeidentifyTemplate` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the deidentify_template field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `deidentify_template` 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 withInsightsExportSettings + +```ts +withInsightsExportSettings() +``` + +`google.list[obj].withInsightsExportSettings` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the insights_export_settings 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].withInsightsExportSettingsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `insights_export_settings` field. + + +### fn withInsightsExportSettingsMixin + +```ts +withInsightsExportSettingsMixin() +``` + +`google.list[obj].withInsightsExportSettingsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the insights_export_settings 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].withInsightsExportSettings](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `insights_export_settings` field. + + +### fn withInspectTemplate + +```ts +withInspectTemplate() +``` + +`google.string.withInspectTemplate` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the inspect_template field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `inspect_template` field. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` 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 withPurgeDataTypes + +```ts +withPurgeDataTypes() +``` + +`google.list.withPurgeDataTypes` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the purge_data_types field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `purge_data_types` field. + + +### fn withRedactionScope + +```ts +withRedactionScope() +``` + +`google.string.withRedactionScope` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the redaction_scope field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `redaction_scope` field. + + +### fn withRedactionStrategy + +```ts +withRedactionStrategy() +``` + +`google.string.withRedactionStrategy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the redaction_strategy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `redaction_strategy` field. + + +### fn withRetentionStrategy + +```ts +withRetentionStrategy() +``` + +`google.string.withRetentionStrategy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the retention_strategy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `retention_strategy` field. + + +### fn withRetentionWindowDays + +```ts +withRetentionWindowDays() +``` + +`google.number.withRetentionWindowDays` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the retention_window_days field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `retention_window_days` 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 audio_export_settings + + + +### fn audio_export_settings.new + +```ts +new() +``` + + +`google.dialogflow_cx_security_settings.audio_export_settings.new` constructs a new object with attributes and blocks configured for the `audio_export_settings` +Terraform sub block. + + + +**Args**: + - `audio_export_pattern` (`string`): Filename pattern for exported audio. When `null`, the `audio_export_pattern` field will be omitted from the resulting object. + - `audio_format` (`string`): File format for exported audio file. Currently only in telephony recordings. +* MULAW: G.711 mu-law PCM with 8kHz sample rate. +* MP3: MP3 file format. +* OGG: OGG Vorbis. Possible values: ["MULAW", "MP3", "OGG"] When `null`, the `audio_format` field will be omitted from the resulting object. + - `enable_audio_redaction` (`bool`): Enable audio redaction if it is true. When `null`, the `enable_audio_redaction` field will be omitted from the resulting object. + - `gcs_bucket` (`string`): Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy. When `null`, the `gcs_bucket` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `audio_export_settings` sub block. + + +## obj insights_export_settings + + + +### fn insights_export_settings.new + +```ts +new() +``` + + +`google.dialogflow_cx_security_settings.insights_export_settings.new` constructs a new object with attributes and blocks configured for the `insights_export_settings` +Terraform sub block. + + + +**Args**: + - `enable_insights_export` (`bool`): If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers. + +**Returns**: + - An attribute object that represents the `insights_export_settings` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.dialogflow_cx_security_settings.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/edgenetwork_network.md b/docs/4.x/edgenetwork_network.md new file mode 100644 index 00000000..cf968ac5 --- /dev/null +++ b/docs/4.x/edgenetwork_network.md @@ -0,0 +1,272 @@ +--- +permalink: /edgenetwork_network/ +--- + +# edgenetwork_network + +`edgenetwork_network` represents the `google_edgenetwork_network` 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 withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withMtu()`](#fn-withmtu) +* [`fn withNetworkId()`](#fn-withnetworkid) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withZone()`](#fn-withzone) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.edgenetwork_network.new` injects a new `google_edgenetwork_network` 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.edgenetwork_network.new('some_id') + +You can get the reference to the `id` field of the created `google.edgenetwork_network` using the reference: + + $._ref.google_edgenetwork_network.some_id.get('id') + +This is the same as directly entering `"${ google_edgenetwork_network.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 free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object. + - `labels` (`obj`): Labels associated with this resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The Google Cloud region to which the target Distributed Cloud Edge zone belongs. + - `mtu` (`number`): IP (L3) MTU value of the network. Default value is '1500'. Possible values are: '1500', '9000'. When `null`, the `mtu` field will be omitted from the resulting object. + - `network_id` (`string`): A unique ID that identifies this network. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `zone` (`string`): The name of the target Distributed Cloud Edge zone. + - `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.edgenetwork_network.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.edgenetwork_network.newAttrs` constructs a new object with attributes and blocks configured for the `edgenetwork_network` +Terraform resource. + +Unlike [google.edgenetwork_network.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 free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object. + - `labels` (`obj`): Labels associated with this resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The Google Cloud region to which the target Distributed Cloud Edge zone belongs. + - `mtu` (`number`): IP (L3) MTU value of the network. Default value is '1500'. Possible values are: '1500', '9000'. When `null`, the `mtu` field will be omitted from the resulting object. + - `network_id` (`string`): A unique ID that identifies this network. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `zone` (`string`): The name of the target Distributed Cloud Edge zone. + - `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.edgenetwork_network.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 `edgenetwork_network` 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 withLabels + +```ts +withLabels() +``` + +`google.obj.withLabels` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the labels field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `labels` field. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withMtu + +```ts +withMtu() +``` + +`google.number.withMtu` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the mtu field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `mtu` field. + + +### fn withNetworkId + +```ts +withNetworkId() +``` + +`google.string.withNetworkId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the network_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `network_id` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withZone + +```ts +withZone() +``` + +`google.string.withZone` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the zone field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `zone` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.edgenetwork_network.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/edgenetwork_subnet.md b/docs/4.x/edgenetwork_subnet.md new file mode 100644 index 00000000..9a42aee8 --- /dev/null +++ b/docs/4.x/edgenetwork_subnet.md @@ -0,0 +1,331 @@ +--- +permalink: /edgenetwork_subnet/ +--- + +# edgenetwork_subnet + +`edgenetwork_subnet` represents the `google_edgenetwork_subnet` 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 withIpv4Cidr()`](#fn-withipv4cidr) +* [`fn withIpv6Cidr()`](#fn-withipv6cidr) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withNetwork()`](#fn-withnetwork) +* [`fn withProject()`](#fn-withproject) +* [`fn withSubnetId()`](#fn-withsubnetid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withVlanId()`](#fn-withvlanid) +* [`fn withZone()`](#fn-withzone) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.edgenetwork_subnet.new` injects a new `google_edgenetwork_subnet` 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.edgenetwork_subnet.new('some_id') + +You can get the reference to the `id` field of the created `google.edgenetwork_subnet` using the reference: + + $._ref.google_edgenetwork_subnet.some_id.get('id') + +This is the same as directly entering `"${ google_edgenetwork_subnet.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 free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object. + - `ipv4_cidr` (`list`): The ranges of ipv4 addresses that are owned by this subnetwork, in CIDR format. When `null`, the `ipv4_cidr` field will be omitted from the resulting object. + - `ipv6_cidr` (`list`): The ranges of ipv6 addresses that are owned by this subnetwork, in CIDR format. When `null`, the `ipv6_cidr` field will be omitted from the resulting object. + - `labels` (`obj`): Labels associated with this resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The Google Cloud region to which the target Distributed Cloud Edge zone belongs. + - `network` (`string`): The ID of the network to which this router belongs. +Must be of the form: 'projects/{{project}}/locations/{{location}}/zones/{{zone}}/networks/{{network_id}}' + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `subnet_id` (`string`): A unique ID that identifies this subnet. + - `vlan_id` (`number`): VLAN ID for this subnetwork. If not specified, one is assigned automatically. When `null`, the `vlan_id` field will be omitted from the resulting object. + - `zone` (`string`): The name of the target Distributed Cloud Edge zone. + - `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.edgenetwork_subnet.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.edgenetwork_subnet.newAttrs` constructs a new object with attributes and blocks configured for the `edgenetwork_subnet` +Terraform resource. + +Unlike [google.edgenetwork_subnet.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 free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object. + - `ipv4_cidr` (`list`): The ranges of ipv4 addresses that are owned by this subnetwork, in CIDR format. When `null`, the `ipv4_cidr` field will be omitted from the resulting object. + - `ipv6_cidr` (`list`): The ranges of ipv6 addresses that are owned by this subnetwork, in CIDR format. When `null`, the `ipv6_cidr` field will be omitted from the resulting object. + - `labels` (`obj`): Labels associated with this resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The Google Cloud region to which the target Distributed Cloud Edge zone belongs. + - `network` (`string`): The ID of the network to which this router belongs. +Must be of the form: 'projects/{{project}}/locations/{{location}}/zones/{{zone}}/networks/{{network_id}}' + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `subnet_id` (`string`): A unique ID that identifies this subnet. + - `vlan_id` (`number`): VLAN ID for this subnetwork. If not specified, one is assigned automatically. When `null`, the `vlan_id` field will be omitted from the resulting object. + - `zone` (`string`): The name of the target Distributed Cloud Edge zone. + - `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.edgenetwork_subnet.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 `edgenetwork_subnet` 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 withIpv4Cidr + +```ts +withIpv4Cidr() +``` + +`google.list.withIpv4Cidr` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the ipv4_cidr field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `ipv4_cidr` field. + + +### fn withIpv6Cidr + +```ts +withIpv6Cidr() +``` + +`google.list.withIpv6Cidr` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the ipv6_cidr field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `ipv6_cidr` field. + + +### fn withLabels + +```ts +withLabels() +``` + +`google.obj.withLabels` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the labels field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `labels` field. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withNetwork + +```ts +withNetwork() +``` + +`google.string.withNetwork` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the network field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `network` 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 withSubnetId + +```ts +withSubnetId() +``` + +`google.string.withSubnetId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the subnet_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `subnet_id` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withVlanId + +```ts +withVlanId() +``` + +`google.number.withVlanId` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the vlan_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `vlan_id` field. + + +### fn withZone + +```ts +withZone() +``` + +`google.string.withZone` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the zone field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `zone` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.edgenetwork_subnet.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/filestore_instance.md b/docs/4.x/filestore_instance.md index 01038d98..2eaf1a46 100644 --- a/docs/4.x/filestore_instance.md +++ b/docs/4.x/filestore_instance.md @@ -74,7 +74,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `name` (`string`): The resource name of the instance. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `tier` (`string`): The service tier of the instance. -Possible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD and ENTERPRISE +Possible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD, ZONAL and ENTERPRISE - `zone` (`string`): The name of the Filestore zone of the instance. When `null`, the `zone` field will be omitted from the resulting object. - `file_shares` (`list[obj]`): File system shares on the instance. For this version, only a single file share is supported. When `null`, the `file_shares` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.file_shares.new](#fn-file_sharesnew) constructor. @@ -111,7 +111,7 @@ injecting into a complete block. - `name` (`string`): The resource name of the instance. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `tier` (`string`): The service tier of the instance. -Possible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD and ENTERPRISE +Possible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD, ZONAL and ENTERPRISE - `zone` (`string`): The name of the Filestore zone of the instance. When `null`, the `zone` field will be omitted from the resulting object. - `file_shares` (`list[obj]`): File system shares on the instance. For this version, only a single file share is supported. When `null`, the `file_shares` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.filestore_instance.file_shares.new](#fn-file_sharesnew) constructor. diff --git a/docs/4.x/firestore_database.md b/docs/4.x/firestore_database.md index 4982b531..d3236b3a 100644 --- a/docs/4.x/firestore_database.md +++ b/docs/4.x/firestore_database.md @@ -17,6 +17,7 @@ This package contains functions and utilities for setting up the resource using * [`fn newAttrs()`](#fn-newattrs) * [`fn withAppEngineIntegrationMode()`](#fn-withappengineintegrationmode) * [`fn withConcurrencyMode()`](#fn-withconcurrencymode) +* [`fn withDeleteProtectionState()`](#fn-withdeleteprotectionstate) * [`fn withLocationId()`](#fn-withlocationid) * [`fn withName()`](#fn-withname) * [`fn withPointInTimeRecoveryEnablement()`](#fn-withpointintimerecoveryenablement) @@ -58,7 +59,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object. - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"] When `null`, the `concurrency_mode` field will be omitted from the resulting object. - - `location_id` (`string`): The location of the database. Available databases are listed at + - `delete_protection_state` (`string`): State of delete protection for the database. Possible values: ["DELETE_PROTECTION_STATE_UNSPECIFIED", "DELETE_PROTECTION_ENABLED", "DELETE_PROTECTION_DISABLED"] When `null`, the `delete_protection_state` field will be omitted from the resulting object. + - `location_id` (`string`): The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. - `name` (`string`): The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 @@ -101,7 +103,8 @@ injecting into a complete block. **Args**: - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object. - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"] When `null`, the `concurrency_mode` field will be omitted from the resulting object. - - `location_id` (`string`): The location of the database. Available databases are listed at + - `delete_protection_state` (`string`): State of delete protection for the database. Possible values: ["DELETE_PROTECTION_STATE_UNSPECIFIED", "DELETE_PROTECTION_ENABLED", "DELETE_PROTECTION_DISABLED"] When `null`, the `delete_protection_state` field will be omitted from the resulting object. + - `location_id` (`string`): The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. - `name` (`string`): The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 @@ -156,6 +159,22 @@ Terraform resource block to set or update the concurrency_mode field. - `value` (`string`): The value to set for the `concurrency_mode` field. +### fn withDeleteProtectionState + +```ts +withDeleteProtectionState() +``` + +`google.string.withDeleteProtectionState` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the delete_protection_state field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `delete_protection_state` field. + + ### fn withLocationId ```ts diff --git a/docs/4.x/gke_backup_restore_plan.md b/docs/4.x/gke_backup_restore_plan.md new file mode 100644 index 00000000..80509709 --- /dev/null +++ b/docs/4.x/gke_backup_restore_plan.md @@ -0,0 +1,707 @@ +--- +permalink: /gke_backup_restore_plan/ +--- + +# gke_backup_restore_plan + +`gke_backup_restore_plan` represents the `google_gke_backup_restore_plan` 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 withBackupPlan()`](#fn-withbackupplan) +* [`fn withCluster()`](#fn-withcluster) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withRestoreConfig()`](#fn-withrestoreconfig) +* [`fn withRestoreConfigMixin()`](#fn-withrestoreconfigmixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj restore_config`](#obj-restore_config) + * [`fn new()`](#fn-restore_confignew) + * [`obj restore_config.cluster_resource_restore_scope`](#obj-restore_configcluster_resource_restore_scope) + * [`fn new()`](#fn-restore_configcluster_resource_restore_scopenew) + * [`obj restore_config.cluster_resource_restore_scope.excluded_group_kinds`](#obj-restore_configcluster_resource_restore_scopeexcluded_group_kinds) + * [`fn new()`](#fn-restore_configcluster_resource_restore_scopeexcluded_group_kindsnew) + * [`obj restore_config.cluster_resource_restore_scope.selected_group_kinds`](#obj-restore_configcluster_resource_restore_scopeselected_group_kinds) + * [`fn new()`](#fn-restore_configcluster_resource_restore_scopeselected_group_kindsnew) + * [`obj restore_config.excluded_namespaces`](#obj-restore_configexcluded_namespaces) + * [`fn new()`](#fn-restore_configexcluded_namespacesnew) + * [`obj restore_config.selected_applications`](#obj-restore_configselected_applications) + * [`fn new()`](#fn-restore_configselected_applicationsnew) + * [`obj restore_config.selected_applications.namespaced_names`](#obj-restore_configselected_applicationsnamespaced_names) + * [`fn new()`](#fn-restore_configselected_applicationsnamespaced_namesnew) + * [`obj restore_config.selected_namespaces`](#obj-restore_configselected_namespaces) + * [`fn new()`](#fn-restore_configselected_namespacesnew) + * [`obj restore_config.transformation_rules`](#obj-restore_configtransformation_rules) + * [`fn new()`](#fn-restore_configtransformation_rulesnew) + * [`obj restore_config.transformation_rules.field_actions`](#obj-restore_configtransformation_rulesfield_actions) + * [`fn new()`](#fn-restore_configtransformation_rulesfield_actionsnew) + * [`obj restore_config.transformation_rules.resource_filter`](#obj-restore_configtransformation_rulesresource_filter) + * [`fn new()`](#fn-restore_configtransformation_rulesresource_filternew) + * [`obj restore_config.transformation_rules.resource_filter.group_kinds`](#obj-restore_configtransformation_rulesresource_filtergroup_kinds) + * [`fn new()`](#fn-restore_configtransformation_rulesresource_filtergroup_kindsnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.new` injects a new `google_gke_backup_restore_plan` 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.gke_backup_restore_plan.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_backup_restore_plan` using the reference: + + $._ref.google_gke_backup_restore_plan.some_id.get('id') + +This is the same as directly entering `"${ google_gke_backup_restore_plan.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. + - `backup_plan` (`string`): A reference to the BackupPlan from which Backups may be used +as the source for Restores created via this RestorePlan. + - `cluster` (`string`): The source cluster from which Restores will be created via this RestorePlan. + - `description` (`string`): User specified descriptive string for this RestorePlan. When `null`, the `description` field will be omitted from the resulting object. + - `labels` (`obj`): Description: A set of custom labels supplied by the user. +A list of key->value pairs. +Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The region of the Restore Plan. + - `name` (`string`): The full name of the BackupPlan Resource. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `restore_config` (`list[obj]`): Defines the configuration of Restores created via this RestorePlan. When `null`, the `restore_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.gke_backup_restore_plan.restore_config.new](#fn-restore_confignew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_backup_restore_plan.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan` +Terraform resource. + +Unlike [google.gke_backup_restore_plan.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**: + - `backup_plan` (`string`): A reference to the BackupPlan from which Backups may be used +as the source for Restores created via this RestorePlan. + - `cluster` (`string`): The source cluster from which Restores will be created via this RestorePlan. + - `description` (`string`): User specified descriptive string for this RestorePlan. When `null`, the `description` field will be omitted from the resulting object. + - `labels` (`obj`): Description: A set of custom labels supplied by the user. +A list of key->value pairs. +Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The region of the Restore Plan. + - `name` (`string`): The full name of the BackupPlan Resource. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `restore_config` (`list[obj]`): Defines the configuration of Restores created via this RestorePlan. When `null`, the `restore_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.gke_backup_restore_plan.restore_config.new](#fn-restore_confignew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.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 `gke_backup_restore_plan` resource into the root Terraform configuration. + + +### fn withBackupPlan + +```ts +withBackupPlan() +``` + +`google.string.withBackupPlan` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the backup_plan field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `backup_plan` field. + + +### fn withCluster + +```ts +withCluster() +``` + +`google.string.withCluster` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the cluster field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `cluster` 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 withLabels + +```ts +withLabels() +``` + +`google.obj.withLabels` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the labels field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `labels` field. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withRestoreConfig + +```ts +withRestoreConfig() +``` + +`google.list[obj].withRestoreConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the restore_config 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].withRestoreConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `restore_config` field. + + +### fn withRestoreConfigMixin + +```ts +withRestoreConfigMixin() +``` + +`google.list[obj].withRestoreConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the restore_config 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].withRestoreConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `restore_config` 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 restore_config + + + +### fn restore_config.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.new` constructs a new object with attributes and blocks configured for the `restore_config` +Terraform sub block. + + + +**Args**: + - `all_namespaces` (`bool`): If True, restore all namespaced resources in the Backup. +Setting this field to False will result in an error. When `null`, the `all_namespaces` field will be omitted from the resulting object. + - `cluster_resource_conflict_policy` (`string`): Defines the behavior for handling the situation where cluster-scoped resources +being restored already exist in the target cluster. +This MUST be set to a value other than 'CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED' +if 'clusterResourceRestoreScope' is anyting other than 'noGroupKinds'. +See https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#clusterresourceconflictpolicy +for more information on each policy option. Possible values: ["USE_EXISTING_VERSION", "USE_BACKUP_VERSION"] When `null`, the `cluster_resource_conflict_policy` field will be omitted from the resulting object. + - `namespaced_resource_restore_mode` (`string`): Defines the behavior for handling the situation where sets of namespaced resources +being restored already exist in the target cluster. +This MUST be set to a value other than 'NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED' +if the 'namespacedResourceRestoreScope' is anything other than 'noNamespaces'. +See https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#namespacedresourcerestoremode +for more information on each mode. Possible values: ["DELETE_AND_RESTORE", "FAIL_ON_CONFLICT"] When `null`, the `namespaced_resource_restore_mode` field will be omitted from the resulting object. + - `no_namespaces` (`bool`): Do not restore any namespaced resources if set to "True". +Specifying this field to "False" is not allowed. When `null`, the `no_namespaces` field will be omitted from the resulting object. + - `volume_data_restore_policy` (`string`): Specifies the mechanism to be used to restore volume data. +This should be set to a value other than 'NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED' +if the 'namespacedResourceRestoreScope' is anything other than 'noNamespaces'. +If not specified, it will be treated as 'NO_VOLUME_DATA_RESTORATION'. +See https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#VolumeDataRestorePolicy +for more information on each policy option. Possible values: ["RESTORE_VOLUME_DATA_FROM_BACKUP", "REUSE_VOLUME_HANDLE_FROM_BACKUP", "NO_VOLUME_DATA_RESTORATION"] When `null`, the `volume_data_restore_policy` field will be omitted from the resulting object. + - `cluster_resource_restore_scope` (`list[obj]`): Identifies the cluster-scoped resources to restore from the Backup. When `null`, the `cluster_resource_restore_scope` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.new](#fn-restore_configcluster_resource_restore_scopenew) constructor. + - `excluded_namespaces` (`list[obj]`): A list of selected namespaces excluded from restoration. +All namespaces except those in this list will be restored. When `null`, the `excluded_namespaces` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.excluded_namespaces.new](#fn-restore_configexcluded_namespacesnew) constructor. + - `selected_applications` (`list[obj]`): A list of selected ProtectedApplications to restore. +The listed ProtectedApplications and all the resources +to which they refer will be restored. When `null`, the `selected_applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.selected_applications.new](#fn-restore_configselected_applicationsnew) constructor. + - `selected_namespaces` (`list[obj]`): A list of selected namespaces to restore from the Backup. +The listed Namespaces and all resources contained in them will be restored. When `null`, the `selected_namespaces` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.selected_namespaces.new](#fn-restore_configselected_namespacesnew) constructor. + - `transformation_rules` (`list[obj]`): A list of transformation rules to be applied against Kubernetes +resources as they are selected for restoration from a Backup. +Rules are executed in order defined - this order matters, +as changes made by a rule may impact the filtering logic of subsequent +rules. An empty list means no transformation will occur. When `null`, the `transformation_rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.transformation_rules.new](#fn-restore_configtransformation_rulesnew) constructor. + +**Returns**: + - An attribute object that represents the `restore_config` sub block. + + +## obj restore_config.cluster_resource_restore_scope + + + +### fn restore_config.cluster_resource_restore_scope.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.new` constructs a new object with attributes and blocks configured for the `cluster_resource_restore_scope` +Terraform sub block. + + + +**Args**: + - `all_group_kinds` (`bool`): If True, all valid cluster-scoped resources will be restored. +Mutually exclusive to any other field in 'clusterResourceRestoreScope'. When `null`, the `all_group_kinds` field will be omitted from the resulting object. + - `no_group_kinds` (`bool`): If True, no cluster-scoped resources will be restored. +Mutually exclusive to any other field in 'clusterResourceRestoreScope'. When `null`, the `no_group_kinds` field will be omitted from the resulting object. + - `excluded_group_kinds` (`list[obj]`): A list of cluster-scoped resource group kinds to NOT restore from the backup. +If specified, all valid cluster-scoped resources will be restored except +for those specified in the list. +Mutually exclusive to any other field in 'clusterResourceRestoreScope'. When `null`, the `excluded_group_kinds` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.excluded_group_kinds.new](#fn-restore_configrestore_configexcluded_group_kindsnew) constructor. + - `selected_group_kinds` (`list[obj]`): A list of cluster-scoped resource group kinds to restore from the backup. +If specified, only the selected resources will be restored. +Mutually exclusive to any other field in the 'clusterResourceRestoreScope'. When `null`, the `selected_group_kinds` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.selected_group_kinds.new](#fn-restore_configrestore_configselected_group_kindsnew) constructor. + +**Returns**: + - An attribute object that represents the `cluster_resource_restore_scope` sub block. + + +## obj restore_config.cluster_resource_restore_scope.excluded_group_kinds + + + +### fn restore_config.cluster_resource_restore_scope.excluded_group_kinds.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.excluded_group_kinds.new` constructs a new object with attributes and blocks configured for the `excluded_group_kinds` +Terraform sub block. + + + +**Args**: + - `resource_group` (`string`): API Group string of a Kubernetes resource, e.g. +"apiextensions.k8s.io", "storage.k8s.io", etc. +Use empty string for core group. When `null`, the `resource_group` field will be omitted from the resulting object. + - `resource_kind` (`string`): Kind of a Kubernetes resource, e.g. +"CustomResourceDefinition", "StorageClass", etc. When `null`, the `resource_kind` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `excluded_group_kinds` sub block. + + +## obj restore_config.cluster_resource_restore_scope.selected_group_kinds + + + +### fn restore_config.cluster_resource_restore_scope.selected_group_kinds.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.cluster_resource_restore_scope.selected_group_kinds.new` constructs a new object with attributes and blocks configured for the `selected_group_kinds` +Terraform sub block. + + + +**Args**: + - `resource_group` (`string`): API Group string of a Kubernetes resource, e.g. +"apiextensions.k8s.io", "storage.k8s.io", etc. +Use empty string for core group. When `null`, the `resource_group` field will be omitted from the resulting object. + - `resource_kind` (`string`): Kind of a Kubernetes resource, e.g. +"CustomResourceDefinition", "StorageClass", etc. When `null`, the `resource_kind` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `selected_group_kinds` sub block. + + +## obj restore_config.excluded_namespaces + + + +### fn restore_config.excluded_namespaces.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.excluded_namespaces.new` constructs a new object with attributes and blocks configured for the `excluded_namespaces` +Terraform sub block. + + + +**Args**: + - `namespaces` (`list`): A list of Kubernetes Namespaces. + +**Returns**: + - An attribute object that represents the `excluded_namespaces` sub block. + + +## obj restore_config.selected_applications + + + +### fn restore_config.selected_applications.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.selected_applications.new` constructs a new object with attributes and blocks configured for the `selected_applications` +Terraform sub block. + + + +**Args**: + - `namespaced_names` (`list[obj]`): A list of namespaced Kubernetes resources. When `null`, the `namespaced_names` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.selected_applications.namespaced_names.new](#fn-restore_configrestore_confignamespaced_namesnew) constructor. + +**Returns**: + - An attribute object that represents the `selected_applications` sub block. + + +## obj restore_config.selected_applications.namespaced_names + + + +### fn restore_config.selected_applications.namespaced_names.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.selected_applications.namespaced_names.new` constructs a new object with attributes and blocks configured for the `namespaced_names` +Terraform sub block. + + + +**Args**: + - `name` (`string`): The name of a Kubernetes Resource. + - `namespace` (`string`): The namespace of a Kubernetes Resource. + +**Returns**: + - An attribute object that represents the `namespaced_names` sub block. + + +## obj restore_config.selected_namespaces + + + +### fn restore_config.selected_namespaces.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.selected_namespaces.new` constructs a new object with attributes and blocks configured for the `selected_namespaces` +Terraform sub block. + + + +**Args**: + - `namespaces` (`list`): A list of Kubernetes Namespaces. + +**Returns**: + - An attribute object that represents the `selected_namespaces` sub block. + + +## obj restore_config.transformation_rules + + + +### fn restore_config.transformation_rules.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.transformation_rules.new` constructs a new object with attributes and blocks configured for the `transformation_rules` +Terraform sub block. + + + +**Args**: + - `description` (`string`): The description is a user specified string description +of the transformation rule. When `null`, the `description` field will be omitted from the resulting object. + - `field_actions` (`list[obj]`): A list of transformation rule actions to take against candidate +resources. Actions are executed in order defined - this order +matters, as they could potentially interfere with each other and +the first operation could affect the outcome of the second operation. When `null`, the `field_actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.transformation_rules.field_actions.new](#fn-restore_configrestore_configfield_actionsnew) constructor. + - `resource_filter` (`list[obj]`): This field is used to specify a set of fields that should be used to +determine which resources in backup should be acted upon by the +supplied transformation rule actions, and this will ensure that only +specific resources are affected by transformation rule actions. When `null`, the `resource_filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.transformation_rules.resource_filter.new](#fn-restore_configrestore_configresource_filternew) constructor. + +**Returns**: + - An attribute object that represents the `transformation_rules` sub block. + + +## obj restore_config.transformation_rules.field_actions + + + +### fn restore_config.transformation_rules.field_actions.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.transformation_rules.field_actions.new` constructs a new object with attributes and blocks configured for the `field_actions` +Terraform sub block. + + + +**Args**: + - `from_path` (`string`): A string containing a JSON Pointer value that references the +location in the target document to move the value from. When `null`, the `from_path` field will be omitted from the resulting object. + - `op` (`string`): Specifies the operation to perform. Possible values: ["REMOVE", "MOVE", "COPY", "ADD", "TEST", "REPLACE"] + - `path` (`string`): A string containing a JSON-Pointer value that references a +location within the target document where the operation is performed. When `null`, the `path` field will be omitted from the resulting object. + - `value` (`string`): A string that specifies the desired value in string format +to use for transformation. When `null`, the `value` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `field_actions` sub block. + + +## obj restore_config.transformation_rules.resource_filter + + + +### fn restore_config.transformation_rules.resource_filter.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.transformation_rules.resource_filter.new` constructs a new object with attributes and blocks configured for the `resource_filter` +Terraform sub block. + + + +**Args**: + - `json_path` (`string`): This is a JSONPath expression that matches specific fields of +candidate resources and it operates as a filtering parameter +(resources that are not matched with this expression will not +be candidates for transformation). When `null`, the `json_path` field will be omitted from the resulting object. + - `namespaces` (`list`): (Filtering parameter) Any resource subject to transformation must +be contained within one of the listed Kubernetes Namespace in the +Backup. If this field is not provided, no namespace filtering will +be performed (all resources in all Namespaces, including all +cluster-scoped resources, will be candidates for transformation). +To mix cluster-scoped and namespaced resources in the same rule, +use an empty string ("") as one of the target namespaces. When `null`, the `namespaces` field will be omitted from the resulting object. + - `group_kinds` (`list[obj]`): (Filtering parameter) Any resource subject to transformation must +belong to one of the listed "types". If this field is not provided, +no type filtering will be performed +(all resources of all types matching previous filtering parameters +will be candidates for transformation). When `null`, the `group_kinds` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_backup_restore_plan.restore_config.transformation_rules.resource_filter.group_kinds.new](#fn-restore_configrestore_configtransformation_rulesgroup_kindsnew) constructor. + +**Returns**: + - An attribute object that represents the `resource_filter` sub block. + + +## obj restore_config.transformation_rules.resource_filter.group_kinds + + + +### fn restore_config.transformation_rules.resource_filter.group_kinds.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.restore_config.transformation_rules.resource_filter.group_kinds.new` constructs a new object with attributes and blocks configured for the `group_kinds` +Terraform sub block. + + + +**Args**: + - `resource_group` (`string`): API Group string of a Kubernetes resource, e.g. +"apiextensions.k8s.io", "storage.k8s.io", etc. +Use empty string for core group. When `null`, the `resource_group` field will be omitted from the resulting object. + - `resource_kind` (`string`): Kind of a Kubernetes resource, e.g. +"CustomResourceDefinition", "StorageClass", etc. When `null`, the `resource_kind` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `group_kinds` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.gke_backup_restore_plan.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/gke_backup_restore_plan_iam_binding.md b/docs/4.x/gke_backup_restore_plan_iam_binding.md new file mode 100644 index 00000000..bf0e436b --- /dev/null +++ b/docs/4.x/gke_backup_restore_plan_iam_binding.md @@ -0,0 +1,236 @@ +--- +permalink: /gke_backup_restore_plan_iam_binding/ +--- + +# gke_backup_restore_plan_iam_binding + +`gke_backup_restore_plan_iam_binding` represents the `google_gke_backup_restore_plan_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 withLocation()`](#fn-withlocation) +* [`fn withMembers()`](#fn-withmembers) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_backup_restore_plan_iam_binding.new` injects a new `google_gke_backup_restore_plan_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.gke_backup_restore_plan_iam_binding.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_backup_restore_plan_iam_binding` using the reference: + + $._ref.google_gke_backup_restore_plan_iam_binding.some_id.get('id') + +This is the same as directly entering `"${ google_gke_backup_restore_plan_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. + - `location` (`string`): Set the `location` field on the resulting resource block. When `null`, the `location` field will be omitted from the resulting object. + - `members` (`list`): Set the `members` field on the resulting resource block. + - `name` (`string`): Set the `name` 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. + - `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.gke_backup_restore_plan_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.gke_backup_restore_plan_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan_iam_binding` +Terraform resource. + +Unlike [google.gke_backup_restore_plan_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**: + - `location` (`string`): Set the `location` field on the resulting object. When `null`, the `location` field will be omitted from the resulting object. + - `members` (`list`): Set the `members` field on the resulting object. + - `name` (`string`): Set the `name` 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. + - `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.gke_backup_restore_plan_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 `gke_backup_restore_plan_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 withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` 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 withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn 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.gke_backup_restore_plan_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/gke_backup_restore_plan_iam_member.md b/docs/4.x/gke_backup_restore_plan_iam_member.md new file mode 100644 index 00000000..5889591c --- /dev/null +++ b/docs/4.x/gke_backup_restore_plan_iam_member.md @@ -0,0 +1,236 @@ +--- +permalink: /gke_backup_restore_plan_iam_member/ +--- + +# gke_backup_restore_plan_iam_member + +`gke_backup_restore_plan_iam_member` represents the `google_gke_backup_restore_plan_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 withLocation()`](#fn-withlocation) +* [`fn withMember()`](#fn-withmember) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_backup_restore_plan_iam_member.new` injects a new `google_gke_backup_restore_plan_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.gke_backup_restore_plan_iam_member.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_backup_restore_plan_iam_member` using the reference: + + $._ref.google_gke_backup_restore_plan_iam_member.some_id.get('id') + +This is the same as directly entering `"${ google_gke_backup_restore_plan_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. + - `location` (`string`): Set the `location` field on the resulting resource block. When `null`, the `location` field will be omitted from the resulting object. + - `member` (`string`): Set the `member` field on the resulting resource block. + - `name` (`string`): Set the `name` 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. + - `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.gke_backup_restore_plan_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.gke_backup_restore_plan_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan_iam_member` +Terraform resource. + +Unlike [google.gke_backup_restore_plan_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**: + - `location` (`string`): Set the `location` field on the resulting object. When `null`, the `location` field will be omitted from the resulting object. + - `member` (`string`): Set the `member` field on the resulting object. + - `name` (`string`): Set the `name` 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. + - `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.gke_backup_restore_plan_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 `gke_backup_restore_plan_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 withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` 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 withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn 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.gke_backup_restore_plan_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/gke_backup_restore_plan_iam_policy.md b/docs/4.x/gke_backup_restore_plan_iam_policy.md new file mode 100644 index 00000000..a22bd934 --- /dev/null +++ b/docs/4.x/gke_backup_restore_plan_iam_policy.md @@ -0,0 +1,149 @@ +--- +permalink: /gke_backup_restore_plan_iam_policy/ +--- + +# gke_backup_restore_plan_iam_policy + +`gke_backup_restore_plan_iam_policy` represents the `google_gke_backup_restore_plan_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 withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withPolicyData()`](#fn-withpolicydata) +* [`fn withProject()`](#fn-withproject) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_backup_restore_plan_iam_policy.new` injects a new `google_gke_backup_restore_plan_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.gke_backup_restore_plan_iam_policy.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_backup_restore_plan_iam_policy` using the reference: + + $._ref.google_gke_backup_restore_plan_iam_policy.some_id.get('id') + +This is the same as directly entering `"${ google_gke_backup_restore_plan_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. + - `location` (`string`): Set the `location` field on the resulting resource block. When `null`, the `location` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting resource 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. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_backup_restore_plan_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `gke_backup_restore_plan_iam_policy` +Terraform resource. + +Unlike [google.gke_backup_restore_plan_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**: + - `location` (`string`): Set the `location` field on the resulting object. When `null`, the `location` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting object. + - `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. + +**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 `gke_backup_restore_plan_iam_policy` resource into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn 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. diff --git a/docs/4.x/identity_platform_config.md b/docs/4.x/identity_platform_config.md index 7de31b24..3d15dacd 100644 --- a/docs/4.x/identity_platform_config.md +++ b/docs/4.x/identity_platform_config.md @@ -22,6 +22,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withProject()`](#fn-withproject) * [`fn withQuota()`](#fn-withquota) * [`fn withQuotaMixin()`](#fn-withquotamixin) +* [`fn withSignIn()`](#fn-withsignin) +* [`fn withSignInMixin()`](#fn-withsigninmixin) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj blocking_functions`](#obj-blocking_functions) @@ -34,6 +36,14 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-quotanew) * [`obj quota.sign_up_quota_config`](#obj-quotasign_up_quota_config) * [`fn new()`](#fn-quotasign_up_quota_confignew) +* [`obj sign_in`](#obj-sign_in) + * [`fn new()`](#fn-sign_innew) + * [`obj sign_in.anonymous`](#obj-sign_inanonymous) + * [`fn new()`](#fn-sign_inanonymousnew) + * [`obj sign_in.email`](#obj-sign_inemail) + * [`fn new()`](#fn-sign_inemailnew) + * [`obj sign_in.phone_number`](#obj-sign_inphone_number) + * [`fn new()`](#fn-sign_inphone_numbernew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -71,6 +81,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `blocking_functions` (`list[obj]`): Configuration related to blocking functions. When `null`, the `blocking_functions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.blocking_functions.new](#fn-blocking_functionsnew) constructor. - `quota` (`list[obj]`): Configuration related to quotas. When `null`, the `quota` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.quota.new](#fn-quotanew) constructor. + - `sign_in` (`list[obj]`): Configuration related to local sign in methods. When `null`, the `sign_in` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.new](#fn-sign_innew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -100,6 +111,7 @@ injecting into a complete block. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `blocking_functions` (`list[obj]`): Configuration related to blocking functions. When `null`, the `blocking_functions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.blocking_functions.new](#fn-blocking_functionsnew) constructor. - `quota` (`list[obj]`): Configuration related to quotas. When `null`, the `quota` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.quota.new](#fn-quotanew) constructor. + - `sign_in` (`list[obj]`): Configuration related to local sign in methods. When `null`, the `sign_in` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.new](#fn-sign_innew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -228,6 +240,43 @@ function. - `value` (`list[obj]`): The value to set for the `quota` field. +### fn withSignIn + +```ts +withSignIn() +``` + +`google.list[obj].withSignIn` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the sign_in 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].withSignInMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `sign_in` field. + + +### fn withSignInMixin + +```ts +withSignInMixin() +``` + +`google.list[obj].withSignInMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the sign_in 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].withSignIn](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `sign_in` field. + + ### fn withTimeouts ```ts @@ -385,6 +434,105 @@ Terraform sub block. - An attribute object that represents the `sign_up_quota_config` sub block. +## obj sign_in + + + +### fn sign_in.new + +```ts +new() +``` + + +`google.identity_platform_config.sign_in.new` constructs a new object with attributes and blocks configured for the `sign_in` +Terraform sub block. + + + +**Args**: + - `allow_duplicate_emails` (`bool`): Whether to allow more than one account to have the same email. When `null`, the `allow_duplicate_emails` field will be omitted from the resulting object. + - `anonymous` (`list[obj]`): Configuration options related to authenticating an anonymous user. When `null`, the `anonymous` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.anonymous.new](#fn-sign_inanonymousnew) constructor. + - `email` (`list[obj]`): Configuration options related to authenticating a user by their email address. When `null`, the `email` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.email.new](#fn-sign_inemailnew) constructor. + - `phone_number` (`list[obj]`): Configuration options related to authenticated a user by their phone number. When `null`, the `phone_number` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.identity_platform_config.sign_in.phone_number.new](#fn-sign_inphone_numbernew) constructor. + +**Returns**: + - An attribute object that represents the `sign_in` sub block. + + +## obj sign_in.anonymous + + + +### fn sign_in.anonymous.new + +```ts +new() +``` + + +`google.identity_platform_config.sign_in.anonymous.new` constructs a new object with attributes and blocks configured for the `anonymous` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether anonymous user auth is enabled for the project or not. + +**Returns**: + - An attribute object that represents the `anonymous` sub block. + + +## obj sign_in.email + + + +### fn sign_in.email.new + +```ts +new() +``` + + +`google.identity_platform_config.sign_in.email.new` constructs a new object with attributes and blocks configured for the `email` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether email auth is enabled for the project or not. + - `password_required` (`bool`): Whether a password is required for email auth or not. If true, both an email and +password must be provided to sign in. If false, a user may sign in via either +email/password or email link. When `null`, the `password_required` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `email` sub block. + + +## obj sign_in.phone_number + + + +### fn sign_in.phone_number.new + +```ts +new() +``` + + +`google.identity_platform_config.sign_in.phone_number.new` constructs a new object with attributes and blocks configured for the `phone_number` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether phone number auth is enabled for the project or not. + - `test_phone_numbers` (`obj`): A map of <test phone number, fake code> that can be used for phone auth testing. When `null`, the `test_phone_numbers` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `phone_number` sub block. + + ## obj timeouts diff --git a/docs/4.x/network_connectivity_spoke.md b/docs/4.x/network_connectivity_spoke.md index f1324bab..d8cc8fdb 100644 --- a/docs/4.x/network_connectivity_spoke.md +++ b/docs/4.x/network_connectivity_spoke.md @@ -22,6 +22,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withLinkedInterconnectAttachmentsMixin()`](#fn-withlinkedinterconnectattachmentsmixin) * [`fn withLinkedRouterApplianceInstances()`](#fn-withlinkedrouterapplianceinstances) * [`fn withLinkedRouterApplianceInstancesMixin()`](#fn-withlinkedrouterapplianceinstancesmixin) +* [`fn withLinkedVpcNetwork()`](#fn-withlinkedvpcnetwork) +* [`fn withLinkedVpcNetworkMixin()`](#fn-withlinkedvpcnetworkmixin) * [`fn withLinkedVpnTunnels()`](#fn-withlinkedvpntunnels) * [`fn withLinkedVpnTunnelsMixin()`](#fn-withlinkedvpntunnelsmixin) * [`fn withLocation()`](#fn-withlocation) @@ -35,6 +37,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-linked_router_appliance_instancesnew) * [`obj linked_router_appliance_instances.instances`](#obj-linked_router_appliance_instancesinstances) * [`fn new()`](#fn-linked_router_appliance_instancesinstancesnew) +* [`obj linked_vpc_network`](#obj-linked_vpc_network) + * [`fn new()`](#fn-linked_vpc_networknew) * [`obj linked_vpn_tunnels`](#obj-linked_vpn_tunnels) * [`fn new()`](#fn-linked_vpn_tunnelsnew) * [`obj timeouts`](#obj-timeouts) @@ -77,6 +81,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object. - `linked_interconnect_attachments` (`list[obj]`): A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. When `null`, the `linked_interconnect_attachments` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_interconnect_attachments.new](#fn-linked_interconnect_attachmentsnew) constructor. - `linked_router_appliance_instances` (`list[obj]`): The URIs of linked Router appliance resources When `null`, the `linked_router_appliance_instances` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_router_appliance_instances.new](#fn-linked_router_appliance_instancesnew) constructor. + - `linked_vpc_network` (`list[obj]`): VPC network that is associated with the spoke. When `null`, the `linked_vpc_network` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpc_network.new](#fn-linked_vpc_networknew) constructor. - `linked_vpn_tunnels` (`list[obj]`): The URIs of linked VPN tunnel resources When `null`, the `linked_vpn_tunnels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpn_tunnels.new](#fn-linked_vpn_tunnelsnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.timeouts.new](#fn-timeoutsnew) constructor. @@ -110,6 +115,7 @@ injecting into a complete block. - `project` (`string`): The project for the resource When `null`, the `project` field will be omitted from the resulting object. - `linked_interconnect_attachments` (`list[obj]`): A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. When `null`, the `linked_interconnect_attachments` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_interconnect_attachments.new](#fn-linked_interconnect_attachmentsnew) constructor. - `linked_router_appliance_instances` (`list[obj]`): The URIs of linked Router appliance resources When `null`, the `linked_router_appliance_instances` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_router_appliance_instances.new](#fn-linked_router_appliance_instancesnew) constructor. + - `linked_vpc_network` (`list[obj]`): VPC network that is associated with the spoke. When `null`, the `linked_vpc_network` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpc_network.new](#fn-linked_vpc_networknew) constructor. - `linked_vpn_tunnels` (`list[obj]`): The URIs of linked VPN tunnel resources When `null`, the `linked_vpn_tunnels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.linked_vpn_tunnels.new](#fn-linked_vpn_tunnelsnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.network_connectivity_spoke.timeouts.new](#fn-timeoutsnew) constructor. @@ -239,6 +245,43 @@ function. - `value` (`list[obj]`): The value to set for the `linked_router_appliance_instances` field. +### fn withLinkedVpcNetwork + +```ts +withLinkedVpcNetwork() +``` + +`google.list[obj].withLinkedVpcNetwork` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the linked_vpc_network 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].withLinkedVpcNetworkMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `linked_vpc_network` field. + + +### fn withLinkedVpcNetworkMixin + +```ts +withLinkedVpcNetworkMixin() +``` + +`google.list[obj].withLinkedVpcNetworkMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the linked_vpc_network 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].withLinkedVpcNetwork](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `linked_vpc_network` field. + + ### fn withLinkedVpnTunnels ```ts @@ -432,6 +475,30 @@ Terraform sub block. - An attribute object that represents the `instances` sub block. +## obj linked_vpc_network + + + +### fn linked_vpc_network.new + +```ts +new() +``` + + +`google.network_connectivity_spoke.linked_vpc_network.new` constructs a new object with attributes and blocks configured for the `linked_vpc_network` +Terraform sub block. + + + +**Args**: + - `exclude_export_ranges` (`list`): IP ranges encompassing the subnets to be excluded from peering. When `null`, the `exclude_export_ranges` field will be omitted from the resulting object. + - `uri` (`string`): The URI of the VPC network resource. + +**Returns**: + - An attribute object that represents the `linked_vpc_network` sub block. + + ## obj linked_vpn_tunnels diff --git a/docs/4.x/provider.md b/docs/4.x/provider.md index 3e87d78d..0b9c0649 100644 --- a/docs/4.x/provider.md +++ b/docs/4.x/provider.md @@ -100,6 +100,7 @@ the `src` and/or `version` parameters are set. - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting provider block. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object. - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object. - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object. + - `edgenetwork_custom_endpoint` (`string`): Set the `edgenetwork_custom_endpoint` field on the resulting provider block. When `null`, the `edgenetwork_custom_endpoint` field will be omitted from the resulting object. - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting provider block. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object. - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting provider block. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object. - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting provider block. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object. @@ -263,6 +264,7 @@ injecting into a complete block. - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting object. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object. - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting object. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object. - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting object. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object. + - `edgenetwork_custom_endpoint` (`string`): Set the `edgenetwork_custom_endpoint` field on the resulting object. When `null`, the `edgenetwork_custom_endpoint` field will be omitted from the resulting object. - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting object. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object. - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting object. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object. - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting object. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object. diff --git a/docs/4.x/scc_project_custom_module.md b/docs/4.x/scc_project_custom_module.md new file mode 100644 index 00000000..6d67b4e7 --- /dev/null +++ b/docs/4.x/scc_project_custom_module.md @@ -0,0 +1,421 @@ +--- +permalink: /scc_project_custom_module/ +--- + +# scc_project_custom_module + +`scc_project_custom_module` represents the `google_scc_project_custom_module` 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 withCustomConfig()`](#fn-withcustomconfig) +* [`fn withCustomConfigMixin()`](#fn-withcustomconfigmixin) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withEnablementState()`](#fn-withenablementstate) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj custom_config`](#obj-custom_config) + * [`fn new()`](#fn-custom_confignew) + * [`obj custom_config.custom_output`](#obj-custom_configcustom_output) + * [`fn new()`](#fn-custom_configcustom_outputnew) + * [`obj custom_config.custom_output.properties`](#obj-custom_configcustom_outputproperties) + * [`fn new()`](#fn-custom_configcustom_outputpropertiesnew) + * [`obj custom_config.custom_output.properties.value_expression`](#obj-custom_configcustom_outputpropertiesvalue_expression) + * [`fn new()`](#fn-custom_configcustom_outputpropertiesvalue_expressionnew) + * [`obj custom_config.predicate`](#obj-custom_configpredicate) + * [`fn new()`](#fn-custom_configpredicatenew) + * [`obj custom_config.resource_selector`](#obj-custom_configresource_selector) + * [`fn new()`](#fn-custom_configresource_selectornew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.scc_project_custom_module.new` injects a new `google_scc_project_custom_module` 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_project_custom_module.new('some_id') + +You can get the reference to the `id` field of the created `google.scc_project_custom_module` using the reference: + + $._ref.google_scc_project_custom_module.some_id.get('id') + +This is the same as directly entering `"${ google_scc_project_custom_module.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. + - `display_name` (`string`): The display name of the Security Health Analytics custom module. This +display name becomes the finding category for all findings that are +returned by this custom module. The display name must be between 1 and +128 characters, start with a lowercase letter, and contain alphanumeric +characters or underscores only. + - `enablement_state` (`string`): The enablement state of the custom module. Possible values: ["ENABLED", "DISABLED"] + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `custom_config` (`list[obj]`): The user specified custom configuration for the module. When `null`, the `custom_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.scc_project_custom_module.custom_config.new](#fn-custom_confignew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.scc_project_custom_module.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_project_custom_module.newAttrs` constructs a new object with attributes and blocks configured for the `scc_project_custom_module` +Terraform resource. + +Unlike [google.scc_project_custom_module.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**: + - `display_name` (`string`): The display name of the Security Health Analytics custom module. This +display name becomes the finding category for all findings that are +returned by this custom module. The display name must be between 1 and +128 characters, start with a lowercase letter, and contain alphanumeric +characters or underscores only. + - `enablement_state` (`string`): The enablement state of the custom module. Possible values: ["ENABLED", "DISABLED"] + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `custom_config` (`list[obj]`): The user specified custom configuration for the module. When `null`, the `custom_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.scc_project_custom_module.custom_config.new](#fn-custom_confignew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.scc_project_custom_module.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_project_custom_module` resource into the root Terraform configuration. + + +### fn withCustomConfig + +```ts +withCustomConfig() +``` + +`google.list[obj].withCustomConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the custom_config 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].withCustomConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `custom_config` field. + + +### fn withCustomConfigMixin + +```ts +withCustomConfigMixin() +``` + +`google.list[obj].withCustomConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the custom_config 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].withCustomConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `custom_config` 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 withEnablementState + +```ts +withEnablementState() +``` + +`google.string.withEnablementState` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the enablement_state field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `enablement_state` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj custom_config + + + +### fn custom_config.new + +```ts +new() +``` + + +`google.scc_project_custom_module.custom_config.new` constructs a new object with attributes and blocks configured for the `custom_config` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Text that describes the vulnerability or misconfiguration that the custom +module detects. This explanation is returned with each finding instance to +help investigators understand the detected issue. The text must be enclosed in quotation marks. When `null`, the `description` field will be omitted from the resulting object. + - `recommendation` (`string`): An explanation of the recommended steps that security teams can take to resolve +the detected issue. This explanation is returned with each finding generated by +this module in the nextSteps property of the finding JSON. + - `severity` (`string`): The severity to assign to findings generated by the module. Possible values: ["CRITICAL", "HIGH", "MEDIUM", "LOW"] + - `custom_output` (`list[obj]`): Custom output properties. When `null`, the `custom_output` 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_project_custom_module.custom_config.custom_output.new](#fn-custom_configcustom_outputnew) constructor. + - `predicate` (`list[obj]`): The CEL expression to evaluate to produce findings. When the expression evaluates +to true against a resource, a finding is generated. When `null`, the `predicate` 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_project_custom_module.custom_config.predicate.new](#fn-custom_configpredicatenew) constructor. + - `resource_selector` (`list[obj]`): The resource types that the custom module operates on. Each custom module +can specify up to 5 resource types. When `null`, the `resource_selector` 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_project_custom_module.custom_config.resource_selector.new](#fn-custom_configresource_selectornew) constructor. + +**Returns**: + - An attribute object that represents the `custom_config` sub block. + + +## obj custom_config.custom_output + + + +### fn custom_config.custom_output.new + +```ts +new() +``` + + +`google.scc_project_custom_module.custom_config.custom_output.new` constructs a new object with attributes and blocks configured for the `custom_output` +Terraform sub block. + + + +**Args**: + - `properties` (`list[obj]`): A list of custom output properties to add to the finding. When `null`, the `properties` 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_project_custom_module.custom_config.custom_output.properties.new](#fn-custom_configcustom_configpropertiesnew) constructor. + +**Returns**: + - An attribute object that represents the `custom_output` sub block. + + +## obj custom_config.custom_output.properties + + + +### fn custom_config.custom_output.properties.new + +```ts +new() +``` + + +`google.scc_project_custom_module.custom_config.custom_output.properties.new` constructs a new object with attributes and blocks configured for the `properties` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name of the property for the custom output. When `null`, the `name` field will be omitted from the resulting object. + - `value_expression` (`list[obj]`): The CEL expression for the custom output. A resource property can be specified +to return the value of the property or a text string enclosed in quotation marks. When `null`, the `value_expression` 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_project_custom_module.custom_config.custom_output.properties.value_expression.new](#fn-custom_configcustom_configcustom_outputvalue_expressionnew) constructor. + +**Returns**: + - An attribute object that represents the `properties` sub block. + + +## obj custom_config.custom_output.properties.value_expression + + + +### fn custom_config.custom_output.properties.value_expression.new + +```ts +new() +``` + + +`google.scc_project_custom_module.custom_config.custom_output.properties.value_expression.new` constructs a new object with attributes and blocks configured for the `value_expression` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Description of the expression. This is a longer text which describes the +expression, e.g. when hovered over it in a UI. When `null`, the `description` field will be omitted from the resulting object. + - `expression` (`string`): Textual representation of an expression in Common Expression Language syntax. + - `location` (`string`): String indicating the location of the expression for error reporting, e.g. a +file name and a position in the file. When `null`, the `location` field will be omitted from the resulting object. + - `title` (`string`): Title for the expression, i.e. a short string describing its purpose. This can +be used e.g. in UIs which allow to enter the expression. When `null`, the `title` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `value_expression` sub block. + + +## obj custom_config.predicate + + + +### fn custom_config.predicate.new + +```ts +new() +``` + + +`google.scc_project_custom_module.custom_config.predicate.new` constructs a new object with attributes and blocks configured for the `predicate` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Description of the expression. This is a longer text which describes the +expression, e.g. when hovered over it in a UI. When `null`, the `description` field will be omitted from the resulting object. + - `expression` (`string`): Textual representation of an expression in Common Expression Language syntax. + - `location` (`string`): String indicating the location of the expression for error reporting, e.g. a +file name and a position in the file. When `null`, the `location` field will be omitted from the resulting object. + - `title` (`string`): Title for the expression, i.e. a short string describing its purpose. This can +be used e.g. in UIs which allow to enter the expression. When `null`, the `title` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `predicate` sub block. + + +## obj custom_config.resource_selector + + + +### fn custom_config.resource_selector.new + +```ts +new() +``` + + +`google.scc_project_custom_module.custom_config.resource_selector.new` constructs a new object with attributes and blocks configured for the `resource_selector` +Terraform sub block. + + + +**Args**: + - `resource_types` (`list`): The resource types to run the detector on. + +**Returns**: + - An attribute object that represents the `resource_selector` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.scc_project_custom_module.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/secret_manager_secret_version.md b/docs/4.x/secret_manager_secret_version.md index 88a12dc8..6f9f6b8f 100644 --- a/docs/4.x/secret_manager_secret_version.md +++ b/docs/4.x/secret_manager_secret_version.md @@ -17,6 +17,7 @@ This package contains functions and utilities for setting up the resource using * [`fn newAttrs()`](#fn-newattrs) * [`fn withDeletionPolicy()`](#fn-withdeletionpolicy) * [`fn withEnabled()`](#fn-withenabled) +* [`fn withIsSecretDataBase64()`](#fn-withissecretdatabase64) * [`fn withSecret()`](#fn-withsecret) * [`fn withSecretData()`](#fn-withsecretdata) * [`fn withTimeouts()`](#fn-withtimeouts) @@ -60,6 +61,7 @@ disabled rather than deleted. Default is 'DELETE'. Possible values are: * DISABLE * ABANDON When `null`, the `deletion_policy` field will be omitted from the resulting object. - `enabled` (`bool`): The current state of the SecretVersion. When `null`, the `enabled` field will be omitted from the resulting object. + - `is_secret_data_base64` (`bool`): If set to 'true', the secret data is expected to be base64-encoded string and would be sent as is. When `null`, the `is_secret_data_base64` field will be omitted from the resulting object. - `secret` (`string`): Secret Manager secret resource - `secret_data` (`string`): The secret data. Must be no larger than 64KiB. - `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.secret_manager_secret_version.timeouts.new](#fn-timeoutsnew) constructor. @@ -93,6 +95,7 @@ disabled rather than deleted. Default is 'DELETE'. Possible values are: * DISABLE * ABANDON When `null`, the `deletion_policy` field will be omitted from the resulting object. - `enabled` (`bool`): The current state of the SecretVersion. When `null`, the `enabled` field will be omitted from the resulting object. + - `is_secret_data_base64` (`bool`): If set to 'true', the secret data is expected to be base64-encoded string and would be sent as is. When `null`, the `is_secret_data_base64` field will be omitted from the resulting object. - `secret` (`string`): Secret Manager secret resource - `secret_data` (`string`): The secret data. Must be no larger than 64KiB. - `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.secret_manager_secret_version.timeouts.new](#fn-timeoutsnew) constructor. @@ -133,6 +136,22 @@ Terraform resource block to set or update the enabled field. - `value` (`bool`): The value to set for the `enabled` field. +### fn withIsSecretDataBase64 + +```ts +withIsSecretDataBase64() +``` + +`google.bool.withIsSecretDataBase64` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the is_secret_data_base64 field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `is_secret_data_base64` field. + + ### fn withSecret ```ts